Added in API level 1

Element

interface Element : Node

org.w3c.dom.Element

The Element interface represents an element in an HTML or XML document. Elements may have attributes associated with them; since the Element interface inherits from Node, the generic Node interface attribute attributes may be used to retrieve the set of all attributes for an element. There are methods on the Element interface to retrieve either an Attr object by name or an attribute value by name. In XML, where an attribute value may contain entity references, an Attr object should be retrieved to examine the possibly fairly complex sub-tree representing the attribute value. On the other hand, in HTML, where all attributes have simple string values, methods to directly access an attribute value can safely be used as a convenience.

Note: In DOM Level 2, the method normalize is inherited from the Node interface where it was moved.

See also the Document Object Model (DOM) Level 3 Core Specification.

Summary

Inherited constants

From class Node Short ATTRIBUTE_NODE The node is an Attr. Short CDATA_SECTION_NODE The node is a CDATASection. Short COMMENT_NODE The node is a Comment. Short DOCUMENT_FRAGMENT_NODE The node is a DocumentFragment. Short DOCUMENT_NODE The node is a Document. Short DOCUMENT_POSITION_CONTAINED_BY The node is contained by the reference node. A node which is contained is always following, too. Short DOCUMENT_POSITION_CONTAINS The node contains the reference node. A node which contains is always preceding, too. Short DOCUMENT_POSITION_DISCONNECTED The two nodes are disconnected. Order between disconnected nodes is always implementation-specific. Short DOCUMENT_POSITION_FOLLOWING The node follows the reference node. Short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC The determination of preceding versus following is implementation-specific. Short DOCUMENT_POSITION_PRECEDING The second node precedes the reference node. Short DOCUMENT_TYPE_NODE The node is a DocumentType. Short ELEMENT_NODE The node is an Element. Short ENTITY_NODE The node is an Entity. Short ENTITY_REFERENCE_NODE The node is an EntityReference. Short NOTATION_NODE The node is a Notation. Short PROCESSING_INSTRUCTION_NODE The node is a ProcessingInstruction. Short TEXT_NODE The node is a Text node.

Public methods
abstract String!	getAttribute(name: String!) Retrieves an attribute value by name.
abstract String!	getAttributeNS(namespaceURI: String!, localName: String!) Retrieves an attribute value by local name and namespace URI.
abstract Attr!	getAttributeNode(name: String!) Retrieves an attribute node by name.
abstract Attr!	getAttributeNodeNS(namespaceURI: String!, localName: String!) Retrieves an Attr node by local name and namespace URI.
abstract NodeList!	getElementsByTagName(name: String!) Returns a NodeList of all descendant Elements with a given tag name, in document order.
abstract NodeList!	getElementsByTagNameNS(namespaceURI: String!, localName: String!) Returns a NodeList of all the descendant Elements with a given local name and namespace URI in document order.
abstract TypeInfo!	getSchemaTypeInfo() The type information associated with this element.
abstract String!	getTagName() The name of the element.
abstract Boolean	hasAttribute(name: String!) Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.
abstract Boolean	hasAttributeNS(namespaceURI: String!, localName: String!) 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 Unit	removeAttribute(name: String!) Removes an attribute by name.
abstract Unit	removeAttributeNS(namespaceURI: String!, localName: String!) Removes an attribute by local name and namespace URI.
abstract Attr!	removeAttributeNode(oldAttr: Attr!) Removes the specified attribute node.
abstract Unit	setAttribute(name: String!, value: String!) Adds a new attribute.
abstract Unit	setAttributeNS(namespaceURI: String!, qualifiedName: String!, value: String!) Adds a new attribute.
abstract Attr!	setAttributeNode(newAttr: Attr!) Adds a new attribute node.
abstract Attr!	setAttributeNodeNS(newAttr: Attr!) Adds a new attribute.
abstract Unit	setIdAttribute(name: String!, isId: Boolean) If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute .
abstract Unit	setIdAttributeNS(namespaceURI: String!, localName: String!, isId: Boolean) If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute .
abstract Unit	setIdAttributeNode(idAttr: Attr!, isId: Boolean) If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute .

Inherited functions

