Movatterモバイル変換

Interface Element

All Superinterfaces:

Node

public interfaceElement

extendsNode

TheElement interface represents an element in an HTML or XML document. Elements may have attributes associated with them; since theElement interface inherits fromNode, the genericNode interface attributeattributes may be used to retrieve the set of all attributes for an element. There are methods on theElement interface to retrieve either anAttr object by name or an attribute value by name. In XML, where an attribute value may contain entity references, anAttr 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.In DOM Level 2, the methodnormalize is inherited from theNode interface where it was moved.

See also theDocument Object Model (DOM) Level 2 Core Specification.

getTagName

public java.lang.StringgetTagName()

The name of the element. For example, in:

 <elementExample > ... </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 thetagName of an HTML element in the canonical uppercase form, regardless of the case in the source HTML document.

getAttribute

public java.lang.StringgetAttribute(java.lang.String name)

Retrieves an attribute value by name.

Parameters:

name - The name of the attribute to retrieve.

Returns:

TheAttr value as a string, or the empty string if that attribute does not have a specified or default value.

setAttribute

public voidsetAttribute(java.lang.String name,                         java.lang.String value)                  throwsDOMException

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 anAttr node plus anyText andEntityReference nodes, build the appropriate subtree, and usesetAttributeNode to assign it as the value of an attribute.
To set an attribute with a qualified name and namespace URI, use thesetAttributeNS method.

Parameters:

name - The name of the attribute to create or alter.

value - Value to set in string form.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

removeAttribute

public voidremoveAttribute(java.lang.String name)                     throwsDOMException

Removes an attribute by name. If the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.
To remove an attribute by local name and namespace URI, use theremoveAttributeNS method.

Parameters:

name - The name of the attribute to remove.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

getAttributeNode

publicAttrgetAttributeNode(java.lang.String name)

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

Parameters:

name - The name (nodeName) of the attribute to retrieve.

Returns:

TheAttr node with the specified name (nodeName) ornull if there is no such attribute.

setAttributeNode

publicAttrsetAttributeNode(Attr newAttr)                      throwsDOMException

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.
To add a new attribute node with a qualified name and namespace URI, use thesetAttributeNodeNS method.

Parameters:

newAttr - TheAttr node to add to the attribute list.

Returns:

If thenewAttr attribute replaces an existing attribute, the replacedAttr node is returned, otherwisenull is returned.

Throws:

DOMException - WRONG_DOCUMENT_ERR: Raised ifnewAttr 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 ifnewAttr is already an attribute of anotherElement object. The DOM user must explicitly cloneAttr nodes to re-use them in other elements.

removeAttributeNode

publicAttrremoveAttributeNode(Attr oldAttr)                         throwsDOMException

Removes the specified attribute node. If the removedAttr has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix, when applicable.

Parameters:

oldAttr - TheAttr node to remove from the attribute list.

Returns:

TheAttr node that was removed.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised ifoldAttr is not an attribute of the element.

getElementsByTagName

publicNodeListgetElementsByTagName(java.lang.String name)

Returns aNodeList of all descendantElements with a given tag name, in the order in which they are encountered in a preorder traversal of thisElement tree.

Parameters:

name - The name of the tag to match on. The special value "*" matches all tags.

Returns:

A list of matchingElement nodes.

getAttributeNS

public java.lang.StringgetAttributeNS(java.lang.String namespaceURI,                                       java.lang.String localName)

Retrieves an attribute value by local name and namespace URI.
Documents which do not support the "XML" feature will permit only the DOM Level 1 calls for creating/setting elements and attributes. Hence, if you specify a non-null namespace URI, these DOMs will never find a matching node.

Parameters:

namespaceURI - The namespace URI of the attribute to retrieve.

localName - The local name of the attribute to retrieve.

Returns:

TheAttr value as a string, or the empty string if that attribute does not have a specified or default value.

Since:

DOM Level 2

setAttributeNS

public voidsetAttributeNS(java.lang.String namespaceURI,                           java.lang.String qualifiedName,                           java.lang.String value)                    throwsDOMException

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 thequalifiedName, and its value is changed to be thevalue 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 anAttr node plus anyText andEntityReference nodes, build the appropriate subtree, and usesetAttributeNodeNS orsetAttributeNode to assign it as the value of an attribute.

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 - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character, per the XML 1.0 specification .
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if thequalifiedName is malformed per the Namespaces in XML specification, if thequalifiedName has a prefix and thenamespaceURI isnull, if thequalifiedName has a prefix that is "xml" and thenamespaceURI is different from " http://www.w3.org/XML/1998/namespace", or if thequalifiedName, or its prefix, is "xmlns" and thenamespaceURI is different from " http://www.w3.org/2000/xmlns/".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the"XML" feature, since namespaces were defined by XML.

Since:

DOM Level 2

removeAttributeNS

public voidremoveAttributeNS(java.lang.String namespaceURI,                              java.lang.String localName)                       throwsDOMException

Removes an attribute by local name and namespace URI. If the removed attribute has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix.
Documents which do not support the "XML" feature will permit only the DOM Level 1 calls for creating/setting elements and attributes. Hence, if you specify a non-null namespace URI, these DOMs will never find a matching node.

Parameters:

namespaceURI - The namespace URI of the attribute to remove.

localName - The local name of the attribute to remove.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Since:

DOM Level 2

getAttributeNodeNS

publicAttrgetAttributeNodeNS(java.lang.String namespaceURI,                               java.lang.String localName)

Retrieves anAttr node by local name and namespace URI.
Documents which do not support the "XML" feature will permit only the DOM Level 1 calls for creating/setting elements and attributes. Hence, if you specify a non-null namespace URI, these DOMs will never find a matching node.

Parameters:

namespaceURI - The namespace URI of the attribute to retrieve.

localName - The local name of the attribute to retrieve.

Returns:

TheAttr node with the specified attribute local name and namespace URI ornull if there is no such attribute.

Since:

DOM Level 2

setAttributeNodeNS

publicAttrsetAttributeNodeNS(Attr newAttr)                        throwsDOMException

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.

Parameters:

newAttr - TheAttr node to add to the attribute list.

Returns:

If thenewAttr attribute replaces an existing attribute with the same local name and namespace URI, the replacedAttr node is returned, otherwisenull is returned.

Throws:

DOMException - WRONG_DOCUMENT_ERR: Raised ifnewAttr 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 ifnewAttr is already an attribute of anotherElement object. The DOM user must explicitly cloneAttr nodes to re-use them in other elements.
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the"XML" feature, since namespaces were defined by XML.

Since:

DOM Level 2

getElementsByTagNameNS

publicNodeListgetElementsByTagNameNS(java.lang.String namespaceURI,                                       java.lang.String localName)

Returns aNodeList of all the descendantElements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of thisElement tree.
Documents which do not support the "XML" feature will permit only the DOM Level 1 calls for creating/setting elements and attributes. Hence, if you specify a non-null namespace URI, these DOMs will never find a matching node.

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 newNodeList object containing all the matchedElements.

Since:

DOM Level 2

hasAttribute

public booleanhasAttribute(java.lang.String name)

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

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

hasAttributeNS

public booleanhasAttributeNS(java.lang.String namespaceURI,                              java.lang.String localName)

Returnstrue when an attribute with a given local name and namespace URI is specified on this element or has a default value,false otherwise.
Documents which do not support the "XML" feature will permit only the DOM Level 1 calls for creating/setting elements and attributes. Hence, if you specify a non-null namespace URI, these DOMs will never find a matching node.

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