Interface HTMLDocument

HTMLDocument
All Superinterfaces:
Document, Node
All Implemented Interfaces:
Document, Node

public HTMLDocument
extends Document


Field Summary
 String URL
          The absolute URI [RFC2396] of the document.
 HTMLCollection anchors
          A collection of all the anchor (A) elements in a document with a value for the name attribute.
 HTMLCollection applets
          A collection of all the OBJECT elements that include applets and APPLET (deprecated) elements in a document.
 HTMLElement body
          The element that contains the content for the document.
 String cookie
          This mutable string attribute denotes persistent state information that (1) is associated with the current frame or document and (2) is composed of information described by the cookies non-terminal of [RFC2965], Section 4.2.2.
 String domain
          The domain name of the server that served the document, or null if the server cannot be identified by a domain name.
 HTMLCollection forms
          A collection of all the forms of a document.
 HTMLCollection images
          A collection of all the IMG elements in a document.
 HTMLCollection links
          A collection of all AREA elements and anchor (A) elements in a document with a value for the href attribute.
 String referrer
          Returns the URI [RFC2396] of the page that linked to this page.
 String title
          The title of a document as specified by the TITLE element in the head of the document.
 
Fields inherited from class Document
documentElement
 
Fields inherited from class Node
childNodes, firstChild, lastChild, nextSibling, nodeName, nodeType, nodeValue, ownerDocument, parentNode, previousSibling
 
Method Summary
 void close()
          Closes a document stream opened by open() and forces rendering.
 NodeList getElementsByName(String elementName)
          Returns the (possibly empty) collection of elements whose name value is given by elementName.
 void open()
          Open a document stream for writing.
 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 Document
createComment, createElement, createTextNode, getElementById, getElementsByTagName
 
Methods inherited from class Node
appendChild, hasChildNodes, insertBefore, removeChild, replaceChild
 

Field Detail

cookie

String cookie
This mutable string attribute denotes persistent state information that (1) is associated with the current frame or document and (2) is composed of information described by the cookies non-terminal of [RFC2965], Section 4.2.2.

If no persistent state information is available for the current frame or document document, then this property's value is an empty string.

When this attribute is read, all cookies are returned as a single string, with each cookie's name-value pair concatenated into a list of name-value pairs, each list item being separated by a ';' (semicolon).
When this attribute is set, the value it is set to should be a string that adheres to the cookie non-terminal of [RFC2965]; that is, it should be a single name-value pair followed by zero or more cookie attribute values. If no domain attribute is specified, then the domain attribute for the new value defaults to the host portion of an absolute URI [RFC2396] of the current frame or document. If no path attribute is specified, then the path attribute for the new value defaults to the absolute path portion of the URI [RFC2396] of the current frame or document. If no max-age attribute is specified, then the max-age attribute for the new value defaults to a user agent defined value. If a cookie with the specified name is already associated with the current frame or document, then the new value as well as the new attributes replace the old value and attributes. If a max-age attribute of 0 is specified for the new value, then any existing cookies of the specified name are removed from the cookie storage.

Note: See [RFC2965] for the semantics of persistent state item attribute value pairs.

Note: The precise nature of a user agent session is not defined by this specification.


anchors

final HTMLCollection anchors
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.


body

HTMLElement body
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.


referrer

final String referrer
Returns the URI [RFC2396] 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).


title

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


applets

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


domain

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


images

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


links

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


URL

final String URL
The absolute URI [RFC2396] of the document.


forms

final HTMLCollection forms
A collection of all the forms of a document.

Method Detail

writeln

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.

open

void open()
Open a document stream for writing. If a document exists in the target, this method clears it.

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 (see [DOM Level 3 Abstract Schemas and Load and Save]). The following methods may be deprecated at some point in the future in favor of a more general-purpose mechanism.


getElementsByName

NodeList getElementsByName(String elementName)
Returns the (possibly empty) collection of elements whose name value is given by elementName. This method is case sensitive.

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

write

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.

close

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