Movatterモバイル変換

Interface Document

All Superinterfaces:

Node

public interfaceDocument

extendsNode

TheDocument 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 aDocument, theDocument interface also contains the factory methods needed to create these objects. TheNode objects created have aownerDocument attribute which associates them with theDocument within whose context they were created.

See also theDocument Object Model (DOM) Level 2 Core Specification.

getDoctype

publicDocumentTypegetDoctype()

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.

getImplementation

publicDOMImplementationgetImplementation()

TheDOMImplementation object that handles this document. A DOM application may use objects from multiple implementations.

getDocumentElement

publicElementgetDocumentElement()

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".

createElement

publicElementcreateElement(java.lang.String tagName)                      throwsDOMException

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 newElement 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.

createDocumentFragment

publicDocumentFragmentcreateDocumentFragment()

Creates an emptyDocumentFragment object.

Returns:

A newDocumentFragment.

createTextNode

publicTextcreateTextNode(java.lang.String data)

Creates aText node given the specified string.

Parameters:

data - The data for the node.

Returns:

The newText object.

createComment

publicCommentcreateComment(java.lang.String data)

Creates aComment node given the specified string.

Parameters:

data - The data for the node.

Returns:

The newComment object.

createCDATASection

publicCDATASectioncreateCDATASection(java.lang.String data)                                throwsDOMException

Creates aCDATASection node whose value is the specified string.

Parameters:

data - The data for theCDATASection contents.

Returns:

The newCDATASection object.

Throws:

DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

createProcessingInstruction

publicProcessingInstructioncreateProcessingInstruction(java.lang.String target,                                                         java.lang.String data)                                                  throwsDOMException

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 newProcessingInstruction 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.

createAttribute

publicAttrcreateAttribute(java.lang.String name)                     throwsDOMException

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 newAttr 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.

createEntityReference

publicEntityReferencecreateEntityReference(java.lang.String name)                                      throwsDOMException

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 newEntityReference 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.

getElementsByTagName

publicNodeListgetElementsByTagName(java.lang.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 newNodeList object containing all the matchedElements.

importNode

publicNodeimportNode(Node importedNode,                       boolean deep)                throwsDOMException

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.

ATTRIBUTE_NODE

TheownerElement attribute is set tonull and thespecified flag is set totrue on the generatedAttr. The descendants of the sourceAttr are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Note that thedeep parameter has no effect onAttr nodes; they always carry their children with them when imported.

DOCUMENT_FRAGMENT_NODE

If thedeep option was set totrue, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Otherwise, this simply generates an emptyDocumentFragment.

DOCUMENT_NODE

Document nodes cannot be imported.

DOCUMENT_TYPE_NODE

DocumentType nodes cannot be imported.

ELEMENT_NODE

Specified attribute nodes of the source element are imported, and the generatedAttr nodes are attached to the generatedElement. Default attributes are not copied, though if the document being imported into defines default attributes for this element name, those are assigned. If theimportNodedeep parameter was set totrue, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree.

ENTITY_NODE

Entity nodes can be imported, however in the current release of the DOM theDocumentType is readonly. Ability to add these imported nodes to aDocumentType will be considered for addition to a future release of the DOM.On import, thepublicId,systemId, andnotationName attributes are copied. If adeep import is requested, the descendants of the the sourceEntity are recursively imported and the resulting nodes reassembled to form the corresponding subtree.

ENTITY_REFERENCE_NODE

Only theEntityReference itself is copied, even if adeep 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_NODE

Notation nodes can be imported, however in the current release of the DOM theDocumentType is readonly. Ability to add these imported nodes to aDocumentType will be considered for addition to a future release of the DOM.On import, thepublicId andsystemId attributes are copied. Note that thedeep parameter has no effect onNotation nodes since they never have any children.

PROCESSING_INSTRUCTION_NODE

The imported node copies itstarget anddata values from those of the source node.

TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE

These three types of nodes inheriting fromCharacterData copy theirdata andlength attributes from those of the source node.

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 thisDocument.

Throws:

DOMException - NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.

Since:

DOM Level 2

createElementNS

publicElementcreateElementNS(java.lang.String namespaceURI,                               java.lang.String qualifiedName)                        throwsDOMException

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 newElement object with the following attributes:

Attribute	Value
Node.nodeName	qualifiedName
Node.namespaceURI	namespaceURI
Node.prefix	prefix, extracted fromqualifiedName, ornull if there is no prefix
Node.localName	local name, extracted fromqualifiedName
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

createAttributeNS

publicAttrcreateAttributeNS(java.lang.String namespaceURI,                              java.lang.String qualifiedName)                       throwsDOMException

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 newAttr object with the following attributes:

Attribute	Value
Node.nodeName	qualifiedName
Node.namespaceURI	namespaceURI
Node.prefix	prefix, extracted fromqualifiedName, ornull if there is no prefix
Node.localName	local name, extracted fromqualifiedName
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

getElementsByTagNameNS

publicNodeListgetElementsByTagNameNS(java.lang.String namespaceURI,                                       java.lang.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 newNodeList object containing all the matchedElements.

Since:

DOM Level 2

getElementById

publicElementgetElementById(java.lang.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