|
Enhydra 3.0.1 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xerces.dom.NodeImpl | +--org.apache.xerces.dom.NodeContainer | +--org.apache.xerces.dom.DocumentImpl | +--org.apache.html.dom.HTMLDocumentImpl
Implements an HTML document. Provides access to the top level element in the document, its body and title.
Several methods create new nodes of all basic types (comment, text, element,
etc.). These methods create new nodes but do not place them in the document
tree. The nodes may be placed in the document tree using Node.appendChild(org.w3c.dom.Node)
or Node.insertBefore(org.w3c.dom.Node, org.w3c.dom.Node)
, or
they may be placed in some other document tree.
Note: <FRAMESET> documents are not supported at the moment, neither
are direct document writing (open()
, write(java.lang.String)
) and HTTP attribute
methods (getURL()
, getCookie()
).
HTMLDocument
, Serialized FormFields inherited from class org.apache.xerces.dom.DocumentImpl |
allowGrammarAccess,
docElement,
docType,
errorChecking,
identifiers,
iterators,
mutationEvents,
ranges,
treeWalkers |
Fields inherited from class org.apache.xerces.dom.NodeContainer |
firstChild,
kidOK,
lastChild,
nodeListChanges,
nodeListIndex,
nodeListLength,
nodeListNode,
syncChildren |
Fields inherited from class org.apache.xerces.dom.NodeImpl |
ELEMENT_DEFINITION_NODE,
fInternalSetNodeValue,
MUTATION_AGGREGATE,
MUTATION_ALL,
MUTATION_LOCAL,
MUTATION_NONE,
name,
nextSibling,
ownerDocument,
parentNode,
previousSibling,
readOnly,
syncData,
userData,
value |
Fields inherited from interface org.w3c.dom.Node |
ATTRIBUTE_NODE,
CDATA_SECTION_NODE,
COMMENT_NODE,
DOCUMENT_FRAGMENT_NODE,
DOCUMENT_NODE,
DOCUMENT_TYPE_NODE,
ELEMENT_NODE,
ENTITY_NODE,
ENTITY_REFERENCE_NODE,
NOTATION_NODE,
PROCESSING_INSTRUCTION_NODE,
TEXT_NODE |
Constructor Summary | |
HTMLDocumentImpl()
|
Method Summary | |
Node |
cloneNode(boolean deep)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. |
void |
close()
Closes a document stream opened by open() and forces
rendering. |
Attr |
createAttribute(java.lang.String name)
Creates an Attribute having this Document as its OwnerDoc. |
Element |
createElement(java.lang.String tagName)
Creates an element of the type specified. |
Element |
createElementNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
Creates an element of the given qualified name and namespace URI. |
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. |
Element |
getDocumentElement()
This is a convenience attribute that allows direct access to the child node that is the root element of the document. |
java.lang.String |
getDomain()
The domain name of the server that served the document, or null 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 . |
NodeList |
getElementsByTagName(java.lang.String tagName)
Returns a NodeList of all the Elements with a
given tag name in the order in which they would be encountered in a
preorder traversal of the Document tree. |
NodeList |
getElementsByTagNameNS(java.lang.String namespaceURI,
java.lang.String localName)
Returns a NodeList of all the Elements with a
given local name and namespace URI in the order in which they would be
encountered in a preorder traversal of the Document tree. |
HTMLCollection |
getForms()
A collection of all the forms of a document. |
HTMLElement |
getHead()
Obtains the <HEAD> element in the document, creating one if does not exist before. |
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 newBody)
|
void |
setCookie(java.lang.String cookie)
|
void |
setTitle(java.lang.String newTitle)
|
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() . |
Methods inherited from class org.apache.xerces.dom.NodeContainer |
appendChild,
getChildNodes,
getFirstChild,
getLastChild,
getLength,
hasChildNodes,
item,
normalize,
replaceChild,
setReadOnly,
synchronizeChildren |
Methods inherited from class org.apache.xerces.dom.NodeImpl |
addEventListener,
changed,
dispatchEvent,
finalize,
getAttributes,
getLocalName,
getNamespaceURI,
getNextSibling,
getOwnerDocument,
getParentNode,
getPrefix,
getPreviousSibling,
getReadOnly,
getUserData,
removeEventListener,
setPrefix,
setUserData,
supports,
synchronizeData,
toString |
Methods inherited from class java.lang.Object |
clone,
equals,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Constructor Detail |
public HTMLDocumentImpl()
Method Detail |
public Element getDocumentElement()
public HTMLElement getHead()
getDocumentElement()
. If the element does not exist, one
is created.
Called by getTitle()
, setTitle(java.lang.String)
, getBody()
and
setBody(org.w3c.dom.html.HTMLElement)
to assure the document has the <HEAD> element
correctly placed.
public java.lang.String getTitle()
TITLE
element in
the head of the document.public void setTitle(java.lang.String newTitle)
public HTMLElement getBody()
BODY
contents, returns the BODY
element, and in
frameset documents, this returns the outermostFRAMESET
element.public void setBody(HTMLElement newBody)
public 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
.elementId
- The unique id
value for an element.public NodeList getElementsByName(java.lang.String elementName)
name
value is given by elementName
.elementName
- The name
attribute value for an element.public final NodeList getElementsByTagName(java.lang.String tagName)
NodeList
of all the Elements
with a
given tag name in the order in which they would be encountered in a
preorder traversal of the Document
tree.tagname
- The name of the tag to match on. The special value "*"
matches all tags.NodeList
object containing all the matched
Elements
.public final NodeList getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)
NodeList
of all the Elements
with a
given local name and namespace URI in the order in which they would be
encountered in a preorder traversal of the Document
tree.namespaceURI
- The namespace URI of the elements to match on. The
special value "*" matches all namespaces.localName
- The local name of the elements to match on. The
special value "*" matches all local names.NodeList
object containing all the matched
Elements
.public Element createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName)
namespaceURI
is null
or an empty
string and the qualifiedName
has a prefix that is "xml",
the created element is bound to the predefined namespace
"http://www.w3.org/XML/1998/namespace" .
namespaceURI
- The namespace URI of the element to create.qualifiedName
- The qualified name of the element type to
instantiate.Element
object with the following attributes:
AttributeValueNode.nodeName
qualifiedName
Node.namespaceURI
namespaceURI
, or
"http://www.w3.org/XML/1998/namespace" if namespaceURI
is null
or an empty string, and the prefix is "xml"
Node.prefix
prefix, extracted from
qualifiedName
, or null
if there is no
prefixNode.localName
local name, extracted from
qualifiedName
Element.tagName
qualifiedName
qualifiedName
is
malformed, or if the qualifiedName
has a prefix that is
"xml" and the namespaceURI
is neither null
nor an empty string nor "http://www.w3.org/XML/1998/namespace".public Element createElement(java.lang.String tagName) throws DOMException
Element
interface, so attributes
can be specified directly on the returned object.
Attr
nodes representing them are automatically created and
attached to the element.
createElementNS
method.tagName
- The name of the element type to instantiate. For XML,
this is case-sensitive. For HTML, the tagName
parameter may be provided in any case, but it must be mapped to the
canonical uppercase form by the DOM implementation.Element
object with the nodeName
attribute set to tagName
, and localName
,
prefix
, and namespaceURI
set to
null
.public Attr createAttribute(java.lang.String name) throws DOMException
DocumentImpl.createAttribute(java.lang.String)
and returns
and attribute whose name is lower case.name
- The name of the attributepublic java.lang.String getReferrer()
public java.lang.String getDomain()
null
if the server cannot be identified by a domain name.public java.lang.String getURL()
public java.lang.String getCookie()
name=value;expires=date
.public void setCookie(java.lang.String cookie)
public HTMLCollection getImages()
IMG
elements in a document.The
behavior is limited to IMG
elements forbackwards
compatibility.public HTMLCollection getApplets()
OBJECT
elements that includeapplets
and APPLET
(deprecated) elements ina document.public HTMLCollection getLinks()
AREA
elements andanchor (A
)
elements in a documentwith a value for the href
attribute.public HTMLCollection getForms()
public 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.public void open()
public void close()
open()
and forces
rendering.public 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.public 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.public Node cloneNode(boolean deep)
parentNode
returns null
.).
Element
copies all attributes and their
values, including those generated by the XML processor to represent
defaulted attributes, but this method does not copy any text it
contains unless it is a deep clone, since the text is contained in a
child Text
node. Cloning any other type of node simply
returns a copy of this node.
EntityReference
clone are readonly.deep
- If true
, recursively clone the subtree under
the specified node; if false
, clone only the node
itself (and its attributes, if it is an Element
).
|
Enhydra 3.0.1 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |