|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
The Document interface represents the entire HTML or XML
document. Conceptually, it is the root of the document tree, and provides
the primary access to the document's data.
Since elements, text nodes, comments, processing instructions, etc.
cannot exist outside the context of a Document, the
Document interface also contains the factory methods needed
to create these objects. The Node objects created have a
ownerDocument attribute which associates them with the
Document within whose context they were created.
See also the Document Object Model (DOM) Level 2 Core Specification.
| Field Summary |
| 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 |
| Method Summary | |
Attr |
createAttribute(String name)
Creates an Attr of the given name. |
Attr |
createAttributeNS(String namespaceURI,
String qualifiedName)
Creates an attribute of the given qualified name and namespace URI. |
CDATASection |
createCDATASection(String data)
Creates a CDATASection node whose value is the specified
string. |
Comment |
createComment(String data)
Creates a Comment node given the specified string. |
DocumentFragment |
createDocumentFragment()
Creates an empty DocumentFragment object. |
Element |
createElement(String tagName)
Creates an element of the type specified. |
Element |
createElementNS(String namespaceURI,
String qualifiedName)
Creates an element of the given qualified name and namespace URI. |
EntityReference |
createEntityReference(String name)
Creates an EntityReference object. |
ProcessingInstruction |
createProcessingInstruction(String target,
String data)
Creates a ProcessingInstruction node given the specified
name and data strings. |
Text |
createTextNode(String data)
Creates a Text node given the specified string. |
DocumentType |
getDoctype()
The Document Type Declaration (see DocumentType)
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. |
Element |
getElementById(String elementId)
Returns the Element whose ID is given by
elementId. |
NodeList |
getElementsByTagName(String tagname)
Returns a NodeList of all the Elements with a
given tag name in the order in which they are encountered in a
preorder traversal of the Document tree. |
NodeList |
getElementsByTagNameNS(String namespaceURI,
String localName)
Returns a NodeList of all the Elements with a
given local name and namespace URI in the order in which they are
encountered in a preorder traversal of the Document tree. |
DOMImplementation |
getImplementation()
The DOMImplementation object that handles this document. |
Node |
importNode(Node importedNode,
boolean deep)
Imports a node from another document to this document. |
| Methods inherited from interface org.w3c.dom.Node |
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix |
| Method Detail |
public DocumentType getDoctype()
DocumentType)
associated with this document. For HTML documents as well as XML
documents without a document type declaration this returns
null. The DOM Level 2 does not support editing the
Document Type Declaration. docType cannot be altered in
any way, including through the use of methods inherited from the
Node interface, such as insertNode or
removeNode.
public DOMImplementation getImplementation()
DOMImplementation object that handles this document. A
DOM application may use objects from multiple implementations.
public Element getDocumentElement()
public Element createElement(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.
DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character.public DocumentFragment createDocumentFragment()
DocumentFragment object.
DocumentFragment.public Text createTextNode(String data)
Text node given the specified string.
data - The data for the node.
Text object.public Comment createComment(String data)
Comment node given the specified string.
data - The data for the node.
Comment object.
public CDATASection createCDATASection(String data)
throws DOMException
CDATASection node whose value is the specified
string.
data - The data for the CDATASection contents.
CDATASection object.
DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
public ProcessingInstruction createProcessingInstruction(String target,
String data)
throws DOMException
ProcessingInstruction node given the specified
name and data strings.
target - The target part of the processing instruction.data - The data for the node.
ProcessingInstruction object.
DOMException - INVALID_CHARACTER_ERR: Raised if the specified target contains an
illegal character.
public Attr createAttribute(String name)
throws DOMException
Attr of the given name. Note that the
Attr instance can then be set on an Element
using the setAttributeNode method.
createAttributeNS method.
name - The name of the attribute.
Attr object with the nodeName
attribute set to name, and localName,
prefix, and namespaceURI set to
null. The value of the attribute is the empty string.
DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character.
public EntityReference createEntityReference(String name)
throws DOMException
EntityReference object. In addition, if the
referenced entity is known, the child list of the
EntityReference node is made the same as that of the
corresponding Entity node.If any descendant of the
Entity node has an unbound namespace prefix, the
corresponding descendant of the created EntityReference
node is also unbound; (its namespaceURI is
null). The DOM Level 2 does not support any mechanism to
resolve namespace prefixes.
name - The name of the entity to reference.
EntityReference object.
DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character.
public NodeList getElementsByTagName(String tagname)
NodeList of all the Elements with a
given tag name in the order in which they are 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 Node importNode(Node importedNode,
boolean deep)
throws DOMException
parentNode is null).
The source node is not altered or removed from the original document;
this method creates a new copy of the source node.
nodeName and nodeType, plus the
attributes related to namespaces (prefix,
localName, and namespaceURI). As in the
cloneNode operation on a Node, the source
node is not altered.
nodeType, attempting to mirror the behavior expected if
a fragment of XML or HTML source was copied from one document to
another, recognizing that the two documents may have different DTDs
in the XML case. The following list describes the specifics for each
type of node.
ownerElement attribute
is set to null and the specified flag is
set to true on the generated Attr. The
descendants of the source Attr are recursively imported
and the resulting nodes reassembled to form the corresponding subtree.
Note that the deep parameter has no effect on
Attr nodes; they always carry their children with them
when imported.deep option
was set to true, the descendants of the source element
are recursively imported and the resulting nodes reassembled to form
the corresponding subtree. Otherwise, this simply generates an empty
DocumentFragment.Document
nodes cannot be imported.DocumentType
nodes cannot be imported.Attr
nodes are attached to the generated Element. Default
attributes are not copied, though if the document being imported into
defines default attributes for this element name, those are assigned.
If the importNode deep parameter was set to
true, the descendants of the source element are
recursively imported and the resulting nodes reassembled to form the
corresponding subtree.Entity nodes can be
imported, however in the current release of the DOM the
DocumentType is readonly. Ability to add these imported
nodes to a DocumentType will be considered for addition
to a future release of the DOM.On import, the publicId,
systemId, and notationName attributes are
copied. If a deep import is requested, the descendants
of the the source Entity are recursively imported and
the resulting nodes reassembled to form the corresponding subtree.EntityReference itself is
copied, even if a deep import is requested, since the
source and destination documents might have defined the entity
differently. If the document being imported into provides a
definition for this entity name, its value is assigned.Notation nodes can be imported, however in the current
release of the DOM the DocumentType is readonly. Ability
to add these imported nodes to a DocumentType will be
considered for addition to a future release of the DOM.On import, the
publicId and systemId attributes are copied.
Note that the deep parameter has no effect on
Notation nodes since they never have any children.target and data values from those of the
source node.CharacterData copy their
data and length attributes from those of
the source node.
importedNode - The node to import.deep - If true, recursively import the subtree under
the specified node; if false, import only the node
itself, as explained above. This has no effect on Attr
, EntityReference, and Notation nodes.
Document.
DOMException - NOT_SUPPORTED_ERR: Raised if the type of node being imported is not
supported.
public Element createElementNS(String namespaceURI,
String qualifiedName)
throws DOMException
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:
| Attribute | Value |
|---|---|
Node.nodeName |
qualifiedName |
Node.namespaceURI |
namespaceURI |
Node.prefix |
prefix, extracted
from qualifiedName, or null if there is
no prefix |
Node.localName |
local name, extracted from
qualifiedName |
Element.tagName |
qualifiedName |
DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name
contains an illegal character, per the XML 1.0 specification .
qualifiedName is
malformed per the Namespaces in XML specification, if the
qualifiedName has a prefix and the
namespaceURI is null, or if the
qualifiedName has a prefix that is "xml" and the
namespaceURI is different from "
http://www.w3.org/XML/1998/namespace" .
"XML" feature, since namespaces were
defined by XML.
public Attr createAttributeNS(String namespaceURI,
String qualifiedName)
throws DOMException
namespaceURI - The namespace URI of the attribute to create.qualifiedName - The qualified name of the attribute to
instantiate.
Attr object with the following attributes:
| Attribute | Value |
|---|---|
Node.nodeName |
qualifiedName |
Node.namespaceURI |
namespaceURI |
Node.prefix |
prefix, extracted from
qualifiedName, or null if there is no
prefix |
Node.localName |
local name, extracted from
qualifiedName |
Attr.name |
qualifiedName |
Node.nodeValue |
the empty string |
DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name
contains an illegal character, per the XML 1.0 specification .
qualifiedName is
malformed per the Namespaces in XML specification, if the
qualifiedName has a prefix and the
namespaceURI is null, if the
qualifiedName has a prefix that is "xml" and the
namespaceURI is different from "
http://www.w3.org/XML/1998/namespace", or if the
qualifiedName, or its prefix, is "xmlns" and the
namespaceURI is different from "
http://www.w3.org/2000/xmlns/".
"XML" feature, since namespaces were
defined by XML.
public NodeList getElementsByTagNameNS(String namespaceURI,
String localName)
NodeList of all the Elements with a
given local name and namespace URI in the order in which they are
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 getElementById(String elementId)
Element whose ID is given by
elementId. If no such element exists, returns
null. Behavior is not defined if more than one element
has this ID. The DOM implementation must have
information that says which attributes are of type ID. Attributes
with the name "ID" are not of type ID unless so defined.
Implementations that do not know whether attributes are of type ID or
not are expected to return null.
elementId - The unique id value for an element.
|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.