org.openxml.dom.html

Class HTMLElementImpl

java.lang.Object

org.openxml.dom.NodeImpl

org.openxml.dom.ParentNodeImpl

org.openxml.dom.ParentNSNodeImpl

org.openxml.dom.ElementImpl

org.openxml.dom.html.HTMLElementImpl

All Implemented Interfaces:

Cloneable, Element, org.w3c.dom.html.HTMLElement, Node

Direct Known Subclasses:

HTMLAnchorElementImpl, HTMLAppletElementImpl, HTMLAreaElementImpl, HTMLBaseElementImpl, HTMLBaseFontElementImpl, HTMLBodyElementImpl, HTMLBRElementImpl, HTMLButtonElementImpl, HTMLDirectoryElementImpl, HTMLDivElementImpl, HTMLDListElementImpl, HTMLFieldSetElementImpl, HTMLFontElementImpl, HTMLFormElementImpl, HTMLFrameElementImpl, HTMLFrameSetElementImpl, HTMLHeadElementImpl, HTMLHeadingElementImpl, HTMLHRElementImpl, HTMLHtmlElementImpl, HTMLIFrameElementImpl, HTMLImageElementImpl, HTMLInputElementImpl, HTMLIsIndexElementImpl, HTMLLabelElementImpl, HTMLLegendElementImpl, HTMLLIElementImpl, HTMLLinkElementImpl, HTMLMapElementImpl, HTMLMenuElementImpl, HTMLMetaElementImpl, HTMLModElementImpl, HTMLObjectElementImpl, HTMLOListElementImpl, HTMLOptGroupElementImpl, HTMLOptionElementImpl, HTMLParagraphElementImpl, HTMLParamElementImpl, HTMLPreElementImpl, HTMLQuoteElementImpl, HTMLScriptElementImpl, HTMLSelectElementImpl, HTMLStyleElementImpl, HTMLTableCaptionElementImpl, HTMLTableCellElementImpl, HTMLTableColElementImpl, HTMLTableElementImpl, HTMLTableRowElementImpl, HTMLTableSectionElementImpl, HTMLTextAreaElementImpl, HTMLTitleElementImpl, HTMLUListElementImpl

public class HTMLElementImpl
extends ElementImpl
implements org.w3c.dom.html.HTMLElement

Implements an HTML-specific element, an 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.

Note that some support is provided by NodeImpl directly: translating all tag names to upper case and all attribute names to lower case.

Author:

Assaf Arkin

See Also:

HTMLElement, ElementImpl

Field Summary

Fields inherited from class org.openxml.dom.NodeImpl

ATTLIST_DECL_NODE, ELEMENT_DECL_NODE, PARAM_ENTITY_NODE

Fields inherited from interface org.w3c.dom.Node

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

Method Summary

Modifier and Type	Method and Description
protected NodeImpl	castNewChild(Node newChild) Checks whether newChild can be added to this node as a child, and if so, performs a necessary cast.
Object	clone()
Node	cloneNode(boolean deep)
String	getAttribute(String attrName)
Attr	getAttributeNode(String attrName)
Attr	getAttributeNodeNS(String namespaceURI, String localName)
String	getAttributeNS(String namespaceURI, String localName)
String	getClassName()
String	getDir()
NodeList	getElementsByTagName(String tagName) Returns a list of elements extracted based on their tag name (or all of them if the tag name is "*").
NodeList	getElementsByTagNameNS(String namespaceURI, String localName)
org.w3c.dom.html.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)

Methods inherited from class org.openxml.dom.ElementImpl

cloneInto, compareDocumentPosition, equals, getAttributes, getBaseURI, getFeature, getNodeType, getSchemaTypeInfo, getTagName, getTextContent, getUserData, hasAttribute, hasAttributeNS, hasAttributes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, setTextContent, setUserData, toString

Methods inherited from class org.openxml.dom.ParentNSNodeImpl

getLocalName, getNamespaceURI, getPrefix, setPrefix

Methods inherited from class org.openxml.dom.ParentNodeImpl

