public class

HTMLElementImpl

extends ElementImpl
implements HTMLElement

java.lang.Object
↳	org.apache.xerces.dom.NodeImpl
	↳	org.apache.xerces.dom.ChildNode
		↳	org.apache.xerces.dom.ParentNode
			↳	org.apache.xerces.dom.ElementImpl
				↳	org.apache.html.dom.HTMLElementImpl

Known Direct Subclasses

HTMLAnchorElementImpl, HTMLAppletElementImpl, HTMLAreaElementImpl, HTMLBRElementImpl, HTMLBaseElementImpl, HTMLBaseFontElementImpl, HTMLBodyElementImpl, HTMLButtonElementImpl, HTMLDListElementImpl, HTMLDirectoryElementImpl, HTMLDivElementImpl, HTMLFieldSetElementImpl, HTMLFontElementImpl, HTMLFormElementImpl, HTMLFrameElementImpl, and 37 others.

Class Overview

Implements an HTML-specific element, an org.w3c.dom.Element that will only appear inside HTML documents. This element extends ElementImpl by adding methods for directly manipulating HTML-specific attributes. All HTML elements gain access to the id, title, lang, dir and class attributes. Other elements add their own specific attributes.@xerces.internal

Summary

[Expand]

Inherited Constants

From class org.apache.xerces.dom.NodeImpl

From interface org.w3c.dom.Node

From interface org.w3c.dom.TypeInfo

[Expand]

Inherited Fields

From class org.apache.xerces.dom.ElementImpl

From class org.apache.xerces.dom.ParentNode

From class org.apache.xerces.dom.ChildNode

From class org.apache.xerces.dom.NodeImpl

Public Constructors
	HTMLElementImpl(HTMLDocumentImpl owner, String tagName) Constructor required owner document and element tag name.

Public Methods
String	getAttribute(String attrName) Look up a single Attribute by name.
String	getAttributeNS(String namespaceURI, String localName) Introduced in DOM Level 2.
Attr	getAttributeNode(String attrName) Look up a single Attribute by name.
Attr	getAttributeNodeNS(String namespaceURI, String localName) Retrieves an Attr node by local name and namespace URI.
String	getClassName()
String	getDir()
final NodeList	getElementsByTagName(String tagName) Returns a NodeList of all descendent nodes (children, grandchildren, and so on) which are Elements and which have the specified tag name.
final NodeList	getElementsByTagNameNS(String namespaceURI, String localName) Introduced in DOM Level 2.
HTMLFormElement	getForm() Convenience method returns the form in which this form element is contained.
String	getId()
String	getLang()
String	getTitle()
void	setClassName(String className)
void	setDir(String dir)
void	setId(String id)
void	setLang(String lang)
void	setTitle(String title)

[Expand]

Inherited Methods

From class org.apache.xerces.dom.ElementImpl

Node	cloneNode(boolean deep) Return a duplicate copy of this Element.
String	getAttribute(String name) Look up a single Attribute by name.
String	getAttributeNS(String namespaceURI, String localName) Introduced in DOM Level 2.
Attr	getAttributeNode(String name) Look up a single Attribute by name.
Attr	getAttributeNodeNS(String namespaceURI, String localName) Retrieves an Attr node by local name and namespace URI.
NamedNodeMap	getAttributes() Retrieve all the Attributes as a set.
String	getBaseURI() DOM Level 3 WD - Experimental.
NamedNodeMapImpl	getDefaultAttributes() Get the default attributes.
NodeList	getElementsByTagName(String tagname) Returns a NodeList of all descendent nodes (children, grandchildren, and so on) which are Elements and which have the specified tag name.
NodeList	getElementsByTagNameNS(String namespaceURI, String localName) Introduced in DOM Level 2.
String	getNodeName() Returns the element name
short	getNodeType() A short integer indicating what type of node this is.
TypeInfo	getSchemaTypeInfo() Method getSchemaTypeInfo.
String	getTagName() Returns the name of the Element.
String	getTypeName()
String	getTypeNamespace()
int	getXercesAttribute(String namespaceURI, String localName) NON-DOM: get inded of an attribute
boolean	hasAttribute(String name) Introduced in DOM Level 2.
boolean	hasAttributeNS(String namespaceURI, String localName) Introduced in DOM Level 2.
boolean	hasAttributes() Introduced in DOM Level 2.
boolean	isDerivedFrom(String typeNamespaceArg, String typeNameArg, int derivationMethod) Introduced in DOM Level 3.
boolean	isEqualNode(Node arg) DOM Level 3 WD- Experimental.
void	normalize() In "normal form" (as read from a source file), there will never be two Text children in succession.
void	reconcileDefaultAttributes() Reconcile default attributes.
void	removeAttribute(String name) Remove the named attribute from this Element.
void	removeAttributeNS(String namespaceURI, String localName) Introduced in DOM Level 2.
Attr	removeAttributeNode(Attr oldAttr) Remove the specified attribute/value pair.
void	setAttribute(String name, String value) Add a new name/value pair, or replace the value of the existing attribute having that name.
void	setAttributeNS(String namespaceURI, String qualifiedName, String value) Introduced in DOM Level 2.
Attr	setAttributeNode(Attr newAttr) Add a new attribute/value pair, or replace the value of the existing attribute with that name.
Attr	setAttributeNodeNS(Attr newAttr) Introduced in DOM Level 2.
void	setIdAttribute(String name, boolean makeId) DOM Level 3: register the given attribute node as an ID attribute
void	setIdAttributeNS(String namespaceURI, String localName, boolean makeId) DOM Level 3: register the given attribute node as an ID attribute
void	setIdAttributeNode(Attr at, boolean makeId) DOM Level 3: register the given attribute node as an ID attribute
void	setOwnerDocument(CoreDocumentImpl doc) NON-DOM set the ownerDocument of this node, its children, and its attributes
void	setReadOnly(boolean readOnly, boolean deep) NON-DOM: Subclassed to flip the attributes' readonly switch as well.
int	setXercesAttributeNode(Attr attr) NON-DOM: sets attribute node for this element
void	setupDefaultAttributes() Setup the default attributes.
void	synchronizeData() Synchronizes the data (name and value) for fast nodes.

