HTMLDocumentImpl (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- org.openxml.dom.NodeImpl
- - org.openxml.dom.ParentNodeImpl
  - - org.openxml.dom.DocumentImpl
    - - org.openxml.dom.html.HTMLDocumentImpl

All Implemented Interfaces:

Cloneable, Document, org.w3c.dom.html.HTMLDocument, Node
```
public final 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) 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()).

Author:

Assaf Arkin

See Also:

HTMLDocument

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

Constructor Summary

Constructors
Constructor and Description

HTMLDocumentImpl()

Constructors
Constructor and Description
`HTMLDocumentImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
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)`
`void`	`close()`
`Element`	`createElement(String tagName)`
`Element`	`createElementNS(String namespaceURI, String qualifiedName)`
`org.w3c.dom.html.HTMLCollection`	`getAnchors()`
`org.w3c.dom.html.HTMLCollection`	`getApplets()`
`org.w3c.dom.html.HTMLElement`	`getBody()`
`String`	`getCookie()`
`Element`	`getDocumentElement()`
`String`	`getDomain()`
`Element`	`getElementById(String elementId)`
`NodeList`	`getElementsByName(String elementName)`
`NodeList`	`getElementsByTagName(String tagName)`
`NodeList`	`getElementsByTagNameNS(String namespaceURI, String localName)`
`org.w3c.dom.html.HTMLCollection`	`getForms()`
`org.w3c.dom.html.HTMLElement`	`getHead()` Obtains the <HEAD> element in the document, creating one if does not exist before.
`org.w3c.dom.html.HTMLCollection`	`getImages()`
`org.w3c.dom.html.HTMLCollection`	`getLinks()`
`String`	`getReferrer()`
`String`	`getTitle()`
`String`	`getURL()`
`void`	`open()`
`void`	`setBody(org.w3c.dom.html.HTMLElement newBody)`
`void`	`setCookie(String cookie)`
`void`	`setTitle(String newTitle)`
`void`	`write(String text)`
`void`	`writeln(String text)`

Methods inherited from class org.openxml.dom.DocumentImpl
acquire, adoptNode, cloneInto, compareDocumentPosition, createAttribute, createAttribute, createAttributeNS, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createEntityReference, createNodeIterator, createProcessingInstruction, createTextNode, equals, getBaseURI, getDoctype, getDocumentURI, getDomConfig, getEncoding, getFeature, getImplementation, getInputEncoding, getNamespaceURI, getNodeType, getStandalone, getStrictErrorChecking, getTextContent, getUserData, getVersion, getXmlEncoding, getXmlStandalone, getXmlVersion, hasAttributes, importNode, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lock, lookupNamespaceURI, lookupPrefix, normalizeDocument, registerElement, renameNode, setDocumentURI, setEncoding, setNodeValue, setStandalone, setStrictErrorChecking, setTextContent, setUserData, setVersion, setXmlStandalone, setXmlVersion, toString, unlock, useElementFactory

Methods inherited from class org.openxml.dom.ParentNodeImpl
appendChild, castOldChild, createNodeIterator, getChildNodes, getFirstChild, getLastChild, hasChildNodes, insertBefore, normalize, removeChild, removeInnerIterator, replaceChild

Methods inherited from class org.openxml.dom.NodeImpl
getAttributes, getLocalName, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, isReadOnly, makeReadOnly, setOwnerDocument, setPrefix, supports

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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()
```
    Specified by:
    
    getDocumentElement in interface Document
    
    Overrides:
    
    getDocumentElement in class DocumentImpl
  - 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 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 String getTitle()
```
    Specified by:
    
    getTitle in interface org.w3c.dom.html.HTMLDocument
  - setTitle
```
public void setTitle(String newTitle)
```
    Specified by:
    
    setTitle in interface org.w3c.dom.html.HTMLDocument
  - getBody
```
public org.w3c.dom.html.HTMLElement getBody()
```
    Specified by:
    
    getBody in interface org.w3c.dom.html.HTMLDocument
  - setBody
```
public void setBody(org.w3c.dom.html.HTMLElement newBody)
```
    Specified by:
    
    setBody in interface org.w3c.dom.html.HTMLDocument
  - getElementById
```
public Element getElementById(String elementId)
```
    Specified by:
    
    getElementById in interface Document
    
    Overrides:
    
    getElementById in class DocumentImpl
  - getElementsByName
```
public NodeList getElementsByName(String elementName)
```
    Specified by:
    
    getElementsByName in interface org.w3c.dom.html.HTMLDocument
  - getElementsByTagName
```
public final NodeList getElementsByTagName(String tagName)
```
    Specified by:
    
    getElementsByTagName in interface Document
    
    Overrides:
    
    getElementsByTagName in class DocumentImpl
  - getElementsByTagNameNS
```
public final NodeList getElementsByTagNameNS(String namespaceURI,
                                             String localName)