appendChild, castOldChild, createNodeIterator, getChildNodes, getFirstChild, getLastChild, hasChildNodes, insertBefore, removeChild, removeInnerIterator, replaceChild

Methods inherited from class org.openxml.dom.NodeImpl

getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, isReadOnly, makeReadOnly, setOwnerDocument, supports

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Element

getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node

appendChild, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Method Detail

getId

public String getId()

Specified by:

getId in interface org.w3c.dom.html.HTMLElement

setId

public void setId(String id)

Specified by:

setId in interface org.w3c.dom.html.HTMLElement

getTitle

public String getTitle()

Specified by:

getTitle in interface org.w3c.dom.html.HTMLElement

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface org.w3c.dom.html.HTMLElement

getLang

public String getLang()

Specified by:

getLang in interface org.w3c.dom.html.HTMLElement

setLang

public void setLang(String lang)

Specified by:

setLang in interface org.w3c.dom.html.HTMLElement

getDir

public String getDir()

Specified by:

getDir in interface org.w3c.dom.html.HTMLElement

setDir

public void setDir(String dir)

Specified by:

setDir in interface org.w3c.dom.html.HTMLElement

getClassName

public String getClassName()

Specified by:

getClassName in interface org.w3c.dom.html.HTMLElement

setClassName

public void setClassName(String className)

Specified by:

setClassName in interface org.w3c.dom.html.HTMLElement

getAttributeNode

public Attr getAttributeNode(String attrName)

Specified by:

getAttributeNode in interface Element

Overrides:

getAttributeNode in class ElementImpl

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI,
                               String localName)

Specified by:

getAttributeNodeNS in interface Element

Overrides:

getAttributeNodeNS in class ElementImpl

getAttribute

public String getAttribute(String attrName)

Specified by:

getAttribute in interface Element

Overrides:

getAttribute in class ElementImpl

getAttributeNS

public String getAttributeNS(String namespaceURI,
                             String localName)

Specified by:

getAttributeNS in interface Element

Overrides:

getAttributeNS in class ElementImpl

getElementsByTagName

public final NodeList getElementsByTagName(String tagName)

Description copied from class: ElementImpl

Returns a list of elements extracted based on their tag name (or all of them if the tag name is "*"). The returned list is a snapshot of the element's contents at the time of calling. Subsequent updates to the element are not reflected in the list. This might result in inaccuracies when working from multiple threads.

Specified by:

getElementsByTagName in interface Element

Overrides:

getElementsByTagName in class ElementImpl

Parameters:

tagName - The element tag name to look for or "*" for all elements

Returns:

A snapshot of the named elements contained within this element

getElementsByTagNameNS

public final NodeList getElementsByTagNameNS(String namespaceURI,
                                             String localName)

Specified by:

getElementsByTagNameNS in interface Element

Overrides:

getElementsByTagNameNS in class ElementImpl

getForm

public org.w3c.dom.html.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.

castNewChild

protected NodeImpl castNewChild(Node newChild)
                         throws DOMException

Description copied from class: ParentNodeImpl

Checks whether newChild can be added to this node as a child, and if so, performs a necessary cast. newChild cannot be null and must belong to this DOM. It is impossible to transfer nodes between different DOM implementations.

The following rules govern the allowed newChild types:

• Parent is an Attr, newChild must be either a Text or an EntityReference
• Parent is a DocumentType, newChild must be either an Entity or a Notation.
• Parnet is any other node type, newChild must be an Element, a CharacterData derived type, a DocumentFragment, an EntityReference or a ProcessingInstruction.

Any deviation will throw an exception.

Overrides:

castNewChild in class ParentNodeImpl

Parameters:

newChild - New child node

Returns:

newChild cast to type NodeImpl

Throws:

DOMException - HIERARCHY_REQUEST_ERR newChild is null, does not belong to this DOM, or its node type is not supported for this parent

clone

public final Object clone()

Overrides:

clone in class ElementImpl

cloneNode

public final Node cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

Overrides:

cloneNode in class ElementImpl