From class org.apache.xerces.dom.ParentNode

Node	cloneNode(boolean deep) Returns a duplicate of a given node.
NodeList	getChildNodes() Obtain a NodeList enumerating all children of this node.
final NodeList	getChildNodesUnoptimized() Create a NodeList to access children that is use by subclass elements that have methods named getLength() or item(int).
Node	getFirstChild() The first child of this Node, or null if none.
Node	getLastChild() The last child of this Node, or null if none.
int	getLength() NodeList method: Count the immediate children of this node
Document	getOwnerDocument() Find the Document that this Node belongs to (the document in whose context the Node was created).
String	getTextContent() This attribute returns the text content of this node and its descendants.
boolean	hasChildNodes() Test whether this node has any children.
Node	insertBefore(Node newChild, Node refChild) Move one or more node(s) to our list of children.
boolean	isEqualNode(Node arg) DOM Level 3 WD- Experimental.
Node	item(int index) NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.
void	normalize() Override default behavior to call normalize() on this Node's children.
Node	removeChild(Node oldChild) Remove a child from this Node.
Node	replaceChild(Node newChild, Node oldChild) Make newChild occupy the location that oldChild used to have.
void	setOwnerDocument(CoreDocumentImpl doc) NON-DOM set the ownerDocument of this node and its children
void	setReadOnly(boolean readOnly, boolean deep) Override default behavior so that if deep is true, children are also toggled.
void	setTextContent(String textContent) This attribute returns the text content of this node and its descendants.
void	synchronizeChildren() Override this method in subclass to hook in efficient internal data structure.

From class org.apache.xerces.dom.ChildNode

From class org.apache.xerces.dom.NodeImpl

