org.apache.html.dom
Class HTMLDocumentImpl

java.lang.Object
  org.apache.xerces.dom.NodeImpl
      org.apache.xerces.dom.ChildNode
          org.apache.xerces.dom.ParentNode
              org.apache.xerces.dom.CoreDocumentImpl
                  org.apache.xerces.dom.DocumentImpl
                      org.apache.html.dom.HTMLDocumentImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Document, DocumentEvent, EventTarget, HTMLDocument, Node, NodeList, DocumentRange, DocumentTraversal

public class HTMLDocumentImpl
extends DocumentImpl
implements HTMLDocument

Implements an HTML document. Provides access to the top level element in the document, its body and title.

Several methods create new nodes of all basic types (comment, text, element, etc.). These methods create new nodes but do not place them in the document tree. The nodes may be placed in the document tree using Node.appendChild(org.w3c.dom.Node) or Node.insertBefore(org.w3c.dom.Node, org.w3c.dom.Node), or they may be placed in some other document tree.

Note: <FRAMESET> documents are not supported at the moment, neither are direct document writing (open(), write(java.lang.String)) and HTTP attribute methods (getURL(), getCookie()).

Version:

$Revision: 451609 $ $Date: 2006-09-30 12:20:57 -0400 (Sat, 30 Sep 2006) $

Author:

Assaf Arkin

See Also:

HTMLDocument, Serialized Form

Field Summary

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_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

Constructor Summary

HTMLDocumentImpl()

Method Summary

Node	cloneNode(boolean deep) Deep-clone a document, including fixing ownerDoc for the cloned children.
void	close() Closes a document stream opened by open()and forces rendering.
Attr	createAttribute(java.lang.String name) Creates an Attribute having this Document as its OwnerDoc.
Element	createElement(java.lang.String tagName) Factory method; creates an Element having this Document as its OwnerDoc.
Element	createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName) Introduced in DOM Level 2.
Element	createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String localpart) Xerces-specific constructor.
HTMLCollection	getAnchors() A collection of all the anchor (A) elements in a document with a value for the name attribute.Note.
HTMLCollection	getApplets() A collection of all the OBJECT elements that includeapplets and APPLET (deprecated) elements ina document.
HTMLElement	getBody() The element that contains the content for the document.
java.lang.String	getCookie() The cookies associated with this document.
Element	getDocumentElement() Convenience method, allowing direct access to the child node which is considered the root of the actual document content.
java.lang.String	getDomain() The domain name of the server that served the document, or a nullstring if the server cannot be identified by a domain name.
Element	getElementById(java.lang.String elementId) Introduced in DOM Level 2 Returns the Element whose ID is given by elementId.
NodeList	getElementsByName(java.lang.String elementName) Returns the (possibly empty) collection of elements whosename value is given by elementName.
NodeList	getElementsByTagName(java.lang.String tagName) Return a live collection of all descendent Elements (not just immediate children) having the specified tag name.
NodeList	getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName) Introduced in DOM Level 2.
HTMLCollection	getForms() A collection of all the forms of a document.
HTMLElement	getHead() Obtains the <HEAD> element in the document, creating one if does not exist before.
HTMLCollection	getImages() A collection of all the IMG elements in a document.The behavior is limited to IMG elements forbackwards compatibility.
HTMLCollection	getLinks() A collection of all AREA elements andanchor (A) elements in a documentwith a value for the href attribute.
java.lang.String	getReferrer() Returns the URI of the page that linked to this page.
java.lang.String	getTitle() The title of a document as specified by the TITLEelement in the head of the document.
java.lang.String	getURL() The complete URI of the document.
void	open() Note.This method and the ones following allow a user to add to or replace the structuremodel of a document using strings of unparsed HTML.
void	setBody(HTMLElement newBody)
void	setCookie(java.lang.String cookie)
void	setTitle(java.lang.String newTitle)
void	write(java.lang.String text) Write a string of text to a document stream opened byopen().
void	writeln(java.lang.String text) Write a string of text followed by a newline character to a document stream opened by open().

