Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
public interface Document
extends Node
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.
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 |
|
Attr |
|
CDATASection |
|
Comment |
|
DocumentFragment |
|
Element |
|
Element |
|
EntityReference |
|
ProcessingInstruction |
|
Text |
|
DocumentType |
|
Element |
|
Element |
|
NodeList |
|
NodeList |
|
DOMImplementation |
|
Node |
|
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 |
public Attr createAttribute(String name) throws DOMException
Creates anAttr
of the given name. Note that theAttr
instance can then be set on anElement
using thesetAttributeNode
method.
To create an attribute with a qualified name and namespace URI, use thecreateAttributeNS
method.
- Parameters:
name
- The name of the attribute.
- Returns:
- A new
Attr
object with thenodeName
attribute set toname
, andlocalName
,prefix
, andnamespaceURI
set tonull
. The value of the attribute is the empty string.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
public Attr createAttributeNS(String namespaceURI, String qualifiedName) throws DOMException
Creates an attribute of the given qualified name and namespace URI.
- Parameters:
namespaceURI
- The namespace URI of the attribute to create.qualifiedName
- The qualified name of the attribute to instantiate.
- Returns:
- A new
Attr
object with the following attributes:
Attribute Value Node.nodeName
qualifiedName Node.namespaceURI
namespaceURI
Node.prefix
prefix, extracted from qualifiedName
, ornull
if there is no prefixNode.localName
local name, extracted from qualifiedName
Attr.name
qualifiedName
Node.nodeValue
the empty string
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character, per the XML 1.0 specification .
NAMESPACE_ERR: Raised if thequalifiedName
is malformed per the Namespaces in XML specification, if thequalifiedName
has a prefix and thenamespaceURI
isnull
, if thequalifiedName
has a prefix that is "xml" and thenamespaceURI
is different from " http://www.w3.org/XML/1998/namespace", or if thequalifiedName
, or its prefix, is "xmlns" and thenamespaceURI
is different from " http://www.w3.org/2000/xmlns/".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the"XML"
feature, since namespaces were defined by XML.
- Since:
- DOM Level 2
public CDATASection createCDATASection(String data) throws DOMException
Creates aCDATASection
node whose value is the specified string.
- Parameters:
data
- The data for theCDATASection
contents.
- Returns:
- The new
CDATASection
object.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
public Comment createComment(String data)
Creates aComment
node given the specified string.
- Parameters:
data
- The data for the node.
- Returns:
- The new
Comment
object.
public DocumentFragment createDocumentFragment()
Creates an emptyDocumentFragment
object.
- Returns:
- A new
DocumentFragment
.
public Element createElement(String tagName) throws DOMException
Creates an element of the type specified. Note that the instance returned implements theElement
interface, so attributes can be specified directly on the returned object.
In addition, if there are known attributes with default values,Attr
nodes representing them are automatically created and attached to the element.
To create an element with a qualified name and namespace URI, use thecreateElementNS
method.
- Parameters:
tagName
- The name of the element type to instantiate. For XML, this is case-sensitive. For HTML, thetagName
parameter may be provided in any case, but it must be mapped to the canonical uppercase form by the DOM implementation.
- Returns:
- A new
Element
object with thenodeName
attribute set totagName
, andlocalName
,prefix
, andnamespaceURI
set tonull
.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
public Element createElementNS(String namespaceURI, String qualifiedName) throws DOMException
Creates an element of the given qualified name and namespace URI.
- Parameters:
namespaceURI
- The namespace URI of the element to create.qualifiedName
- The qualified name of the element type to instantiate.
- Returns:
- A new
Element
object with the following attributes:
Attribute Value Node.nodeName
qualifiedName
Node.namespaceURI
namespaceURI
Node.prefix
prefix, extracted from qualifiedName
, ornull
if there is no prefixNode.localName
local name, extracted from qualifiedName
Element.tagName
qualifiedName
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character, per the XML 1.0 specification .
NAMESPACE_ERR: Raised if thequalifiedName
is malformed per the Namespaces in XML specification, if thequalifiedName
has a prefix and thenamespaceURI
isnull
, or if thequalifiedName
has a prefix that is "xml" and thenamespaceURI
is different from " http://www.w3.org/XML/1998/namespace" .
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the"XML"
feature, since namespaces were defined by XML.
- Since:
- DOM Level 2
public EntityReference createEntityReference(String name) throws DOMException
Creates anEntityReference
object. In addition, if the referenced entity is known, the child list of theEntityReference
node is made the same as that of the correspondingEntity
node.If any descendant of theEntity
node has an unbound namespace prefix, the corresponding descendant of the createdEntityReference
node is also unbound; (itsnamespaceURI
isnull
). The DOM Level 2 does not support any mechanism to resolve namespace prefixes.
- Parameters:
name
- The name of the entity to reference.
- Returns:
- The new
EntityReference
object.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
public ProcessingInstruction createProcessingInstruction(String target, String data) throws DOMException
Creates aProcessingInstruction
node given the specified name and data strings.
- Parameters:
target
- The target part of the processing instruction.data
- The data for the node.
- Returns:
- The new
ProcessingInstruction
object.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified target contains an illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
public Text createTextNode(String data)
Creates aText
node given the specified string.
- Parameters:
data
- The data for the node.
- Returns:
- The new
Text
object.
public DocumentType getDoctype()
The Document Type Declaration (seeDocumentType
) associated with this document. For HTML documents as well as XML documents without a document type declaration this returnsnull
. 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 theNode
interface, such asinsertNode
orremoveNode
.
public Element getDocumentElement()
This is a convenience attribute that allows direct access to the child node that is the root element of the document. For HTML documents, this is the element with the tagName "HTML".
public Element getElementById(String elementId)
Returns theElement
whoseID
is given byelementId
. If no such element exists, returnsnull
. Behavior is not defined if more than one element has thisID
. 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 returnnull
.
- Parameters:
elementId
- The uniqueid
value for an element.
- Returns:
- The matching element.
- Since:
- DOM Level 2
public NodeList getElementsByTagName(String tagname)
Returns aNodeList
of all theElements
with a given tag name in the order in which they are encountered in a preorder traversal of theDocument
tree.
- Parameters:
tagname
- The name of the tag to match on. The special value "*" matches all tags.
- Returns:
- A new
NodeList
object containing all the matchedElements
.
public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
Returns aNodeList
of all theElements
with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of theDocument
tree.
- Parameters:
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.
- Returns:
- A new
NodeList
object containing all the matchedElements
.
- Since:
- DOM Level 2
public DOMImplementation getImplementation()
TheDOMImplementation
object that handles this document. A DOM application may use objects from multiple implementations.
public Node importNode(Node importedNode, boolean deep) throws DOMException
Imports a node from another document to this document. The returned node has no parent; (parentNode
isnull
). The source node is not altered or removed from the original document; this method creates a new copy of the source node.
For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node'snodeName
andnodeType
, plus the attributes related to namespaces (prefix
,localName
, andnamespaceURI
). As in thecloneNode
operation on aNode
, the source node is not altered.
Additional information is copied as appropriate to thenodeType
, 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
null
specified
true
Attr
Attr
deep
Attr
deep
true
DocumentFragment
Document
DocumentType
Attr
Element
importNode
deep
true
Entity
DocumentType
DocumentType
publicId
systemId
notationName
deep
Entity
EntityReference
deep
Notation
DocumentType
DocumentType
publicId
systemId
deep
Notation
target
data
CharacterData
data
length
- Parameters:
importedNode
- The node to import.deep
- Iftrue
, recursively import the subtree under the specified node; iffalse
, import only the node itself, as explained above. This has no effect onAttr
,EntityReference
, andNotation
nodes.
- Returns:
- The imported node that belongs to this
Document
.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.
- Since:
- DOM Level 2