void	addEventListener(String type, EventListener listener, boolean useCapture)
Node	appendChild(Node newChild) Adds a child node to the end of the list of children for this node.
void	changed() Denotes that this node has changed.
int	changes() Returns the number of changes to this node.
Node	cloneNode(boolean deep) Returns a duplicate of a given node.
short	compareDocumentPosition(Node other) Compares a node with this node with regard to their position in the document.
short	compareTreePosition(Node other) This method is deprecated. No replacement.
boolean	dispatchEvent(Event event)
NamedNodeMap	getAttributes() Return the collection of attributes associated with this node, or null if none.
String	getBaseURI() The absolute base URI of this node or `null` if undefined.
NodeList	getChildNodes() Obtain a NodeList enumerating all children of this node.
Node	getContainer() For non-child nodes, the node which "points" to this node.
Object	getFeature(String feature, String version)
Node	getFirstChild() The first child of this Node, or null if none.
Node	getLastChild() The first child of this Node, or null if none.
int	getLength() NodeList method: Count the immediate children of this node By default we do not have any children, ParentNode overrides this.
String	getLocalName() Introduced in DOM Level 2.
String	getNamespaceURI() Introduced in DOM Level 2.
Node	getNextSibling() The next child of this node's parent, or null if none
abstract String	getNodeName() the name of this node.
int	getNodeNumber() Returns the node number
abstract short	getNodeType() A short integer indicating what type of node this is.
String	getNodeValue() Returns the node value.
Document	getOwnerDocument() Find the Document that this Node belongs to (the document in whose context the Node was created).
Node	getParentNode() Obtain the DOM-tree parent of this node, or null if it is not currently active in the DOM tree (perhaps because it has just been created or removed).
String	getPrefix() Introduced in DOM Level 2.
Node	getPreviousSibling() The previous child of this node's parent, or null if none
boolean	getReadOnly() NON-DOM: Returns true if this node is read-only.
String	getTextContent() This attribute returns the text content of this node and its descendants.
Object	getUserData() NON-DOM: Returns the user data associated to this node.
Object	getUserData(String key) Retrieves the object associated to a key on a this node.
Hashtable	getUserDataRecord()
boolean	hasAttributes() Returns whether this node (if it is an element) has any attributes.
boolean	hasChildNodes() Test whether this node has any children.
Node	insertBefore(Node newChild, Node refChild) Move one or more node(s) to our list of children.
boolean	isDefaultNamespace(String namespaceURI) DOM Level 3: Experimental 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) Introduced in DOM Level 2.
Node	item(int index) NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.
String	lookupNamespaceURI(String specifiedPrefix) DOM Level 3 - Experimental: Look up the namespace URI associated to the given prefix, starting from this node.
String	lookupPrefix(String namespaceURI) DOM Level 3 - Experimental: Look up the prefix associated to the given namespace URI, starting from this node.
final void	needsSyncChildren(boolean value)
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 markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates `Text` nodes, i.e., there are no adjacent `Text` nodes.
Node	removeChild(Node oldChild) Remove a child from this Node.
void	removeEventListener(String type, EventListener listener, boolean useCapture)
Node	replaceChild(Node newChild, Node oldChild) Make newChild occupy the location that oldChild used to have.
void	setNodeValue(String x) Sets the node value.
void	setOwnerDocument(CoreDocumentImpl doc) NON-DOM set the ownerDocument of this node
void	setPrefix(String prefix) Introduced in DOM Level 2.
void	setReadOnly(boolean readOnly, boolean deep) NON-DOM: PR-DOM-Level-1-19980818 mentions readonly nodes in conjunction with Entities, but provides no API to support this.
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	setUserData(Object data) NON-DOM: As an alternative to subclassing the DOM, this implementation has been extended with the ability to attach an object to each node.
void	synchronizeData() Override this method in subclass to hook in efficient internal data structure.
String	toString() NON-DOM method for debugging convenience.

From class java.lang.Object

From interface org.w3c.dom.Element

abstract String	getAttribute(String arg0)
abstract String	getAttributeNS(String arg0, String arg1)
abstract Attr	getAttributeNode(String arg0)
abstract Attr	getAttributeNodeNS(String arg0, String arg1)
abstract NodeList	getElementsByTagName(String arg0)
abstract NodeList	getElementsByTagNameNS(String arg0, String arg1)
abstract TypeInfo	getSchemaTypeInfo()
abstract String	getTagName()
abstract boolean	hasAttribute(String arg0)
abstract boolean	hasAttributeNS(String arg0, String arg1)
abstract void	removeAttribute(String arg0)
abstract void	removeAttributeNS(String arg0, String arg1)
abstract Attr	removeAttributeNode(Attr arg0)
abstract void	setAttribute(String arg0, String arg1)
abstract void	setAttributeNS(String arg0, String arg1, String arg2)
abstract Attr	setAttributeNode(Attr arg0)
abstract Attr	setAttributeNodeNS(Attr arg0)
abstract void	setIdAttribute(String arg0, boolean arg1)
abstract void	setIdAttributeNS(String arg0, String arg1, boolean arg2)
abstract void	setIdAttributeNode(Attr arg0, boolean arg1)

From interface org.w3c.dom.Node