Methods inherited from class org.apache.xerces.dom.DocumentImpl

createEvent, createNodeIterator, createNodeIterator, createRange, createTreeWalker, createTreeWalker, getImplementation

Methods inherited from class org.apache.xerces.dom.CoreDocumentImpl

abort, adoptNode, clone, createAttributeNS, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createDocumentType, createElementDefinition, createEntity, createEntityReference, createNotation, createProcessingInstruction, createTextNode, getAsync, getBaseURI, getDoctype, getDocumentURI, getDomConfig, getEncoding, getErrorChecking, getFeature, getIdentifier, getIdentifiers, getInputEncoding, getNodeName, getNodeType, getOwnerDocument, getStandalone, getStrictErrorChecking, getTextContent, getUserData, getVersion, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, insertBefore, isValidQName, isXMLName, load, loadXML, normalizeDocument, putIdentifier, removeChild, removeIdentifier, renameNode, replaceChild, saveXML, setAsync, setDocumentURI, setEncoding, setErrorChecking, setInputEncoding, setStandalone, setStrictErrorChecking, setTextContent, setUserData, setVersion, setXmlEncoding, setXmlStandalone, setXmlVersion

Methods inherited from class org.apache.xerces.dom.ParentNode

getChildNodes, getFirstChild, getLastChild, getLength, hasChildNodes, isEqualNode, item, normalize, setReadOnly

Methods inherited from class org.apache.xerces.dom.ChildNode

getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, appendChild, compareDocumentPosition, compareTreePosition, dispatchEvent, getAttributes, getLocalName, getNamespaceURI, getNodeValue, getPrefix, getReadOnly, getUserData, getUserData, hasAttributes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setPrefix, setUserData, setUserData, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Document

adoptNode, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentURI, getDomConfig, getImplementation, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, normalizeDocument, renameNode, setDocumentURI, setStrictErrorChecking, setXmlStandalone, setXmlVersion

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

Constructor Detail

HTMLDocumentImpl

public HTMLDocumentImpl()

Method Detail

getDocumentElement

public Element getDocumentElement()

Description copied from class: CoreDocumentImpl

Convenience method, allowing direct access to the child node which is considered the root of the actual document content. For HTML, where it is legal to have more than one Element at the top level of the document, we pick the one with the tagName "HTML". For XML there should be only one top-level (HTML not yet supported.)

Specified by:

getDocumentElement in interface Document

Overrides:

getDocumentElement in class CoreDocumentImpl

getHead

public HTMLElement getHead()

Obtains the <HEAD> element in the document, creating one if does not exist before. The <HEAD> element is the first element in the <HTML> in the document. The <HTML> element is obtained by calling getDocumentElement(). If the element does not exist, one is created.

Called by getTitle(), setTitle(java.lang.String), getBody() and setBody(org.w3c.dom.html.HTMLElement) to assure the document has the <HEAD> element correctly placed.

Returns:

The <HEAD> element

getTitle

public java.lang.String getTitle()

Description copied from interface: HTMLDocument

The title of a document as specified by the TITLEelement in the head of the document.

Specified by:

getTitle in interface HTMLDocument

setTitle

public void setTitle(java.lang.String newTitle)

Specified by:

setTitle in interface HTMLDocument

getBody

public HTMLElement getBody()

Description copied from interface: HTMLDocument

The element that contains the content for the document. In documentswith BODY contents, returns the BODYelement, and in frameset documents, this returns the outermostFRAMESET element.

Specified by:

getBody in interface HTMLDocument

setBody

public void setBody(HTMLElement newBody)

Specified by:

setBody in interface HTMLDocument

getElementById

public Element getElementById(java.lang.String elementId)

Description copied from class: CoreDocumentImpl

Introduced in DOM Level 2 Returns the Element whose ID is given by elementId. If no such element exists, returns null. Behavior is not defined if more than one element has this ID.

Note: The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return null.

Specified by:

getElementById in interface Document

Specified by:

getElementById in interface HTMLDocument

Overrides:

getElementById in class CoreDocumentImpl

Parameters:

elementId - The unique id value for an element.

Returns:

