Class HTMLDocumentImpl
-
- All Implemented Interfaces:
Cloneable,Document,DocumentEvent,EventTarget,org.w3c.dom.html.HTMLDocument,Node,NodeList
public class HTMLDocumentImpl extends DocumentImpl implements org.w3c.dom.html.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)orNode.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()).- Author:
- Assaf Arkin
- See Also:
HTMLDocument
-
-
Field Summary
-
Fields inherited from class org.htmlunit.cyberneko.xerces.dom.CoreDocumentImpl
changes, errorChecking
-
Fields inherited from class org.htmlunit.cyberneko.xerces.dom.ParentNode
firstChild, fNodeListCache, ownerDocument
-
Fields inherited from class org.htmlunit.cyberneko.xerces.dom.ChildNode
nextSibling_, previousSibling_
-
Fields inherited from class org.htmlunit.cyberneko.xerces.dom.NodeImpl
DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, FIRSTCHILD, HASSTRING, ID, NORMALIZED, OWNED, ownerNode_, READONLY, SPECIFIED, SYNCCHILDREN
-
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
Constructors Constructor Description HTMLDocumentImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleancanRenameElements(String newNamespaceURI, String newNodeName, ElementImpl el)NodecloneNode(boolean deep)Deep-clone a document, including fixing ownerDoc for the cloned children.voidclose()AttrcreateAttribute(String name)Creates an Attribute having this Document as its OwnerDoc.ElementcreateElement(String tagName)Factory method; creates an Element having this Document as its OwnerDoc.ElementcreateElementNS(String namespaceURI, String qualifiedname)Introduced in DOM Level 2.ElementcreateElementNS(String namespaceURI, String qualifiedName, String localpart)Xerces-specific constructor.org.w3c.dom.html.HTMLCollectiongetAnchors()org.w3c.dom.html.HTMLCollectiongetApplets()org.w3c.dom.html.HTMLElementgetBody()StringgetCookie()ElementgetDocumentElement()Convenience method, allowing direct access to the child node which is considered the root of the actual document content.StringgetDomain()ElementgetElementById(String elementId)Introduced in DOM Level 2 Returns the Element whose ID is given by elementId.NodeListgetElementsByName(String elementname)NodeListgetElementsByTagName(String tagName)Return a live collection of all descendant Elements (not just immediate children) having the specified tag name.NodeListgetElementsByTagNameNS(String namespaceURI, String localName)Introduced in DOM Level 2.org.w3c.dom.html.HTMLCollectiongetForms()org.w3c.dom.html.HTMLElementgetHead()Obtains the <HEAD> element in the document, creating one if does not exist before.org.w3c.dom.html.HTMLCollectiongetImages()org.w3c.dom.html.HTMLCollectiongetLinks()StringgetReferrer()StringgetTitle()StringgetURL()voidopen()voidsetBody(org.w3c.dom.html.HTMLElement newBody)voidsetCookie(String cookie)voidsetTitle(String newTitle)voidwrite(String text)voidwriteln(String text)-
Methods inherited from class org.htmlunit.cyberneko.xerces.dom.DocumentImpl
createEvent, getImplementation
-
Methods inherited from class org.htmlunit.cyberneko.xerces.dom.CoreDocumentImpl
addEventListener, adoptNode, changed, changes, checkDOMNSErr, checkNamespaceWF, checkQName, clearIdentifiers, clone, cloneNode, copyEventListeners, createAttributeNS, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createDocumentType, createEntity, createEntityReference, createProcessingInstruction, createTextNode, getBaseURI, getDoctype, getDocumentURI, getDomConfig, getErrorChecking, getIdentifier, getInputEncoding, getNodeName, getNodeNumber, getNodeNumber, getNodeType, getOwnerDocument, getStrictErrorChecking, getTextContent, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, insertBefore, isKidOK, isValidQName, isXMLName, normalizeDocument, putIdentifier, removeChild, removeEventListener, removeIdentifier, renameNode, replaceChild, setDocumentURI, setErrorChecking, setInputEncoding, setStrictErrorChecking, setTextContent, setXmlEncoding, setXmlStandalone, setXmlVersion
-
Methods inherited from class org.htmlunit.cyberneko.xerces.dom.ParentNode
getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, hasChildNodes, isEqualNode, item, setOwnerDocument, synchronizeChildren
-
Methods inherited from class org.htmlunit.cyberneko.xerces.dom.ChildNode
getNextSibling, getParentNode, getPreviousSibling
-
Methods inherited from class org.htmlunit.cyberneko.xerces.dom.NodeImpl
addEventListener, appendChild, compareDocumentPosition, dispatchEvent, getAttributes, getFeature, getLocalName, getNamespaceURI, getNodeValue, getPrefix, getUserData, hasAttributes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, normalize, removeEventListener, setNodeValue, setPrefix, setUserData, toString
-
Methods inherited from class java.lang.Object
equals, finalize, 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
-
-
-
-
Method Detail
-
getDocumentElement
public Element getDocumentElement()
Description copied from class:CoreDocumentImplConvenience 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:
getDocumentElementin interfaceDocument- Overrides:
getDocumentElementin classCoreDocumentImpl
-
getHead
public org.w3c.dom.html.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 callinggetDocumentElement(). If the element does not exist, one is created.Called by
getTitle(),setTitle(java.lang.String),getBody()andsetBody(org.w3c.dom.html.HTMLElement)to assure the document has the <HEAD> element correctly placed.- Returns:
- The <HEAD> element
-
getTitle
public String getTitle()
- Specified by:
getTitlein interfaceorg.w3c.dom.html.HTMLDocument
-
setTitle
public void setTitle(String newTitle)
- Specified by:
setTitlein interfaceorg.w3c.dom.html.HTMLDocument
-
getBody
public org.w3c.dom.html.HTMLElement getBody()
- Specified by:
getBodyin interfaceorg.w3c.dom.html.HTMLDocument
-
setBody
public void setBody(org.w3c.dom.html.HTMLElement newBody)
- Specified by:
setBodyin interfaceorg.w3c.dom.html.HTMLDocument
-
getElementById
public Element getElementById(String elementId)
Description copied from class:CoreDocumentImplIntroduced 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:
getElementByIdin interfaceDocument- Overrides:
getElementByIdin classCoreDocumentImpl- See Also:
CoreDocumentImpl.getIdentifier(java.lang.String)
-
getElementsByName
public NodeList getElementsByName(String elementname)
- Specified by:
getElementsByNamein interfaceorg.w3c.dom.html.HTMLDocument
-
getElementsByTagName
public final NodeList getElementsByTagName(String tagName)
Description copied from class:CoreDocumentImplReturn a live collection of all descendant Elements (not just immediate children) having the specified tag name.- Specified by:
getElementsByTagNamein interfaceDocument- Overrides:
getElementsByTagNamein classCoreDocumentImpl- Parameters:
tagName- The type of Element we want to gather. "*" will be taken as a wildcard, meaning "all elements in the document."- See Also:
DeepNodeListImpl
-
getElementsByTagNameNS
public final NodeList getElementsByTagNameNS(String namespaceURI, String localName)
Description copied from class:CoreDocumentImplIntroduced 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:
getElementsByTagNameNSin interfaceDocument- Overrides:
getElementsByTagNameNSin classCoreDocumentImpl- 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(String namespaceURI, String qualifiedName, String localpart) throws DOMException
Xerces-specific constructor. "localName" is passed in, so we don't need to create a new String for it.- Overrides:
createElementNSin classCoreDocumentImpl- 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(String namespaceURI, String qualifiedname)
Description copied from class:CoreDocumentImplIntroduced 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:
createElementNSin interfaceDocument- Overrides:
createElementNSin classCoreDocumentImpl- 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(String tagName) throws DOMException
Description copied from class:CoreDocumentImplFactory method; creates an Element having this Document as its OwnerDoc.- Specified by:
createElementin interfaceDocument- Overrides:
createElementin classCoreDocumentImpl- 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.- Throws:
DOMException- INVALID_NAME_ERR if the tag name is not acceptable.
-
createAttribute
public Attr createAttribute(String name) throws DOMException
Creates an Attribute having this Document as its OwnerDoc. OverridesCoreDocumentImpl.createAttribute(java.lang.String)and returns and attribute whose name is lower case.- Specified by:
createAttributein interfaceDocument- Overrides:
createAttributein classCoreDocumentImpl- 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
-
getReferrer
public String getReferrer()
- Specified by:
getReferrerin interfaceorg.w3c.dom.html.HTMLDocument
-
getDomain
public String getDomain()
- Specified by:
getDomainin interfaceorg.w3c.dom.html.HTMLDocument
-
getURL
public String getURL()
- Specified by:
getURLin interfaceorg.w3c.dom.html.HTMLDocument
-
getCookie
public String getCookie()
- Specified by:
getCookiein interfaceorg.w3c.dom.html.HTMLDocument
-
setCookie
public void setCookie(String cookie)
- Specified by:
setCookiein interfaceorg.w3c.dom.html.HTMLDocument
-
getImages
public org.w3c.dom.html.HTMLCollection getImages()
- Specified by:
getImagesin interfaceorg.w3c.dom.html.HTMLDocument
-
getApplets
public org.w3c.dom.html.HTMLCollection getApplets()
- Specified by:
getAppletsin interfaceorg.w3c.dom.html.HTMLDocument
-
getLinks
public org.w3c.dom.html.HTMLCollection getLinks()
- Specified by:
getLinksin interfaceorg.w3c.dom.html.HTMLDocument
-
getForms
public org.w3c.dom.html.HTMLCollection getForms()
- Specified by:
getFormsin interfaceorg.w3c.dom.html.HTMLDocument
-
getAnchors
public org.w3c.dom.html.HTMLCollection getAnchors()
- Specified by:
getAnchorsin interfaceorg.w3c.dom.html.HTMLDocument
-
open
public void open()
- Specified by:
openin interfaceorg.w3c.dom.html.HTMLDocument
-
close
public void close()
- Specified by:
closein interfaceorg.w3c.dom.html.HTMLDocument
-
write
public void write(String text)
- Specified by:
writein interfaceorg.w3c.dom.html.HTMLDocument
-
writeln
public void writeln(String text)
- Specified by:
writelnin interfaceorg.w3c.dom.html.HTMLDocument
-
cloneNode
public Node cloneNode(boolean deep)
Description copied from class:DocumentImplDeep-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. 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:
cloneNodein interfaceNode- Overrides:
cloneNodein classDocumentImpl- 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.
-
canRenameElements
protected boolean canRenameElements(String newNamespaceURI, String newNodeName, ElementImpl el)
- Overrides:
canRenameElementsin classCoreDocumentImpl
-
-