From class Node Node! appendChild(newChild: Node!) Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed. Node! cloneNode(deep: Boolean) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent ( 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. Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any 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. Note that cloning an immutable subtree results in a mutable copy, but the children of an EntityReference clone are readonly . In addition, clones of unspecified Attr nodes are specified. And, cloning Document, DocumentType, Entity, and Notation nodes is implementation dependent. Short compareDocumentPosition(other: Node!) 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. 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. 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. NodeList! getChildNodes() A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes. Any! getFeature(feature: String!, version: String!) This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in . This method also allow the implementation to provide specialized objects which do not support the Node interface. Node! getFirstChild() The first child of this node. If there is no such node, this returns null. Node! getLastChild() The last child of this node. If there is no such node, this returns null. String! getLocalName() Returns the local part of the qualified name of this node. For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null. String! getNamespaceURI() The namespace URI of this node, or null if it is unspecified (see ). This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time. For nodes of any type other than 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. Node! getNextSibling() The node immediately following this node. If there is no such node, this returns null. 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. When it is defined to be null, setting it has no effect, including if the node is read-only. Document! getOwnerDocument() The 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. Node! getParentNode() The parent of this node. All nodes, except 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. String! getPrefix() The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect, including if the node is read-only. Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable. Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent. Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change. For nodes of any type other than 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. Node! getPreviousSibling() The node immediately preceding this node. If there is no such node, this returns null. String! getTextContent() This attribute returns the text content of this node and its descendants. When it is defined to be 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. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute Text.isElementContentWhitespace). 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, 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 Any! getUserData(key: String!) 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. 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(newChild: Node!, refChild: Node!) Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children. If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed. Note: Inserting a node before itself is implementation dependent. Boolean isDefaultNamespace(namespaceURI: String!) This method checks if the specified namespaceURI is the default namespace or not. Boolean isEqualNode(arg: Node!) 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 . 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. 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, 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. Boolean isSameNode(other: Node!) 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 interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect. Boolean isSupported(feature: String!, version: String!) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in . String! lookupNamespaceURI(prefix: String!) Look up the namespace URI associated to the given prefix, starting from this node. See for details on the algorithm used by this method. String! lookupPrefix(namespaceURI: String!) Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method. See for details on the algorithm used by this method. Unit 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. 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. Node! removeChild(oldChild: Node!) Removes the child node indicated by oldChild from the list of children, and returns it. Node! replaceChild(newChild: Node!, oldChild: Node!) Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. If 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. Unit setNodeValue(nodeValue: String!) The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect, including if the node is read-only. Unit setPrefix(prefix: String!) The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect, including if the node is read-only. Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable. Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent. Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change. For nodes of any type other than 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. Unit setTextContent(textContent: String!) This attribute returns the text content of this node and its descendants. When it is defined to be 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. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute Text.isElementContentWhitespace). 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, 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 Any! setUserData(key: String!, data: Any!, handler: UserDataHandler!) Associate an object to a key on this node. The object can later be retrieved from this node by calling getUserData with the same key.

Public methods

getAttribute

Added in API level 1

abstract fun getAttribute(name: String!): String!

Retrieves an attribute value by name.

Parameters
name	String!: The name of the attribute to retrieve.

Return
String!	The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

getAttributeNS

Added in API level 1

abstract fun getAttributeNS(
    namespaceURI: String!, 
    localName: String!
): String!

Retrieves an attribute value by local name and namespace URI.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Parameters
namespaceURI	String!: The namespace URI of the attribute to retrieve.
localName	String!: The local name of the attribute to retrieve.

Return
String!	The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

Exceptions
org.w3c.dom.DOMException	NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

getAttributeNode

Added in API level 1

abstract fun getAttributeNode(name: String!): Attr!

Retrieves an attribute node by name.
To retrieve an attribute node by qualified name and namespace URI, use the getAttributeNodeNS method.

Parameters
name	String!: The name (nodeName) of the attribute to retrieve.

Return
Attr!	The Attr node with the specified name ( nodeName) or null if there is no such attribute.

getAttributeNodeNS

Added in API level 1

abstract fun getAttributeNodeNS(
    namespaceURI: String!, 
    localName: String!
): Attr!

Retrieves an Attr node by local name and namespace URI.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Parameters
namespaceURI	String!: The namespace URI of the attribute to retrieve.
localName	String!: The local name of the attribute to retrieve.

Return
Attr!	The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.

Exceptions
org.w3c.dom.DOMException	NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

getElementsByTagName

Added in API level 1

abstract fun getElementsByTagName(name: String!): NodeList!

Returns a NodeList of all descendant Elements with a given tag name, in document order.

Parameters
name	String!: The name of the tag to match on. The special value "*" matches all tags.

Return
NodeList!	A list of matching Element nodes.

getElementsByTagNameNS

Added in API level 1

abstract fun getElementsByTagNameNS(
    namespaceURI: String!, 
    localName: String!
): NodeList!

Returns a NodeList of all the descendant Elements with a given local name and namespace URI in document order.

Parameters
namespaceURI	String!: The namespace URI of the elements to match on. The special value "*" matches all namespaces.
localName	String!: The local name of the elements to match on. The special value "*" matches all local names.

Return
NodeList!	A new NodeList object containing all the matched Elements.

Exceptions
org.w3c.dom.DOMException	NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

getSchemaTypeInfo

Added in API level 8

abstract fun getSchemaTypeInfo(): TypeInfo!

The type information associated with this element.

getTagName

Added in API level 1

abstract fun getTagName(): String!

The name of the element. If 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.

hasAttribute

Added in API level 1

abstract fun hasAttribute(name: String!): Boolean

Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.

Parameters
name	String!: The name of the attribute to look for.

Return
Boolean	true if an attribute with the given name is specified on this element or has a default value, false otherwise.