The matching element or null if there is none.

See Also:

CoreDocumentImpl.getIdentifier(java.lang.String)

getElementsByName

public NodeList getElementsByName(java.lang.String elementName)

Description copied from interface: HTMLDocument

Returns the (possibly empty) collection of elements whosename value is given by elementName.

Specified by:

getElementsByName in interface HTMLDocument

Parameters:

elementName - The name attribute value for an element.

Returns:

The matching elements.

getElementsByTagName

public final NodeList getElementsByTagName(java.lang.String tagName)

Description copied from class: CoreDocumentImpl

Return a live collection of all descendent Elements (not just immediate children) having the specified tag name.

Specified by:

getElementsByTagName in interface Document

Overrides:

getElementsByTagName in class CoreDocumentImpl

Parameters:

tagName - The type of Element we want to gather. "*" will be taken as a wildcard, meaning "all elements in the document."

Returns:

A new NodeList object containing all the matched Elements.

See Also:

DeepNodeListImpl

getElementsByTagNameNS

public final NodeList getElementsByTagNameNS(java.lang.String namespaceURI,
                                             java.lang.String localName)

Description copied from class: CoreDocumentImpl

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.

Specified by:

getElementsByTagNameNS in interface Document

Overrides:

getElementsByTagNameNS in class CoreDocumentImpl

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.

createElementNS

public Element createElementNS(java.lang.String namespaceURI,
                               java.lang.String qualifiedName,
                               java.lang.String localpart)
                        throws DOMException

Xerces-specific constructor. "localName" is passed in, so we don't need to create a new String for it.

Overrides:

createElementNS in class CoreDocumentImpl

Parameters:

namespaceURI - The namespace URI of the element to create.

qualifiedName - The qualified name of the element type to instantiate.

localpart - The local name of the element to instantiate.

Returns:

Element A new Element object with the following attributes:

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.

createElementNS

public Element createElementNS(java.lang.String namespaceURI,
                               java.lang.String qualifiedName)

Description copied from class: CoreDocumentImpl

Introduced in DOM Level 2.

Creates an element of the given qualified name and namespace URI. If the given namespaceURI is null or an empty string and the qualifiedName has a prefix that is "xml", the created element is bound to the predefined namespace "http://www.w3.org/XML/1998/namespace" [Namespaces].

Specified by:

createElementNS in interface Document

Overrides:

createElementNS in class CoreDocumentImpl

Parameters:

namespaceURI - The namespace URI of the element to create.

qualifiedName - The qualified name of the element type to instantiate.

Returns:

Element A new Element object with the following attributes:

createElement

public Element createElement(java.lang.String tagName)
                      throws DOMException

Description copied from class: CoreDocumentImpl

Factory method; creates an Element having this Document as its OwnerDoc.

Specified by:

createElement in interface Document

Overrides:

createElement in class CoreDocumentImpl

Parameters:

tagName - The name of the element type to instantiate. For XML, this is case-sensitive. For HTML, the tagName parameter may be provided in any case, but it must be mapped to the canonical uppercase form by the DOM implementation.

Returns:

A new Element object with the nodeName attribute set to tagName, and localName, prefix, and namespaceURI set to null.

Throws:

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.

createAttribute

public Attr createAttribute(java.lang.String name)
                     throws DOMException

Creates an Attribute having this Document as its OwnerDoc. Overrides CoreDocumentImpl.createAttribute(java.lang.String) and returns and attribute whose name is lower case.

Specified by:

createAttribute in interface Document

Overrides:

createAttribute in class CoreDocumentImpl

Parameters:

name - The name of the attribute

Returns:

An attribute whose name is all lower case

Throws:

DOMException(INVALID_NAME_ERR) - if the attribute name is not acceptable

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.

getReferrer

public java.lang.String getReferrer()

Description copied from interface: HTMLDocument

Returns the URI of the page that linked to this page. The value isan empty string if the user navigated to the page directly (notthrough a link, but, for example, via a bookmark).

Specified by:

getReferrer in interface HTMLDocument

getDomain

public java.lang.String getDomain()

