public interface HTMLDocument extends Document
HTMLDocument
is the root of the HTML hierarchy andholds the
entire content. Beside providing access to the hierarchy, italso provides
some convenience methods for accessing certain sets ofinformation from the
document.
The following properties have been deprecated in favor of the corresponding ones for the BODY element:alinkColorbackgroundbgColorfgColor linkColorvlinkColor
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
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes a document stream opened by
open() and forces
rendering. |
HTMLCollection |
getAnchors()
A collection of all the anchor (
A ) elements in a document
with a value for the name attribute.Note. |
HTMLCollection |
getApplets()
A collection of all the
OBJECT elements that includeapplets
and APPLET (deprecated) elements ina document. |
HTMLElement |
getBody()
The element that contains the content for the document.
|
java.lang.String |
getCookie()
The cookies associated with this document.
|
java.lang.String |
getDomain()
The domain name of the server that served the document, or a nullstring
if the server cannot be identified by a domain name.
|
Element |
getElementById(java.lang.String elementId)
Returns the Element whose
id is given by elementId. |
NodeList |
getElementsByName(java.lang.String elementName)
Returns the (possibly empty) collection of elements whose
name
value is given by elementName . |
HTMLCollection |
getForms()
A collection of all the forms of a document.
|
HTMLCollection |
getImages()
A collection of all the
IMG elements in a document.The
behavior is limited to IMG elements forbackwards
compatibility. |
HTMLCollection |
getLinks()
A collection of all
AREA elements andanchor (A )
elements in a documentwith a value for the href attribute. |
java.lang.String |
getReferrer()
Returns the URI of the page that linked to this page.
|
java.lang.String |
getTitle()
The title of a document as specified by the
TITLE element in
the head of the document. |
java.lang.String |
getURL()
The complete URI of the document.
|
void |
open()
Note.This method and the ones following allow a user to add to or replace
the structuremodel of a document using strings of unparsed HTML.
|
void |
setBody(HTMLElement body) |
void |
setCookie(java.lang.String cookie) |
void |
setTitle(java.lang.String title) |
void |
write(java.lang.String text)
Write a string of text to a document stream opened by
open() . |
void |
writeln(java.lang.String text)
Write a string of text followed by a newline character to a document
stream opened by
open() . |
adoptNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementsByTagName, getElementsByTagNameNS, getImplementation, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, normalizeDocument, renameNode, setDocumentURI, setStrictErrorChecking, setXmlStandalone, setXmlVersion
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
java.lang.String getTitle()
TITLE
element in
the head of the document.void setTitle(java.lang.String title)
java.lang.String getReferrer()
java.lang.String getDomain()
java.lang.String getURL()
HTMLElement getBody()
BODY
contents, returns the BODY
element, and in
frameset documents, this returns the outermostFRAMESET
element.void setBody(HTMLElement body)
HTMLCollection getImages()
IMG
elements in a document.The
behavior is limited to IMG
elements forbackwards
compatibility.HTMLCollection getApplets()
OBJECT
elements that includeapplets
and APPLET
(deprecated) elements ina document.HTMLCollection getLinks()
AREA
elements andanchor (A
)
elements in a documentwith a value for the href
attribute.HTMLCollection getForms()
HTMLCollection getAnchors()
A
) elements in a document
with a value for the name
attribute.Note. For reasons of
backwardscompatibility, the returned set of anchors only contains those
anchors created with the name
attribute, not those created
with the id
attribute.java.lang.String getCookie()
name=value;expires=date
.void setCookie(java.lang.String cookie)
void open()
void close()
open()
and forces
rendering.void write(java.lang.String text)
open()
.
The text is parsed into the document's structuremodel.text
- The string to be parsed into some structure in the document
structuremodel.void writeln(java.lang.String text)
open()
. The text is parsed into the
document's structure model.text
- The string to be parsed into some structure in the document
structuremodel.Element getElementById(java.lang.String elementId)
id
is given by elementId. If no
such element exists, returns null
. Behavior is not defined
if more than one element has this id
.getElementById
in interface Document
elementId
- The unique id
value for an element.NodeList getElementsByName(java.lang.String elementName)
name
value is given by elementName
.elementName
- The name
attribute value for an element.Copyright © 1999-2022 The Apache Software Foundation. All Rights Reserved.