abstract Node	appendChild(Node arg0)
abstract Node	cloneNode(boolean arg0)
abstract short	compareDocumentPosition(Node arg0)
abstract NamedNodeMap	getAttributes()
abstract String	getBaseURI()
abstract NodeList	getChildNodes()
abstract Object	getFeature(String arg0, String arg1)
abstract Node	getFirstChild()
abstract Node	getLastChild()
abstract String	getLocalName()
abstract String	getNamespaceURI()
abstract Node	getNextSibling()
abstract String	getNodeName()
abstract short	getNodeType()
abstract String	getNodeValue()
abstract Document	getOwnerDocument()
abstract Node	getParentNode()
abstract String	getPrefix()
abstract Node	getPreviousSibling()
abstract String	getTextContent()
abstract Object	getUserData(String arg0)
abstract boolean	hasAttributes()
abstract boolean	hasChildNodes()
abstract Node	insertBefore(Node arg0, Node arg1)
abstract boolean	isDefaultNamespace(String arg0)
abstract boolean	isEqualNode(Node arg0)
abstract boolean	isSameNode(Node arg0)
abstract boolean	isSupported(String arg0, String arg1)
abstract String	lookupNamespaceURI(String arg0)
abstract String	lookupPrefix(String arg0)
abstract void	normalize()
abstract Node	removeChild(Node arg0)
abstract Node	replaceChild(Node arg0, Node arg1)
abstract void	setNodeValue(String arg0)
abstract void	setPrefix(String arg0)
abstract void	setTextContent(String arg0)
abstract Object	setUserData(String arg0, Object arg1, UserDataHandler arg2)

From interface org.w3c.dom.NodeList

From interface org.w3c.dom.TypeInfo

From interface org.w3c.dom.events.EventTarget

From interface org.w3c.dom.html.HTMLElement

Public Constructors

public HTMLElementImpl (HTMLDocumentImpl owner, String tagName)

Constructor required owner document and element tag name. Will be called by the constructor of specific element types but with a known tag name. Assures that the owner document is an HTML element.

Parameters

owner	The owner HTML document
tagName	The element's tag name

Public Methods

public String getAttribute (String attrName)

Look up a single Attribute by name. Returns the Attribute's string value, or an empty string (NOT null!) to indicate that the name did not map to a currently defined attribute.

Note: Attributes may contain complex node trees. This method returns the "flattened" string obtained from Attribute.getValue(). If you need the structure information, see getAttributeNode().

public String getAttributeNS (String namespaceURI, String localName)

Introduced in DOM Level 2.

Retrieves an attribute value by local name and namespace URI.

Parameters

namespaceURI	The namespace URI of the attribute to retrieve.
localName	The local name of the attribute to retrieve.

Returns

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

public Attr getAttributeNode (String attrName)

Look up a single Attribute by name. Returns the Attribute Node, so its complete child tree is available. This could be important in XML, where the string rendering may not be sufficient information.

If no matching attribute is available, returns null.

public Attr getAttributeNodeNS (String namespaceURI, String localName)

Retrieves an Attr node by local name and namespace URI.

Parameters

namespaceURI	The namespace URI of the attribute to retrieve.
localName	The local name of the attribute to retrieve.

Returns

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

public String getClassName ()

public String getDir ()

public final NodeList getElementsByTagName (String tagName)

Returns a NodeList of all descendent nodes (children, grandchildren, and so on) which are Elements and which have the specified tag name.

Note: NodeList is a "live" view of the DOM. Its contents will change as the DOM changes, and alterations made to the NodeList will be reflected in the DOM.

Parameters

tagName	The type of element to gather. To obtain a list of all elements no matter what their names, use the wild-card tag name "*".

public final NodeList getElementsByTagNameNS (String namespaceURI, String localName)

Introduced in DOM Level 2.

Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the Document tree, starting from this node.

Parameters

namespaceURI	The namespace URI of the elements to match on. The special value "*" matches all namespaces. When it is null or an empty string, this method behaves like getElementsByTagName.
localName	The local name of the elements to match on. The special value "*" matches all local names.

Returns

NodeList A new NodeList object containing all the matched Elements.

public HTMLFormElement getForm ()

Convenience method returns the form in which this form element is contained. This method is exposed for form elements through the DOM API, but other elements have no access to it through the API.

Interfaces

Classes

HTMLElementImpl

Class Overview

See Also

Summary

Public Constructors

public HTMLElementImpl (HTMLDocumentImpl owner, String tagName)

Parameters

Public Methods

public String getAttribute (String attrName)

public String getAttributeNS (String namespaceURI, String localName)

Parameters

Returns

public Attr getAttributeNode (String attrName)

public Attr getAttributeNodeNS (String namespaceURI, String localName)

Parameters

Returns

public String getClassName ()

public String getDir ()

public final NodeList getElementsByTagName (String tagName)

Parameters

public final NodeList getElementsByTagNameNS (String namespaceURI, String localName)

Parameters

Returns

public HTMLFormElement getForm ()

public String getId ()

public String getLang ()

public String getTitle ()

public void setClassName (String className)

public void setDir (String dir)

public void setId (String id)

public void setLang (String lang)

public void setTitle (String title)