Enhydra 5.1 API

org.enhydra.xml.xmlc.html
Class HTMLObjectImpl

java.lang.Object
  |
  +--org.enhydra.xml.xmlc.XMLObjectImpl
        |
        +--org.enhydra.xml.xmlc.html.HTMLObjectImpl
All Implemented Interfaces:
Document, DocumentInfo, HTMLDocument, HTMLObject, Node, XMLObject
Direct Known Subclasses:
HTMLObject

public abstract class HTMLObjectImpl
extends XMLObjectImpl
implements HTMLObject

Abstract class that forms the base of all compiled HTML Objects.


Field Summary
 
Fields inherited from interface org.enhydra.xml.xmlc.XMLObject
XMLC_GENERATED_CLASS_FIELD_NAME, XMLC_SOURCE_FILE_FIELD_NAME
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
protected HTMLObjectImpl()
          Constructor.
 
Method Summary
abstract  Node cloneNode(boolean deep)
          Clone the entire document.
 void close()
          Closes a document stream opened by open() and forces rendering.
 HTMLCollection getAnchors()
          A collection of all the anchor (A ) elements in a document with a value for the name attribute.
 HTMLCollection getApplets()
          A collection of all the OBJECT elements that include applets and APPLET ( deprecated ) elements in a document.
 HTMLElement getBody()
          The element that contains the content for the document.
 java.lang.String getCookie()
          The cookies associated with this document.
 java.lang.String getDomain()
          The domain name of the server that served the document, or null if the server cannot be identified by a domain name.
 Element getElementById(java.lang.String elementId)
          Returns the Element whose ID is given by elementId.
 NodeList getElementsByName(java.lang.String elementName)
          Returns the (possibly empty) collection of elements whose name value is given by elementName .
 HTMLCollection getForms()
          A collection of all the forms of a document.
 HTMLCollection getImages()
          A collection of all the IMG elements in a document.
 HTMLCollection getLinks()
          A collection of all AREA elements and anchor ( A ) elements in a document with 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 TITLE element in the head of the document.
 java.lang.String getURL()
          The complete URI of the document.
 void open()
          Note.
 void setBody(HTMLElement body)
           
 void setCookie(java.lang.String cookie)
           
 void setTitle(java.lang.String title)
           
 java.lang.String toDocument()
          Convert the document to a string representation of the document, that is a string containing HTML.
 void write(java.lang.String text)
          Write a string of text to a document stream opened by open() .
 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.enhydra.xml.xmlc.XMLObjectImpl
adoptNode, appendChild, cloneDeepCheck, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, doSetText, getAttributes, getChildNodes, getDelegate, getDoctype, getDocument, getDocumentElement, getDomFactory, getElementsByTagName, getElementsByTagNameNS, getEncoding, getFirstChild, getImplementation, getLastChild, getLocalName, getMIMEType, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getStandalone, getStrictErrorChecking, getVersion, hasAttributes, hasChildNodes, importNode, initFields, insertBefore, isSupported, isURLAttribute, normalize, removeChild, replaceChild, setDelegate, setDocument, setEncoding, setNodeValue, setPrefix, setStandalone, setStrictErrorChecking, setVersion, syncAccessMethods, syncWithDocument
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.enhydra.xml.xmlc.XMLObject
adoptNode, buildDocument, getDelegate, getDocument, getEncoding, getMIMEType, getStandalone, getStrictErrorChecking, getVersion, setDelegate, setEncoding, setStandalone, setStrictErrorChecking, setVersion, syncAccessMethods
 
Methods inherited from interface org.w3c.dom.Document
createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getElementsByTagName, getElementsByTagNameNS, getImplementation, importNode
 
Methods inherited from interface org.w3c.dom.Node
appendChild, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 
Methods inherited from interface org.enhydra.xml.io.DocumentInfo
isURLAttribute
 

Constructor Detail

HTMLObjectImpl

protected HTMLObjectImpl()
Constructor. The setDocument() method must be called to associate a document with this object.

Method Detail

cloneNode

public abstract Node cloneNode(boolean deep)
Clone the entire document. Derived objects should override this to get the correct derived type. Cloning with deep being false is not allowed.

Specified by:
cloneNode in interface Node
Specified by:
cloneNode in class XMLObjectImpl
Returns:
The duplicate node.
See Also:
Node.cloneNode(boolean)

toDocument

public java.lang.String toDocument()
Description copied from interface: HTMLObject
Convert the document to a string representation of the document, that is a string containing HTML. The results are parsable into the same DOM hierarchy

