Home » xml-commons-external-1.4.01-src » org.w3c » dom » html » [javadoc | source]
org.w3c.dom.html
public interface: HTMLDocument [javadoc | source]

All Implemented Interfaces:
    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 from org.w3c.dom.html.HTMLDocument Summary:
close,   getAnchors,   getApplets,   getBody,   getCookie,   getDomain,   getElementById,   getElementsByName,   getForms,   getImages,   getLinks,   getReferrer,   getTitle,   getURL,   open,   setBody,   setCookie,   setTitle,   write,   writeln
Method from org.w3c.dom.html.HTMLDocument Detail:
 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.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.
 public HTMLCollection getApplets()
    A collection of all the OBJECT elements that includeapplets 
and APPLET (deprecated) elements ina document.
 public 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.
 public 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.
 public 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.
 public 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.
 public NodeList getElementsByName(String elementName)
    Returns the (possibly empty) collection of elements whosename
 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.The 
behavior is limited to IMG elements forbackwards 
compatibility.
 public HTMLCollection getLinks()
    A collection of all AREA elements andanchor (A) 
elements in a documentwith a value for the href attribute.
 public 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).
 public String getTitle()
    The title of a document as specified by the TITLEelement in 
the head of the document.
 public String getURL()
    The complete URI of the document.
 public  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.
 public  void setBody(HTMLElement body)
 public  void setCookie(String cookie)
 public  void setTitle(String title)
 public  void write(String text)
    Write a string of text to a document stream opened byopen(). 
The text is parsed into the document's structuremodel.
 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.