```
    Specified by:
    
    getElementsByTagNameNS in interface Document
    
    Overrides:
    
    getElementsByTagNameNS in class DocumentImpl
  - createElementNS
```
public Element createElementNS(String namespaceURI,
                               String qualifiedName)
```
    Specified by:
    
    createElementNS in interface Document
    
    Overrides:
    
    createElementNS in class DocumentImpl
  - createElement
```
public Element createElement(String tagName)
                      throws DOMException
```
    Specified by:
    
    createElement in interface Document
    
    Overrides:
    
    createElement in class DocumentImpl
    
    Throws:
    
    DOMException
  - getReferrer
```
public String getReferrer()
```
    Specified by:
    
    getReferrer in interface org.w3c.dom.html.HTMLDocument
  - getDomain
```
public String getDomain()
```
    Specified by:
    
    getDomain in interface org.w3c.dom.html.HTMLDocument
  - getURL
```
public String getURL()
```
    Specified by:
    
    getURL in interface org.w3c.dom.html.HTMLDocument
  - getCookie
```
public String getCookie()
```
    Specified by:
    
    getCookie in interface org.w3c.dom.html.HTMLDocument
  - setCookie
```
public void setCookie(String cookie)
```
    Specified by:
    
    setCookie in interface org.w3c.dom.html.HTMLDocument
  - getImages
```
public org.w3c.dom.html.HTMLCollection getImages()
```
    Specified by:
    
    getImages in interface org.w3c.dom.html.HTMLDocument
  - getApplets
```
public org.w3c.dom.html.HTMLCollection getApplets()
```
    Specified by:
    
    getApplets in interface org.w3c.dom.html.HTMLDocument
  - getLinks
```
public org.w3c.dom.html.HTMLCollection getLinks()
```
    Specified by:
    
    getLinks in interface org.w3c.dom.html.HTMLDocument
  - getForms
```
public org.w3c.dom.html.HTMLCollection getForms()
```
    Specified by:
    
    getForms in interface org.w3c.dom.html.HTMLDocument
  - getAnchors
```
public org.w3c.dom.html.HTMLCollection getAnchors()
```
    Specified by:
    
    getAnchors in interface org.w3c.dom.html.HTMLDocument
  - open
```
public void open()
```
    Specified by:
    
    open in interface org.w3c.dom.html.HTMLDocument
  - close
```
public void close()
```
    Specified by:
    
    close in interface org.w3c.dom.html.HTMLDocument
  - write
```
public void write(String text)
```
    Specified by:
    
    write in interface org.w3c.dom.html.HTMLDocument
  - writeln
```
public void writeln(String text)
```
    Specified by:
    
    writeln in interface org.w3c.dom.html.HTMLDocument
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class DocumentImpl
  - cloneNode
```
public Node cloneNode(boolean deep)
```
    Specified by:
    
    cloneNode in interface Node
    
    Overrides:
    
    cloneNode in class DocumentImpl
  - 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

Class HTMLDocumentImpl

Field Summary

Fields inherited from class org.openxml.dom.NodeImpl

Fields inherited from interface org.w3c.dom.Node

Constructor Summary

Method Summary

Methods inherited from class org.openxml.dom.DocumentImpl

Methods inherited from class org.openxml.dom.ParentNodeImpl

Methods inherited from class org.openxml.dom.NodeImpl

Methods inherited from class java.lang.Object

Methods inherited from interface org.w3c.dom.Document

Methods inherited from interface org.w3c.dom.Node

Constructor Detail

HTMLDocumentImpl

Method Detail

getDocumentElement

getHead

getTitle

setTitle

getBody

setBody

getElementById

getElementsByName

getElementsByTagName

getElementsByTagNameNS

createElementNS

createElement

getReferrer

getDomain

getURL

getCookie

setCookie

getImages

getApplets

getLinks

getForms

getAnchors

open

close

write

writeln

clone

cloneNode

castNewChild