Description copied from interface: HTMLDocument

The domain name of the server that served the document, or a nullstring if the server cannot be identified by a domain name.

Specified by:

getDomain in interface HTMLDocument

getURL

public java.lang.String getURL()

Description copied from interface: HTMLDocument

The complete URI of the document.

Specified by:

getURL in interface HTMLDocument

getCookie

public java.lang.String getCookie()

Description copied from interface: HTMLDocument

The cookies associated with this document. If there are none, thevalue is an empty string. Otherwise, the value is a string: asemicolon-delimited list of "name, value" pairs for all the cookiesassociated with the page. For example, name=value;expires=date.

Specified by:

getCookie in interface HTMLDocument

setCookie

public void setCookie(java.lang.String cookie)

Specified by:

setCookie in interface HTMLDocument

getImages

public HTMLCollection getImages()

Description copied from interface: HTMLDocument

A collection of all the IMG elements in a document.The behavior is limited to IMG elements forbackwards compatibility.

Specified by:

getImages in interface HTMLDocument

getApplets

public HTMLCollection getApplets()

Description copied from interface: HTMLDocument

A collection of all the OBJECT elements that includeapplets and APPLET (deprecated) elements ina document.

Specified by:

getApplets in interface HTMLDocument

getLinks

public HTMLCollection getLinks()

Description copied from interface: HTMLDocument

A collection of all AREA elements andanchor (A) elements in a documentwith a value for the href attribute.

Specified by:

getLinks in interface HTMLDocument

getForms

public HTMLCollection getForms()

Description copied from interface: HTMLDocument

A collection of all the forms of a document.

Specified by:

getForms in interface HTMLDocument

getAnchors

public HTMLCollection getAnchors()

Description copied from interface: HTMLDocument

A collection of all the anchor (A) elements in a document with a value for the name attribute.Note. For reasons of backwardscompatibility, the returned set of anchors only contains those anchors created with the name attribute, not those created with the id attribute.

Specified by:

getAnchors in interface HTMLDocument

open

public void open()

Description copied from interface: HTMLDocument

Note.This method and the ones following allow a user to add to or replace the structuremodel of a document using strings of unparsed HTML. At the time of writing alternate methods for providing similar functionality for both HTML and XML documents were being considered. The following methodsmay be deprecated at some point in the future in favor of a more general-purpose mechanism.
Open a document stream for writing. If a document exists in the target, this method clears it.

Specified by:

open in interface HTMLDocument

close

public void close()

Description copied from interface: HTMLDocument

Closes a document stream opened by open()and forces rendering.

Specified by:

close in interface HTMLDocument

write

public void write(java.lang.String text)

Description copied from interface: HTMLDocument

Write a string of text to a document stream opened byopen(). The text is parsed into the document's structuremodel.

Specified by:

write in interface HTMLDocument

Parameters:

text - The string to be parsed into some structure in the document structuremodel.

writeln

public void writeln(java.lang.String text)

Description copied from interface: HTMLDocument

Write a string of text followed by a newline character to a document stream opened by open(). The text is parsed into the document's structure model.

Specified by:

writeln in interface HTMLDocument

Parameters:

text - The string to be parsed into some structure in the document structuremodel.

cloneNode

public Node cloneNode(boolean deep)

Description copied from class: DocumentImpl

Deep-clone a document, including fixing ownerDoc for the cloned children. Note that this requires bypassing the WRONG_DOCUMENT_ERR protection. I've chosen to implement it by calling importNode which is DOM Level 2.

Specified by:

cloneNode in interface Node

Overrides:

cloneNode in class DocumentImpl

Parameters:

deep - boolean, iff true replicate children

Returns:

org.w3c.dom.Node

See Also:

Example: Cloning a Text node will copy both the node and the text it contains.

Example: Cloning something that has children -- Element or Attr, for example -- will _not_ clone those children unless a "deep clone" has been requested. A shallow clone of an Attr node will yield an empty Attr of the same name.

NOTE: Clones will always be read/write, even if the node being cloned is read-only, to permit applications using only the DOM API to obtain editable copies of locked portions of the tree.