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 and
holds the entire content. Beside 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:
-
close()
-
Closes a document stream opened by open()
and forces rendering.
-
getAnchors()
- A collection of all the anchor (A) elements in a document
with a value for the name attribute.Note.
-
getApplets()
- A collection of all the OBJECT elements that include
applets and APPLET (deprecated) elements in
a document.
-
getBody()
- The element that contains the content for the document.
-
getCookie()
- The cookies associated with this document.
-
getDomain()
- The domain name of the server that served the document, or a null
string if the server cannot be identified by a domain name.
-
getElementById(String)
-
Returns the Element whose id is given by elementId.
-
getElementsByName(String)
-
Returns the (possibly empty) collection of elements whose
name value is given by elementName.
-
getForms()
- A collection of all the forms of a document.
-
getImages()
- A collection of all the IMG elements in a document.
-
getLinks()
- A collection of all AREA elements and
anchor (A) elements in a document
with a value for the href attribute.
-
getReferrer()
- Returns the URI of the page that linked to this page.
-
getTitle()
- The title of a document as specified by the TITLE
element in the head of the document.
-
getURL()
- The complete URI of the document.
-
open()
-
Note.
-
setBody(HTMLElement)
-
-
setCookie(String)
-
-
setTitle(String)
-
-
write(String)
-
Write a string of text to a document stream opened by
open().
-
writeln(String)
-
Write a string of text followed by a newline character to a document
stream opened by open().
getTitle
public abstract String getTitle()
- The title of a document as specified by the TITLE
element in the head of the document.
setTitle
public abstract void setTitle(String title)
getReferrer
public abstract 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).
getDomain
public abstract String getDomain()
- The domain name of the server that served the document, or a null
string if the server cannot be identified by a domain name.
getURL
public abstract String getURL()
- The complete URI of the document.
getBody
public abstract HTMLElement getBody()
- The element that contains the content for the document. In documents
with BODY contents, returns the BODY
element, and in frameset documents, this returns the outermost
FRAMESET element.
setBody
public abstract void setBody(HTMLElement body)
getImages
public abstract HTMLCollection getImages()
- A collection of all the IMG elements in a document.
The behavior is limited to IMG elements for
backwards compatibility.
getApplets
public abstract HTMLCollection getApplets()
- A collection of all the OBJECT elements that include
applets and APPLET (deprecated) elements in
a document.
getLinks
public abstract HTMLCollection getLinks()
- A collection of all AREA elements and
anchor (A) elements in a document
with a value for the href attribute.
getForms
public abstract HTMLCollection getForms()
- A collection of all the forms of a document.
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 backwards
compatibility, the returned set of anchors only contains those anchors created with the name
attribute, not those created with the id attribute.
getCookie
public abstract 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.
setCookie
public abstract void setCookie(String cookie)
open
public abstract 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.
close
public abstract void close()
- Closes a document stream opened by open()
and forces rendering.
write
public abstract 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 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 structure
model.
getElementById
public abstract Element getElementById(String elementId)
- Returns the Element whose id is given by elementId.
If no such element exists, returns void. Behavior is not defined if
more than one element has this id.
- Parameters:
- elementId - The unique id value for an element.
getElementsByName
public abstract 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.
All Packages Class Hierarchy This Package Previous Next Index