APIdia Launch Partner
Top Description Methods
org.w3c.dom.html

public Interface HTMLDocument

extends Document
Imports
org.w3c.dom.Document, .NodeList
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.

See also the Document Object Model (DOM) Level 2 Specification.

Since
1.4, DOM Level 2

Method Summary

Modifier and TypeMethod and Description
public void
close()

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

public HTMLCollection
getAnchors()

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

public HTMLCollection
getApplets()

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

public HTMLElement
getBody()

The element that contains the content for the document.

public String
getCookie()

The cookies associated with this document.

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.

public NodeList

Returns:

The matching elements.
getElementsByName(String
The name attribute value for an element.
elementName)

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

public HTMLCollection
getForms()

A collection of all the forms of a document.

public HTMLCollection
getImages()

A collection of all the IMG elements in a document.

public String
getReferrer()

Returns the URI of the page that linked to this page.

public String
getTitle()

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

public String
getURL()

The complete URI of the document.

public void
open()

Note.

public void
setBody(HTMLElement body)

public void
setCookie(String cookie)

public void
setTitle(String title)

public void
write(String
The string to be parsed into some structure in the document structure model.
text)

Write a string of text to a document stream opened by open() .

public void
writeln(String
The string to be parsed into some structure in the document structure model.
text)

Write a string of text followed by a newline character to a document stream opened by open() .

Inherited from org.w3c.dom.Document:
adoptNodecreateAttributecreateAttributeNScreateCDATASectioncreateCommentcreateDocumentFragmentcreateElementcreateElementNScreateEntityReferencecreateProcessingInstructioncreateTextNodegetDoctypegetDocumentElementgetDocumentURIgetDomConfiggetElementByIdgetElementsByTagNamegetElementsByTagNameNSgetImplementationgetInputEncodinggetStrictErrorCheckinggetXmlEncodinggetXmlStandalonegetXmlVersionimportNodenormalizeDocumentrenameNodesetDocumentURIsetStrictErrorCheckingsetXmlStandalonesetXmlVersion

Method Detail

closeback to summary
public void close()

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

getAnchorsback to summary
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.

getAppletsback to summary
public HTMLCollection getApplets()

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

getBodyback to summary
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.

getCookieback to summary
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 .

getDomainback to summary
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.

getElementsByNameback to summary
public NodeList getElementsByName(String elementName)

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

Parameters
elementName:String

The name attribute value for an element.

Returns:NodeList

The matching elements.

getFormsback to summary
public HTMLCollection getForms()

A collection of all the forms of a document.

getImagesback to summary
public HTMLCollection getImages()

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

getLinksback to summary
public HTMLCollection getLinks()

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

getReferrerback to summary
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).

getTitleback to summary
public String getTitle()

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

getURLback to summary
public String getURL()

The complete URI of the document.

openback to summary
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.

setBodyback to summary
public void setBody(HTMLElement body)
setCookieback to summary
public void setCookie(String cookie)
setTitleback to summary
public void setTitle(String title)
writeback to summary
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:String

The string to be parsed into some structure in the document structure model.

writelnback to summary
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:String

The string to be parsed into some structure in the document structure model.