hasAttributeNS

Added in API level 1

abstract fun hasAttributeNS(
    namespaceURI: String!, 
    localName: String!
): Boolean

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.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Parameters
namespaceURI	String!: The namespace URI of the attribute to look for.
localName	String!: The local name of the attribute to look for.

Return
Boolean	true if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise.

Exceptions
org.w3c.dom.DOMException	NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

removeAttribute

Added in API level 1

abstract fun removeAttribute(name: String!): Unit

Removes an attribute by name. If a default value for the removed attribute is defined in the DTD, a new attribute 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.
If no attribute with this name is found, this method has no effect.
To remove an attribute by local name and namespace URI, use the removeAttributeNS method.

Parameters
name	String!: The name of the attribute to remove.

Exceptions
org.w3c.dom.DOMException	NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

removeAttributeNS

Added in API level 1

abstract fun removeAttributeNS(
    namespaceURI: String!, 
    localName: String!
): Unit

Removes an attribute by local name and namespace URI. If a default value for the removed attribute is defined in the DTD, a new attribute 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.
If no attribute with this local name and namespace URI is found, this method has no effect.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Parameters
namespaceURI	String!: The namespace URI of the attribute to remove.
localName	String!: The local name of the attribute to remove.

Exceptions
org.w3c.dom.DOMException	NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

removeAttributeNode

Added in API level 1

abstract fun removeAttributeNode(oldAttr: Attr!): Attr!

Removes the specified attribute node. If a default value for the removed 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.

Parameters
oldAttr	Attr!: The Attr node to remove from the attribute list.

Return
Attr!	The Attr node that was removed.

Exceptions
org.w3c.dom.DOMException	NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element.

setAttribute

Added in API level 1

abstract fun setAttribute(
    name: String!, 
    value: String!
): Unit

Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of 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 setAttributeNode to assign it as the value of an attribute.
To set an attribute with a qualified name and namespace URI, use the setAttributeNS method.

Parameters
name	String!: The name of the attribute to create or alter.
value	String!: Value to set in string form.

Exceptions
org.w3c.dom.DOMException	INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

setAttributeNS

Added in API level 1

abstract fun setAttributeNS(
    namespaceURI: String!, 
    qualifiedName: String!, 
    value: String!
): Unit

Adds a new attribute. If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the 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.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Parameters
namespaceURI	String!: The namespace URI of the attribute to create or alter.
qualifiedName	String!: The qualified name of the attribute to create or alter.
value	String!: The value to set in string form.

Exceptions

org.w3c.dom.DOMException

INVALID_CHARACTER_ERR: Raised if the specified qualified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NAMESPACE_ERR: Raised if the qualifiedName is malformed per the Namespaces in XML specification, if the qualifiedName has a prefix and the namespaceURI is null, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace", if the qualifiedName or its prefix is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI is "http://www.w3.org/2000/xmlns/" and neither the qualifiedName nor its prefix is "xmlns". NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

setAttributeNode

Added in API level 1

abstract fun setAttributeNode(newAttr: Attr!): Attr!

Adds a new attribute node. If an attribute with that name ( nodeName) is already present in the element, it is replaced by the new one. Replacing an attribute node by itself has no effect.
To add a new attribute node with a qualified name and namespace URI, use the setAttributeNodeNS method.

Parameters
newAttr	Attr!: The Attr node to add to the attribute list.

Return
Attr!	If the newAttr attribute replaces an existing attribute, the replaced Attr node is returned, otherwise null is returned.

Exceptions
org.w3c.dom.DOMException	WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

setAttributeNodeNS

Added in API level 1

abstract fun setAttributeNodeNS(newAttr: Attr!): Attr!

Adds a new attribute. If an attribute with that local name and that namespace URI is already present in the element, it is replaced by the new one. Replacing an attribute node by itself has no effect.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Parameters
newAttr	Attr!: The Attr node to add to the attribute list.

Return
Attr!	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.

Exceptions

org.w3c.dom.DOMException

WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements. NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

setIdAttribute

Added in API level 8

abstract fun setIdAttribute(
    name: String!, 
    isId: Boolean
): Unit

If the parameter 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.
To specify an attribute by local name and namespace URI, use the setIdAttributeNS method.

Parameters
name	String!: The name of the attribute.
isId	Boolean: Whether the attribute is a of type ID.

Exceptions
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.

setIdAttributeNS

Added in API level 8

abstract fun setIdAttributeNS(
    namespaceURI: String!, 
    localName: String!, 
    isId: Boolean
): Unit

If the parameter 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	String!: The namespace URI of the attribute.
localName	String!: The local name of the attribute.
isId	Boolean: Whether the attribute is a of type ID.

Exceptions
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.

setIdAttributeNode

Added in API level 8

abstract fun setIdAttributeNode(
    idAttr: Attr!, 
    isId: Boolean
): Unit

If the parameter 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	Attr!: The attribute node.
isId	Boolean: Whether the attribute is a of type ID.

Exceptions
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.