File	Doc	Category	Size	Date	Package
Element.java	API Doc	Java SE 5 API	23867	Fri Aug 26 14:58:38 BST 2005	org.w3c.dom

Element

Fields Summary

Constructors Summary

Methods Summary
public java.lang.String	getAttribute(java.lang.String name) Retrieves an attribute value by name. param name The name of the attribute to retrieve. return The Attr value as a string, or the empty string if that attribute does not have a specified or default value.
public java.lang.String	getAttributeNS(java.lang.String namespaceURI, java.lang.String localName) 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. param namespaceURI The namespace URI of the attribute to retrieve. param localName The local name of the attribute to retrieve. return The Attr value as a string, or the empty string if that attribute does not have a specified or default value. exception 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]). since DOM Level 2
public org.w3c.dom.Attr	getAttributeNode(java.lang.String name) Retrieves an attribute node by name. To retrieve an attribute node by qualified name and namespace URI, use the getAttributeNodeNS method. param name The name (nodeName) of the attribute to retrieve. return The Attr node with the specified name ( nodeName) or null if there is no such attribute.
public org.w3c.dom.Attr	getAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName) 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. param namespaceURI The namespace URI of the attribute to retrieve. param localName The local name of the attribute to retrieve. return The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute. exception 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]). since DOM Level 2
public org.w3c.dom.NodeList	getElementsByTagName(java.lang.String name) Returns a NodeList of all descendant Elements with a given tag name, in document order. param name The name of the tag to match on. The special value "*" matches all tags. return A list of matching Element nodes.
public org.w3c.dom.NodeList	getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName) Returns a NodeList of all the descendant Elements with a given local name and namespace URI in document order. param namespaceURI The namespace URI of the elements to match on. The special value "*" matches all namespaces. param localName The local name of the elements to match on. The special value "*" matches all local names. return A new NodeList object containing all the matched Elements. exception 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]). since DOM Level 2
public org.w3c.dom.TypeInfo	getSchemaTypeInfo() The type information associated with this element. since DOM Level 3
public java.lang.String	getTagName() 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.
public boolean	hasAttribute(java.lang.String name) Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. param name The name of the attribute to look for. return true if an attribute with the given name is specified on this element or has a default value, false otherwise. since DOM Level 2
public boolean	hasAttributeNS(java.lang.String namespaceURI, java.lang.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. Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace. param namespaceURI The namespace URI of the attribute to look for. param localName The local name of the attribute to look for. return true if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise. exception 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]). since DOM Level 2
public void	removeAttribute(java.lang.String name) 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. param name The name of the attribute to remove. exception DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public void	removeAttributeNS(java.lang.String namespaceURI, java.lang.String localName) 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. param namespaceURI The namespace URI of the attribute to remove. param localName The local name of the attribute to remove. exception 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]). since DOM Level 2
public org.w3c.dom.Attr	removeAttributeNode(org.w3c.dom.Attr oldAttr) 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. param oldAttr The Attr node to remove from the attribute list. return The Attr node that was removed. exception DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element.
public void	setAttribute(java.lang.String name, java.lang.String value) 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. param name The name of the attribute to create or alter. param value Value to set in string form. exception 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.
public void	setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value) 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. param namespaceURI The namespace URI of the attribute to create or alter. param qualifiedName The qualified name of the attribute to create or alter. param value The value to set in string form. exception 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]). since DOM Level 2
public org.w3c.dom.Attr	setAttributeNode(org.w3c.dom.Attr newAttr) 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. param newAttr The Attr node to add to the attribute list. return If the newAttr attribute replaces an existing attribute, the replaced Attr node is returned, otherwise null is returned. exception 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.
public org.w3c.dom.Attr	setAttributeNodeNS(org.w3c.dom.Attr newAttr) 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. param newAttr The Attr node to add to the attribute list. return 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. exception 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]). since DOM Level 2
public void	setIdAttribute(java.lang.String name, boolean isId) 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. param name The name of the attribute. param isId Whether the attribute is a of type ID. exception 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
public void	setIdAttributeNS(java.lang.String namespaceURI, java.lang.String localName, boolean isId) 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. param namespaceURI The namespace URI of the attribute. param localName The local name of the attribute. param isId Whether the attribute is a of type ID. exception 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
public void	setIdAttributeNode(org.w3c.dom.Attr idAttr, boolean isId) 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. param idAttr The attribute node. param isId Whether the attribute is a of type ID. exception 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