Package org.w3c.dom.html2
Interface HTMLDocument
-
- All Superinterfaces:
org.w3c.dom.Document
,org.w3c.dom.Node
- All Known Implementing Classes:
HTMLDocumentImpl
public interface HTMLDocument extends org.w3c.dom.Document
AnHTMLDocument
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 methodgetElementById
is inherited from theDocument
interface where it was moved to.See also the Document Object Model (DOM) Level 2 HTML Specification.
-
-
Field Summary
-
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
close()
Closes a document stream opened byopen()
and forces rendering.HTMLCollection
getAnchors()
A collection of all the anchor (A
) elements in a document with a value for thename
attribute.HTMLCollection
getApplets()
A collection of all theOBJECT
elements that include applets andAPPLET
(deprecated) elements in a document.HTMLElement
getBody()
The element that contains the content for the document.java.lang.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.java.lang.String
getDomain()
The domain name of the server that served the document, ornull
if the server cannot be identified by a domain name.org.w3c.dom.NodeList
getElementsByName(java.lang.String elementName)
With [HTML 4.01] documents, this method returns the (possibly empty) collection of elements whosename
value is given byelementName
.HTMLCollection
getForms()
A collection of all the forms of a document.HTMLCollection
getImages()
A collection of all theIMG
elements in a document.HTMLCollection
getLinks()
A collection of allAREA
elements and anchor (A
) elements in a document with a value for thehref
attribute.java.lang.String
getReferrer()
Returns the URI [IETF RFC 2396] of the page that linked to this page.java.lang.String
getTitle()
The title of a document as specified by theTITLE
element in the head of the document.java.lang.String
getURL()
The absolute URI [IETF RFC 2396] of the document.void
open()
Open a document stream for writing.void
setBody(HTMLElement body)
The element that contains the content for the document.void
setCookie(java.lang.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 thecookies
non-terminal of [IETF RFC 2965], Section 4.2.2.void
setTitle(java.lang.String title)
The title of a document as specified by theTITLE
element in the head of the document.void
write(java.lang.String text)
Write a string of text to a document stream opened byopen()
.void
writeln(java.lang.String text)
Write a string of text followed by a newline character to a document stream opened byopen()
.-
Methods inherited from interface org.w3c.dom.Document
adoptNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, normalizeDocument, renameNode, setDocumentURI, setStrictErrorChecking, setXmlStandalone, setXmlVersion
-
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
-
-
-
-
Method Detail
-
getTitle
java.lang.String getTitle()
The title of a document as specified by theTITLE
element in the head of the document.
-
setTitle
void setTitle(java.lang.String title)
The title of a document as specified by theTITLE
element in the head of the document.
-
getReferrer
java.lang.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).
-
getDomain
java.lang.String getDomain()
The domain name of the server that served the document, ornull
if the server cannot be identified by a domain name.
-
getURL
java.lang.String getURL()
The absolute URI [IETF RFC 2396] of the document.
-
getBody
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.
-
setBody
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.
-
getImages
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.
-
getApplets
HTMLCollection getApplets()
A collection of all theOBJECT
elements that include applets andAPPLET
(deprecated) elements in a document.
-
getLinks
HTMLCollection getLinks()
A collection of allAREA
elements and anchor (A
) elements in a document with a value for thehref
attribute.
-
getForms
HTMLCollection getForms()
A collection of all the forms of a document.
-
getAnchors
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.
-
getCookie
java.lang.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.
-
setCookie
void setCookie(java.lang.String cookie) throws org.w3c.dom.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:
org.w3c.dom.DOMException
- SYNTAX_ERR: If the new value does not adhere to the cookie syntax specified by [IETF RFC 2965].
-
open
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]).
-
close
void close()
Closes a document stream opened byopen()
and forces rendering.
-
write
void write(java.lang.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.
-
writeln
void writeln(java.lang.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.
-
getElementsByName
org.w3c.dom.NodeList getElementsByName(java.lang.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.
-
-