Specified by:
toDocument in interface HTMLObject
Overrides:
toDocument in class XMLObjectImpl
Returns:
A string containing the full HTML.
See Also:
HTMLObject.toDocument()

getTitle

public java.lang.String getTitle()
Description copied from interface: HTMLDocument
The title of a document as specified by the TITLE element in the head of the document.

Specified by:
getTitle in interface HTMLDocument
See Also:
HTMLDocument.getTitle()

setTitle

public void setTitle(java.lang.String title)
Specified by:
setTitle in interface HTMLDocument
See Also:
HTMLDocument.setTitle(java.lang.String)

getReferrer

public java.lang.String getReferrer()
Description copied from interface: HTMLDocument
Returns the URI of the page that linked to this page. The value is an empty string if the user navigated to the page directly (not through a link, but, for example, via a bookmark).

Specified by:
getReferrer in interface HTMLDocument
See Also:
HTMLDocument.getReferrer()

getDomain

public java.lang.String getDomain()
Description copied from interface: HTMLDocument
The domain name of the server that served the document, or null if the server cannot be identified by a domain name.

Specified by:
getDomain in interface HTMLDocument
See Also:
HTMLDocument.getDomain()

getURL

public java.lang.String getURL()
Description copied from interface: HTMLDocument
The complete URI of the document.

Specified by:
getURL in interface HTMLDocument
See Also:
HTMLDocument

getBody

public HTMLElement getBody()
Description copied from interface: HTMLDocument
The element that contains the content for the document. In documents with BODY contents, returns the BODY element. In frameset documents, this returns the outermost FRAMESET element.

Specified by:
getBody in interface HTMLDocument
See Also:
HTMLDocument

setBody

public void setBody(HTMLElement body)
Specified by:
setBody in interface HTMLDocument
See Also:
HTMLDocument.setBody(org.w3c.dom.html.HTMLElement)

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 for backwards compatibility.

Specified by:
getImages in interface HTMLDocument
See Also:
HTMLDocument.getImages()

getApplets

public HTMLCollection getApplets()
Description copied from interface: HTMLDocument
A collection of all the OBJECT elements that include applets and APPLET ( deprecated ) elements in a document.

Specified by:
getApplets in interface HTMLDocument
See Also:
HTMLDocument

getLinks

public HTMLCollection getLinks()
Description copied from interface: HTMLDocument
A collection of all AREA elements and anchor ( A ) elements in a document with a value for the href attribute.

Specified by:
getLinks in interface HTMLDocument
See Also:
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
See Also:
HTMLDocument.getForms()

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 backwards compatibility, 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
See Also:
HTMLDocument.getAnchors()

getCookie

public java.lang.String getCookie()
Description copied from interface: HTMLDocument
The cookies associated with this document. If there are none, the value is an empty string. Otherwise, the value is a string: a semicolon-delimited list of "name, value" pairs for all the cookies associated with the page. For example, name=value;expires=date .

Specified by:
getCookie in interface HTMLDocument
See Also:
HTMLDocument.getCookie()

setCookie

public void setCookie(java.lang.String cookie)
Specified by:
setCookie in interface HTMLDocument
See Also:
HTMLDocument.setCookie(java.lang.String)

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 structure model 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 methods may 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
See Also:
HTMLDocument.open()

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
See Also:
HTMLDocument.close()

write

public void write(java.lang.String text)
Description copied from interface: HTMLDocument
Write a string of text to a document stream opened by open() . The text is parsed into the document's structure model.

Specified by:
write in interface HTMLDocument
Parameters:
text - The string to be parsed into some structure in the document structure model.
See Also:
HTMLDocument.write(java.lang.String)

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 structure model.
See Also:
HTMLDocument.writeln(java.lang.String)

getElementById

public Element getElementById(java.lang.String elementId)
Description copied from interface: Document
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. 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
Overrides:
getElementById in class XMLObjectImpl
Returns:
The matching element.
See Also:
Document.getElementById(java.lang.String)

getElementsByName

public NodeList getElementsByName(java.lang.String elementName)
Description copied from interface: HTMLDocument
Returns the (possibly empty) collection of elements whose name value is given by elementName .

Specified by:
getElementsByName in interface HTMLDocument
Parameters:
elementName - The name attribute value for an element.
Returns:
The matching elements.
See Also:
HTMLDocument.getElementsByName(java.lang.String)

Enhydra 5.1 API