HTMLDocument (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.w3c.dom.html
interface HTMLDocument

All Superinterfaces:: Document, Node

public interface HTMLDocument
extends Document

An HTMLDocument is the root of the HTML hierarchy and holds the entire content. Besides providing access to the hierarchy, it also provides some convenience methods for accessing certain sets of information from the document.

The following properties have been deprecated in favor of the corresponding ones for the BODY element: alinkColor background bgColor fgColor linkColor vlinkColor In DOM Level 2, the method getElementById is inherited from the Document interface where it was moved.

Field Summary

Fields inherited from class 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`

Fields inherited from class 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
`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.
`String`	`getCookie()` The cookies associated with this document.
`String`	`getDomain()` The domain name of the server that served the document, or `null` if the server cannot be identified by a domain name.
`NodeList`	`getElementsByName(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.
`String`	`getReferrer()` Returns the URI of the page that linked to this page.
`String`	`getTitle()` The title of a document as specified by the `TITLE` element in the head of the document.
`String`	`getURL()` The complete URI of the document.
`void`	`open()` Note.
`void`	`setBody(HTMLElement body)`
`void`	`setCookie(String cookie)`
`void`	`setTitle(String title)`
`void`	`write(String text)` Write a string of text to a document stream opened by `open()` .
`void`	`writeln(String text)` Write a string of text followed by a newline character to a document stream opened by `open()` .

Methods inherited from class org.w3c.dom.Document
adoptNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, normalizeDocument, renameNode, setDocumentURI, setStrictErrorChecking, setXmlStandalone, setXmlVersion

Methods inherited from class org.w3c.dom.Document


adoptNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, normalizeDocument, renameNode, setDocumentURI, setStrictErrorChecking, setXmlStandalone, setXmlVersion

Methods inherited from class org.w3c.dom.Node
appendChild, cloneNode, 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

Methods inherited from class org.w3c.dom.Node


appendChild, cloneNode, 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

close

public void close()

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

getAnchors

public HTMLCollection getAnchors()

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.

getApplets

public HTMLCollection getApplets()

A collection of all the OBJECT elements that include applets and APPLET ( deprecated ) elements in a document.

getBody

public HTMLElement getBody()

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.

getCookie

public String getCookie()

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 .

getDomain

public String getDomain()

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

getElementsByName

public NodeList getElementsByName(String elementName)

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

Parameters:: elementName - The name attribute value for an element.
Returns:: The matching elements.

getForms

public HTMLCollection getForms()

A collection of all the forms of a document.

getImages

public HTMLCollection getImages()

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

getLinks

public HTMLCollection getLinks()

A collection of all AREA elements and anchor ( A ) elements in a document with a value for the href attribute.

getReferrer

public String getReferrer()

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).

getTitle

public String getTitle()

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

getURL

public String getURL()

The complete URI of the document.

open

public void open()

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.

setBody

public void setBody(HTMLElement body)

Parameters:: body

setCookie

public void setCookie(String cookie)

Parameters:: cookie

setTitle

public void setTitle(String title)

Parameters:: title

write

public void write(String text)

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

Parameters:: text - The string to be parsed into some structure in the document structure model.

writeln

public void writeln(String text)

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.

Parameters:: text - The string to be parsed into some structure in the document structure model.