javax.imageio.metadata
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
Constructor and Description |
---|
IIOMetadataNode() |
IIOMetadataNode(String nodename) |
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
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()
A
NamedNodeMap containing the attributes of this node (if
it is an Element ) or null otherwise. |
String |
getBaseURI()
The absolute base URI of this node or
null if the
implementation wasn't able to obtain an absolute URI. |
NodeList |
getChildNodes()
A
NodeList that contains all children of this node. |
NodeList |
getElementsByTagName(String name)
Returns a
NodeList of all descendant Elements
with a given tag name, in document order. |
NodeList |
getElementsByTagNameNS(String namespaceURI,
String localName)
Returns a
NodeList of all the descendant
Elements with a given local name and namespace URI in
document order. |
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.
|
int |
getLength()
The number of nodes in the list.
|
String |
getLocalName()
Returns the local part of the qualified name of this node.
|
String |
getNamespaceURI()
The namespace URI of this node, or
null 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()
The
Document object associated with this node. |
Node |
getParentNode()
The parent of this node.
|
String |
getPrefix()
The namespace prefix of this node, or
null if it is
unspecified. |
Node |
getPreviousSibling()
The node immediately preceding this node.
|
TypeInfo |
getSchemaTypeInfo()
The type information associated with this element.
|
String |
getTagName()
The name of the element.
|
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.
|
Object |
getUserObject() |
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. |
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 node
newChild before the existing child node
refChild . |
boolean |
isDefaultNamespace(String namespaceURI)
This method checks if the specified
namespaceURI 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 .
|
Node |
item(int index)
Returns the
index th item in the collection. |
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 |
removeAttribute(String name)
Removes an attribute by name.
|
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)
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 |
setAttribute(String name,
String value)
Adds a new attribute.
|
Attr |
setAttributeNode(Attr newAttr)
Adds a new attribute node.
|
Attr |
setAttributeNodeNS(Attr newAttr)
Adds a new attribute.
|
void |
setAttributeNS(String namespaceURI,
String qualifiedName,
String value)
Adds a new attribute.
|
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)
The value of this node, depending on its type; see the table above.
|
void |
setPrefix(String prefix)
The namespace prefix of this node, or
null 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.
|
void |
setUserObject(Object o) |
public IIOMetadataNode()
public IIOMetadataNode(String nodename)
public Object getUserObject()
public void setUserObject(Object o)
public short compareDocumentPosition(Node other) throws DOMException
Node
compareDocumentPosition
in interface Node
other
- The node to compare against the reference node.DOMException
- NOT_SUPPORTED_ERR: when the compared nodes are from different DOM
implementations that do not coordinate to return consistent
implementation-specific results.public String getAttribute(String name)
Element
getAttribute
in interface Element
name
- The name of the attribute to retrieve.Attr
value as a string, or the empty string
if that attribute does not have a specified or default value.public Attr getAttributeNode(String name)
Element
getAttributeNodeNS
method.getAttributeNode
in interface Element
name
- The name (nodeName
) of the attribute to
retrieve.Attr
node with the specified name (
nodeName
) or null
if there is no such
attribute.public Attr getAttributeNodeNS(String namespaceURI, String localName)
Element
Attr
node by local name and namespace URI.
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.getAttributeNodeNS
in interface Element
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.Attr
node with the specified attribute local
name and namespace URI or null
if there is no such
attribute.public String getAttributeNS(String namespaceURI, String localName)
Element
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.getAttributeNS
in interface Element
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.Attr
value as a string, or the empty string
if that attribute does not have a specified or default value.public String getBaseURI()
Node
null
if the
implementation wasn't able to obtain an absolute URI. This value is
computed as described in . However, when the Document
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 the
documentURI
attribute from the Document
interface otherwise.getBaseURI
in interface Node
public NodeList getElementsByTagName(String name)
Element
NodeList
of all descendant Elements
with a given tag name, in document order.getElementsByTagName
in interface Element
name
- The name of the tag to match on. The special value "*"
matches all tags.Element
nodes.public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
Element
NodeList
of all the descendant
Elements
with a given local name and namespace URI in
document order.getElementsByTagNameNS
in interface Element
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.NodeList
object containing all the matched
Elements
.public String getTagName()
Element
Node.localName
is different
from null
, this attribute is a qualified name. For
example, in:
<elementExample id="demo"> ... </elementExample> ,
tagName
has the value
"elementExample"
. Note that this is case-preserving in
XML, as are all of the operations of the DOM. The HTML DOM returns
the tagName
of an HTML element in the canonical
uppercase form, regardless of the case in the source HTML document.getTagName
in interface Element
public boolean hasAttribute(String name)
Element
true
when an attribute with a given name is
specified on this element or has a default value, false
otherwise.hasAttribute
in interface Element
name
- The name of the attribute to look for.true
if an attribute with the given name is
specified on this element or has a default value, false
otherwise.public boolean hasAttributeNS(String namespaceURI, String localName)
Element
true
when an attribute with a given local name and
namespace URI is specified on this element or has a default value,
false
otherwise.
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.hasAttributeNS
in interface Element
namespaceURI
- The namespace URI of the attribute to look for.localName
- The local name of the attribute to look for.true
if an attribute with the given local name
and namespace URI is specified or has a default value on this
element, false
otherwise.public void removeAttribute(String name)
Element
Document.normalizeDocument()
to guarantee this
information is up-to-date.
removeAttributeNS
method.removeAttribute
in interface Element
name
- The name of the attribute to remove.public Attr removeAttributeNode(Attr oldAttr)
Element
Attr
node is defined in the DTD, a new node
immediately appears with the default value as well as the
corresponding namespace URI, local name, and prefix when applicable.
The implementation may handle default values from other schemas
similarly but applications should use
Document.normalizeDocument()
to guarantee this
information is up-to-date.removeAttributeNode
in interface Element
oldAttr
- The Attr
node to remove from the attribute
list.Attr
node that was removed.public void removeAttributeNS(String namespaceURI, String localName)
Element
Document.normalizeDocument()
to guarantee this
information is up-to-date.
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.removeAttributeNS
in interface Element
namespaceURI
- The namespace URI of the attribute to remove.localName
- The local name of the attribute to remove.public void setAttribute(String name, String value)
Element
Attr
node plus any
Text
and EntityReference
nodes, build the
appropriate subtree, and use setAttributeNode
to assign
it as the value of an attribute.
setAttributeNS
method.setAttribute
in interface Element
name
- The name of the attribute to create or alter.value
- Value to set in string form.public Attr setAttributeNode(Attr newAttr)
Element
nodeName
) is already present in the element, it is
replaced by the new one. Replacing an attribute node by itself has no
effect.
setAttributeNodeNS
method.setAttributeNode
in interface Element
newAttr
- The Attr
node to add to the attribute list.newAttr
attribute replaces an existing
attribute, the replaced Attr
node is returned,
otherwise null
is returned.public Attr setAttributeNodeNS(Attr newAttr)
Element
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.setAttributeNodeNS
in interface Element
newAttr
- The Attr
node to add to the attribute list.newAttr
attribute replaces an existing
attribute with the same local name and namespace URI, the replaced
Attr
node is returned, otherwise null
is
returned.public void setAttributeNS(String namespaceURI, String qualifiedName, String value)
Element
qualifiedName
, and
its value is changed to be the value
parameter. This
value is a simple string; it is not parsed as it is being set. So any
markup (such as syntax to be recognized as an entity reference) is
treated as literal text, and needs to be appropriately escaped by the
implementation when it is written out. In order to assign an
attribute value that contains entity references, the user must create
an Attr
node plus any Text
and
EntityReference
nodes, build the appropriate subtree,
and use setAttributeNodeNS
or
setAttributeNode
to assign it as the value of an
attribute.
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.setAttributeNS
in interface Element
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.public int getLength()
NodeList
length-1
inclusive.public Node item(int index)
NodeList
index
th item in the collection. If
index
is greater than or equal to the number of nodes in
the list, this returns null
.public Node appendChild(Node newChild)
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.appendChild
in interface Node
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 nodepublic Node cloneNode(boolean deep)
Node
parentNode
is null
) and no user data. User
data associated to the imported node is not carried over. However, if
any UserDataHandlers
has been specified along with the
associated data these handlers will be called with the appropriate
parameters before this method returns.
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 children it
contains unless it is a deep clone. This includes text contained in
an the Element
since the text is contained in a child
Text
node. Cloning an Attr
directly, as
opposed to be cloned as part of an Element
cloning
operation, returns a specified attribute (specified
is
true
). Cloning an Attr
always clones its
children, since they represent its value, no matter whether this is a
deep clone or not. Cloning an EntityReference
automatically constructs its subtree if a corresponding
Entity
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.
EntityReference
clone are readonly
. In addition, clones of unspecified Attr
nodes are
specified. And, cloning Document
,
DocumentType
, Entity
, and
Notation
nodes is implementation dependent.public NamedNodeMap getAttributes()
Node
NamedNodeMap
containing the attributes of this node (if
it is an Element
) or null
otherwise.getAttributes
in interface Node
public NodeList getChildNodes()
Node
NodeList
that contains all children of this node. If
there are no children, this is a NodeList
containing no
nodes.getChildNodes
in interface Node
public Object getFeature(String feature, String version)
Node
Node
interface.getFeature
in interface Node
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.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.public Node getFirstChild()
Node
null
.getFirstChild
in interface Node
public Node getLastChild()
Node
null
.getLastChild
in interface Node
public String getLocalName()
Node
ELEMENT_NODE
and
ATTRIBUTE_NODE
and nodes created with a DOM Level 1
method, such as Document.createElement()
, this is always
null
.getLocalName
in interface Node
public String getNamespaceURI()
Node
null
if it is
unspecified (see ).
ELEMENT_NODE
and
ATTRIBUTE_NODE
and nodes created with a DOM Level 1
method, such as Document.createElement()
, this is always
null
.
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.
getNamespaceURI
in interface Node
public Node getNextSibling()
Node
null
.getNextSibling
in interface Node
public String getNodeName()
Node
getNodeName
in interface Node
public short getNodeType()
Node
getNodeType
in interface Node
public String getNodeValue()
Node
null
, setting it has no effect,
including if the node is read-only.getNodeValue
in interface Node
public Document getOwnerDocument()
Node
Document
object associated with this node. This is
also the Document
object used to create new nodes. When
this node is a Document
or a DocumentType
which is not used with any Document
yet, this is
null
.getOwnerDocument
in interface Node
public Node getParentNode()
Node
Attr
,
Document
, DocumentFragment
,
Entity
, and Notation
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 is
null
.getParentNode
in interface Node
public String getPrefix()
Node
null
if it is
unspecified. When it is defined to be null
, setting it
has no effect, including if the node is read-only.
nodeName
attribute, which holds the qualified name, as
well as the tagName
and name
attributes of
the Element
and Attr
interfaces, when
applicable.
null
makes it unspecified,
setting it to an empty string is implementation dependent.
namespaceURI
and localName
do not change.
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
.public Node getPreviousSibling()
Node
null
.getPreviousSibling
in interface Node
public TypeInfo getSchemaTypeInfo()
Element
getSchemaTypeInfo
in interface Element
public String getTextContent() throws DOMException
Node
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 |
getTextContent
in interface Node
DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a DOMString
variable on the implementation
platform.public Object getUserData(String key)
Node
setUserData
with the same key.getUserData
in interface Node
key
- The key the object is associated to.DOMUserData
associated to the given
key on this node, or null
if there was none.public boolean hasAttributes()
Node
hasAttributes
in interface Node
true
if this node has any attributes,
false
otherwise.public boolean hasChildNodes()
Node
hasChildNodes
in interface Node
true
if this node has any children,
false
otherwise.public Node insertBefore(Node newChild, Node refChild)
Node
newChild
before the existing child node
refChild
. If refChild
is null
,
insert newChild
at the end of the list of children.
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.
Note: Inserting a node before itself is implementation dependent.
insertBefore
in interface Node
newChild
- The node to insert.refChild
- The reference node, i.e., the node before which the
new node must be inserted.public boolean isDefaultNamespace(String namespaceURI)
Node
namespaceURI
is the
default namespace or not.isDefaultNamespace
in interface Node
namespaceURI
- The namespace URI to look for.true
if the specified
namespaceURI
is the default namespace,
false
otherwise.public boolean isEqualNode(Node arg)
Node
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.
isEqualNode
in interface Node
arg
- The node to compare equality with.true
if the nodes are equal,
false
otherwise.public boolean isSameNode(Node other)
Node
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.isSameNode
in interface Node
other
- The node to test against.true
if the nodes are the same,
false
otherwise.public boolean isSupported(String feature, String version)
Node
isSupported
in interface Node
feature
- The name of the feature to test.version
- This is the version number of the feature to test.true
if the specified feature is
supported on this node, false
otherwise.public String lookupNamespaceURI(String prefix)
Node
lookupNamespaceURI
in interface Node
prefix
- The prefix to look for. If this parameter is
null
, the method will return the default namespace URI
if any.null
if
none is found.public String lookupPrefix(String namespaceURI)
Node
lookupPrefix
in interface Node
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 void normalize()
Node
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. 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 the
DOMConfiguration
object attached to the
Node.ownerDocument
is true
, this method
will also fully normalize the characters of the Text
nodes.
Note: In cases where the document contains
CDATASections
, the normalize operation alone may not be
sufficient, since XPointers do not differentiate between
Text
nodes and CDATASection
nodes.
public Node removeChild(Node oldChild)
Node
oldChild
from the list
of children, and returns it.removeChild
in interface Node
oldChild
- The node being removed.public Node replaceChild(Node newChild, Node oldChild)
Node
oldChild
with newChild
in the list of children, and returns the oldChild
node.
newChild
is a DocumentFragment
object,
oldChild
is replaced by all of the
DocumentFragment
children, which are inserted in the
same order. If the newChild
is already in the tree, it
is first removed.
Note: Replacing a node with itself is implementation dependent.
replaceChild
in interface Node
newChild
- The new node to put in the child list.oldChild
- The node being replaced in the list.public void setIdAttribute(String name, boolean isId) throws DOMException
Element
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.setIdAttribute
in interface Element
name
- The name of the attribute.isId
- Whether the attribute is a of type ID.DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public void setIdAttributeNode(Attr idAttr, boolean isId) throws DOMException
Element
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.setIdAttributeNode
in interface Element
idAttr
- The attribute node.isId
- Whether the attribute is a of type ID.DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public void setIdAttributeNS(String namespaceURI, String localName, boolean isId) throws DOMException
Element
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
in interface Element
namespaceURI
- The namespace URI of the attribute.localName
- The local name of the attribute.isId
- Whether the attribute is a of type ID.DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public void setNodeValue(String nodeValue) throws DOMException
Node
null
, setting it has no effect,
including if the node is read-only.setNodeValue
in interface Node
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if
it is not defined to be null
.public void setPrefix(String prefix)
Node
null
if it is
unspecified. When it is defined to be null
, setting it
has no effect, including if the node is read-only.
nodeName
attribute, which holds the qualified name, as
well as the tagName
and name
attributes of
the Element
and Attr
interfaces, when
applicable.
null
makes it unspecified,
setting it to an empty string is implementation dependent.
namespaceURI
and localName
do not change.
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
.public void setTextContent(String textContent) throws DOMException
Node
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 |
setTextContent
in interface Node
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.public Object setUserData(String key, Object data, UserDataHandler handler)
Node
getUserData
with the
same key.setUserData
in interface Node
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
.DOMUserData
previously associated to
the given key on this node, or null
if there was none.