| org.w3c.dom.html.HTMLDocument
All known Subclasses: org.apache.html.dom.HTMLDocumentImpl,
| HTMLDocument | | public interface HTMLDocument extends Document(Code) | | 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.
|
| Method Summary | |
| 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 | 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. | | 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 HTMLCollection | getLinks()
A collection of all AREA elements and anchor (
A ) elements in a document with a value for the
href attribute. | | 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 text)
Write a string of text to a document stream opened by
open() . | | public void | writeln(String text)
Write a string of text followed by a newline character to a document
stream opened by open() . |
| close | | public void close()(Code) | | Closes a document stream opened by open() and forces
rendering.
|
| getAnchors | | public HTMLCollection getAnchors()(Code) | | 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.
|
| getApplets | | public HTMLCollection getApplets()(Code) | | A collection of all the OBJECT elements that include
applets and APPLET ( deprecated ) elements in a document.
|
| getBody | | public HTMLElement getBody()(Code) | | 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.
|
| getCookie | | public String getCookie()(Code) | | 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 .
|
| getDomain | | public String getDomain()(Code) | | The domain name of the server that served the document, or
null if the server cannot be identified by a domain name.
|
| getElementsByName | | public NodeList getElementsByName(String elementName)(Code) | | Returns the (possibly empty) collection of elements whose
name value is given by elementName .
Parameters:
elementName - The name attribute value for an element. The matching elements. |
| getImages | | public HTMLCollection getImages()(Code) | | A collection of all the IMG elements in a document. The
behavior is limited to IMG elements for backwards
compatibility.
|
| getLinks | | public HTMLCollection getLinks()(Code) | | A collection of all AREA elements and anchor (
A ) elements in a document with a value for the
href attribute.
|
| getReferrer | | public String getReferrer()(Code) | | 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).
|
| getTitle | | public String getTitle()(Code) | | The title of a document as specified by the TITLE element
in the head of the document.
|
| getURL | | public String getURL()(Code) | | The complete URI of the document.
|
| open | | public void open()(Code) | | 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.
|
| write | | public void write(String text)(Code) | | 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 void writeln(String text)(Code) | | 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. |
|
|