All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface org.w3c.dom.html.HTMLDocument

public interface HTMLDocument
extends Document
An HTMLDocument is the root of the HTML hierarchy andholds the entire content. Beside providing access to the hierarchy, italso provides some convenience methods for accessing certain sets ofinformation from the document.

The following properties have been deprecated in favor of the corresponding ones for the BODY element:alinkColorbackgroundbgColorfgColor linkColorvlinkColor

Method Index

o close()
Closes a document stream opened by open()and forces rendering.
o getAnchors()
A collection of all the anchor (A) elements in a document with a value for the name attribute.Note.
o getApplets()
A collection of all the OBJECT elements that includeapplets and APPLET (deprecated) elements ina document.
o getBody()
The element that contains the content for the document.
o getCookie()
The cookies associated with this document.
o getDomain()
The domain name of the server that served the document, or a nullstring if the server cannot be identified by a domain name.
o getElementById(String)
Returns the Element whose id is given by elementId.
o getElementsByName(String)
Returns the (possibly empty) collection of elements whosename value is given by elementName.
o getForms()
A collection of all the forms of a document.
o getImages()
A collection of all the IMG elements in a document.The behavior is limited to IMG elements forbackwards compatibility.
o getLinks()
A collection of all AREA elements andanchor (A) elements in a documentwith a value for the href attribute.
o getReferrer()
Returns the URI of the page that linked to this page.
o getTitle()
The title of a document as specified by the TITLEelement in the head of the document.
o getURL()
The complete URI of the document.
o open()
Note.This method and the ones following allow a user to add to or replace the structuremodel of a document using strings of unparsed HTML.
o setBody(HTMLElement)
o setCookie(String)
o setTitle(String)
o write(String)
Write a string of text to a document stream opened byopen().
o writeln(String)
Write a string of text followed by a newline character to a document stream opened by open().

Methods

o getTitle 
 public abstract String getTitle()
The title of a document as specified by the TITLEelement in the head of the document.

o setTitle 
 public abstract void setTitle(String title)
o getReferrer 
 public abstract String getReferrer()
Returns the URI of the page that linked to this page. The value isan empty string if the user navigated to the page directly (notthrough a link, but, for example, via a bookmark).

o getDomain 
 public abstract String getDomain()
The domain name of the server that served the document, or a nullstring if the server cannot be identified by a domain name.

o getURL 
 public abstract String getURL()
The complete URI of the document.

o getBody 
 public abstract HTMLElement getBody()
The element that contains the content for the document. In documentswith BODY contents, returns the BODYelement, and in frameset documents, this returns the outermostFRAMESET element.

o setBody 
 public abstract void setBody(HTMLElement body)
o getImages 
 public abstract HTMLCollection getImages()
A collection of all the IMG elements in a document.The behavior is limited to IMG elements forbackwards compatibility.

o getApplets 
 public abstract HTMLCollection getApplets()
A collection of all the OBJECT elements that includeapplets and APPLET (deprecated) elements ina document.

o getLinks 
 public abstract HTMLCollection getLinks()
A collection of all AREA elements andanchor (A) elements in a documentwith a value for the href attribute.

o getForms 
 public abstract HTMLCollection getForms()
A collection of all the forms of a document.

o getAnchors 
 public abstract HTMLCollection getAnchors()
A collection of all the anchor (A) elements in a document with a value for the name attribute.Note. For reasons of backwardscompatibility, the returned set of anchors only contains those anchors created with the name attribute, not those created with the id attribute.

o getCookie 
 public abstract String getCookie()
The cookies associated with this document. If there are none, thevalue is an empty string. Otherwise, the value is a string: asemicolon-delimited list of "name, value" pairs for all the cookiesassociated with the page. For example, name=value;expires=date.

o setCookie 
 public abstract void setCookie(String cookie)
o open 
 public abstract void open()
Note.This method and the ones following allow a user to add to or replace the structuremodel 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 methodsmay 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.

o close 
 public abstract void close()
Closes a document stream opened by open()and forces rendering.

o write 
 public abstract void write(String text)
Write a string of text to a document stream opened byopen(). The text is parsed into the document's structuremodel.

Parameters:
text - The string to be parsed into some structure in the document structuremodel.
o writeln 
 public abstract 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 structuremodel.
o getElementById 
 public abstract Element getElementById(String elementId)
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.

Parameters:
elementId - The unique id value for an element.
Returns:
The matching element.
o getElementsByName 
 public abstract NodeList getElementsByName(String elementName)
Returns the (possibly empty) collection of elements whosename value is given by elementName.

Parameters:
elementName - The name attribute value for an element.
Returns:
The matching elements. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index