GNU Classpath (0.95) | |
Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
public interface HTMLDocument
extends Document
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:alinkColorbackground
bgColorfgColorlinkColorvlinkColorIn DOM Level 2, the method
getElementById
is inherited from the Document
interface where it was moved to.
See also the Document Object Model (DOM) Level 2 HTML Specification.
Method Summary | |
void |
|
HTMLCollection |
|
HTMLCollection |
|
HTMLElement |
|
String |
|
String |
|
NodeList |
|
HTMLCollection |
|
HTMLCollection |
|
HTMLCollection |
|
String |
|
String |
|
String |
|
void |
|
void |
|
void |
|
void | |
void | |
void |
public HTMLCollection getAnchors()
A collection of all the anchor (A
) elements in a document with a value for thename
attribute. For reasons of backward compatibility, the returned set of anchors only contains those anchors created with thename
attribute, not those created with theid
attribute. Note that in [XHTML 1.0], thename
attribute (see section 4.10) has no semantics and is only present for legacy user agents: theid
attribute is used instead. Users should prefer the iterator mechanisms provided by [DOM Level 2 Traversal] instead.
public HTMLCollection getApplets()
A collection of all theOBJECT
elements that include applets andAPPLET
(deprecated) elements in a document.
public HTMLElement getBody()
The element that contains the content for the document. In documents withBODY
contents, returns theBODY
element. In frameset documents, this returns the outermostFRAMESET
element.
public String getCookie()
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 thecookies
non-terminal of [IETF RFC 2965], 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 thecookie
non-terminal of [IETF RFC 2965]; 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 [IETF RFC 2396] 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 [IETF RFC 2396] 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. See [IETF RFC 2965] for the semantics of persistent state item attribute value pairs. The precise nature of a user agent session is not defined by this specification.
public String getDomain()
The domain name of the server that served the document, ornull
if the server cannot be identified by a domain name.
public NodeList getElementsByName(String elementName)
With [HTML 4.01] documents, this method returns the (possibly empty) collection of elements whosename
value is given byelementName
. In [XHTML 1.0] documents, this methods only return the (possibly empty) collection of form controls with matching name. This method is case sensitive.
- Parameters:
elementName
- Thename
attribute value for an element.
- Returns:
- The matching elements.
public HTMLCollection getImages()
A collection of all theIMG
elements in a document. The behavior is limited toIMG
elements for backwards compatibility. As suggested by [HTML 4.01], to include images, authors may use theOBJECT
element or theIMG
element. Therefore, it is recommended not to use this attribute to find the images in the document butgetElementsByTagName
with HTML 4.01 orgetElementsByTagNameNS
with XHTML 1.0.
public HTMLCollection getLinks()
A collection of allAREA
elements and anchor (A
) elements in a document with a value for thehref
attribute.
public String getReferrer()
Returns the URI [IETF RFC 2396] 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).
public String getTitle()
The title of a document as specified by theTITLE
element in the head of the document.
public void open()
Open a document stream for writing. If a document exists in the target, this method clears it. 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 Load and Save]).
public void setBody(HTMLElement body)
The element that contains the content for the document. In documents withBODY
contents, returns theBODY
element. In frameset documents, this returns the outermostFRAMESET
element.
public void setCookie(String cookie) throws DOMException
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 thecookies
non-terminal of [IETF RFC 2965], 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 thecookie
non-terminal of [IETF RFC 2965]; 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 [IETF RFC 2396] 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 [IETF RFC 2396] 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. See [IETF RFC 2965] for the semantics of persistent state item attribute value pairs. The precise nature of a user agent session is not defined by this specification.
- Throws:
DOMException
- SYNTAX_ERR: If the new value does not adhere to the cookie syntax specified by [IETF RFC 2965].
public void setTitle(String title)
The title of a document as specified by theTITLE
element in the head of the document.
public void write(String text)
Write a string of text to a document stream opened byopen()
. Note that the function will produce a document which is not necessarily driven by a DTD and therefore might be produce an invalid result in the context of the document.
- Parameters:
text
- The string to be parsed into some structure in the document structure model.
public void writeln(String text)
Write a string of text followed by a newline character to a document stream opened byopen()
. Note that the function will produce a document which is not necessarily driven by a DTD and therefore might be produce an invalid result in the context of the document
- Parameters:
text
- The string to be parsed into some structure in the document structure model.
GNU Classpath (0.95) |