JavaScript API Reference for Oracle ADF Faces

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.w3c.dom.core
Class Document

org.ecmascript.object.Object
   |
   +--org.w3c.dom.core.Node
         |
         +--org.w3c.dom.core.Document

public abstract class Document
extends Node

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 Node.ownerDocument attribute which associates them with the Document within whose context they were created.

Note that this object is implemented and supported by the web browser and results of its use may vary.

Field Summary

public DocumentType	docType Stores the Document Type Declaration associated with document (or null if the DTD was not specified).
public Element	documemtElement Stores the root element of the document (For HTML documents, this is the element with the tagName "HTML").
public DOMImplementation	Implementation The DOMImplementation object that handles this document.

Fields inherited from org.w3c.dom.core.Node

ATTRIBUTE_NODE, attributes, CDATA_SECTION_NODE, childNodes, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, firstChild, lastChild, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, NOTATION_NODE, ownerDocument, parentNode, prefix, previousSibling, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from org.ecmascript.object.Object

constructor, prototype

Method Summary

public Attr	createAttribute(String name) Creates an Attr of the given name.
public Attr	createAttributeNS(String namespaceURI, String qualifiedName) Creates an Attr of the given name.
public CDATASection	createCDATASection(String data) Creates a CDATASection node whose value is the specified string.
public Comment	createComment(String data) Creates a Comment node given the specified string.
public DocumentFragment	createDocumentFragment() Creates an empty DocumentFragment object.
public Element	createElement(String tagName) Creates an element of the type specified.
public Element	createElementNS(String namespaceURI, String qualifiedName) Creates an element of the given qualified name and namespace URI.
public EntityReference	createEntityReference(String name) Creates an {@link EntityReference} object.
public ProcessingInstruction	createProcessingInstruction(String target, String data) Creates a ProcessingInstruction node given the specified name and data strings.
public Text	createTextNode(String data) Creates a Text node given the specified string.
public Element	getElementById(String elementId) Returns the {@link Element} whose ID is given by elementId.
public NodeList	getElementByTagName(String tagName) Returns a {@link NodeList} of all the {@link Element} with a given tag name in the order in which they are encountered in a preorder traversal of the {@link Document} tree.
public NodeList	getElementByTagNameNS(String namespaceURI, String localName) Returns a {@link NodeList} of all the {@link Element} with a given local name and namespaceURI in the same orderas they appear in the source document.
public Node	importNode(Node importedNode, Boolean deep) Imports a node from another document to this document.

Methods inherited from org.w3c.dom.core.Node

appendChild, cloneNode, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild

Field Detail

docType

public DocumentType docType

Stores the Document Type Declaration associated with document (or null if the DTD was not specified).

The doctype attributecannot be altered in any way, including through the use of methods inherited from the Node interface. This is a readonly attribute

JavaScript Code Example:

var output = document.doctype;

documemtElement

public Element documemtElement

Stores the root element of the document (For HTML documents, this is the element with the tagName "HTML"). This is a readonly attribute

JavaScript Code Example:

var output = document.documentElement.nodeName;

Implementation

public DOMImplementation Implementation

The DOMImplementation object that handles this document. This is a readonly attribute

Example:

<div id="doc">

  <div>

    Text in the first DIV.

  </div>

  <div id="DDD" class="secondClass">

    Some text in the second DIV.

  </div>

  <div class="thirdClass">

    Some text and <span id="SSS">element</span> in the third DIV.

  </div>

  <div class="fourthClass">

    We can try <i>another elements</i>.

    It will be much more <b>interesting</b>.

  </div>

  <div>

    Text in the last DIV.

  </div>

</div>

JavaScript:

var output = document.implementation.hasFeature('HTML', '1.0');

Method Detail

createAttribute

public Attr createAttribute(String name)

Creates an Attr of the given name. Note that the Attr instance can then be set on an Element using the setAttribute() method.

Example:

<div >

  <div>

    Text in the first DIV.

  </div>

  <div >

    Some text in the second DIV.

  </div>

  <div class="thirdClass">

    Some text and <span >element</span> in the third DIV.

  </div>

  <div class="fourthClass">

    We can try <i>another elements</i>.

    It will be much more <b>interesting</b>.

  </div>

  <div>

    Text in the last DIV.

  </div>

</div>

JavaScript:

var main = document.getElementById('doc');

var attr = document.createAttribute('temp');

attr.value = 'temporary';

main.setAttributeNode(attr);

var output = main.getAttribute('temp');

Parameters:

name

-

The name of the attribute to retieve.

Return:

Attr - A new 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.

Throws:

DOMException INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

createAttributeNS

public Attr createAttributeNS(String namespaceURI,
String qualifiedName)

Creates an Attr of the given name. Note that the Attr instance can then be set on an Element using the setAttribute() method.

Introduced in DOM Level 2

Example:

<div >

  <div>

    Text in the first DIV.

  </div>

  <div >

    Some text in the second DIV.

  </div>

  <div class="thirdClass">

    Some text and <span >element</span> in the third DIV.

  </div>

  <div class="fourthClass">

    We can try <i>another elements</i>.

    It will be much more <b>interesting</b>.

  </div>

  <div>

    Text in the last DIV.

  </div>

</div>

JavaScript:

var main = document.getElementById('doc');

var attr = document.createAttribute('temp');

attr.value = 'temporary';

main.setAttributeNode(attr);

var output = main.getAttribute('temp');

Parameters:

namespaceURI	-	The namespace URI of the attribute to create.
qualifiedName	-	The qualified name of the attribute to instantiate.

Return:

Attr - A new Attr object. (For complete list of attributes of created Attr object see standard.)

Throws:

DOMException INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.

DOMException NAMESPACE_ERR: Raised if the qualifiedName is malformed, 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 is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/".

createCDATASection

public CDATASection createCDATASection(String data)

Creates a CDATASection node whose value is the specified string.

JavaScript:

var cSection = document.createCDATASection('some text for CDATA-section');

var output1 = cSection.nodeType;

var output2 = cSection.data;

Parameters:

data

-

The data for the CDATASection contents.

Return:

CDATASection - The new CDATASection object.

Throws:

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

createComment

public Comment createComment(String data)

Creates a Comment node given the specified string.

JavaScript:

var comm = document.createComment('This is some comment.');

var output1 = comm.nodeType;

var output2 = comm.data;

Parameters:

data

-

The data for the node.

Return:

Comment - The new Comment object.

createDocumentFragment

public DocumentFragment createDocumentFragment()

Creates an empty DocumentFragment object.

Example:

<div >

  <div>

    Text in the first DIV.

  </div>

  <div >

    Some text in the second DIV.

  </div>

  <div class="thirdClass">

    Some text and <span >element</span> in the third DIV.

  </div>

  <div class="fourthClass">

    We can try <i>another elements</i>.

    It will be much more <b>interesting</b>.

  </div>

  <div>

    Text in the last DIV.

  </div>

</div>

JavaScript:

var main = document.getElementById('doc');

var elem = document.createDocumentFragment();

var nodeFor = main.firstChild;

elem.appendChild(nodeFor);

var output = elem.firstChild.nodeName;

Return:

DocumentFragment - A new DocumentFragment object.

createElement

public Element createElement(String tagName)

Creates an element of the type specified. Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object.

JavaScript:

var elem = document.createElement('P');

var output = elem.nodeName;

Parameters:

tagName

-

The name of the element type to instantiate. (Remember that for XML this is case-sensitive.)

Return:

Element - A new Element object with the Node.nodeName attribute set to "Element#tagName", and Node.localName, Node.prefix, and Node.namespaceURI set to null.

Throws:

DOMException INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

createElementNS

public Element createElementNS(String namespaceURI,
String qualifiedName)

Creates an element of the given qualified name and namespace URI. HTML-only DOM implementations do not need to implement this method.

Introduced in DOM Level 2.

JavaScript:

var main = document.getElementById('doc');

var elem = document.createElementNS('http://zvon.org/namespaces/test', 'zvon:temp');

main.appendChild(elem);

var output = main.getElementsByTagNameNS('http://zvon.org/namespaces/test', 'zvon:temp')[0].nodeName;

Parameters:

namespaceURI	-	The namespace URI of the element to create.
qualifiedName	-	The qualified name of the element type to instantiate.

Return:

Element - A new Element object with the following attributes. (

Throws:

DOMException INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.

DOMException NAMESPACE_ERR: Raised if the qualifiedName is malformed, 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" [Namespaces].

createEntityReference

public EntityReference createEntityReference(String name)

Creates an 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.

Note: 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.

Parameters:

name

-

The name of the entity to reference.

Return:

EntityReference - The new EntityReference object.

Throws:

DOMException INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

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

createProcessingInstruction

public ProcessingInstruction createProcessingInstruction(String target,
String data)

Creates a ProcessingInstruction node given the specified name and data strings.

JavaScript:

var pi = document.createProcessingInstruction('php', 'echo("another example")');

var output1 = pi.nodeType;

var output2 = pi.target;

var output3 = pi.data;

Parameters:

target	-	The target part of the processing instruction.
data	-	The data for the node.

Return:

ProcessingInstruction - The new ProcessingInstruction object.

Throws:

DOMException INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

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

createTextNode

public Text createTextNode(String data)

Creates a Text node given the specified string.

JavaScript:

var elem = document.createTextNode('This is some text.');

var output = elem.nodeValue;

Parameters:

data

-

The data for the node.

Return:

Text - The new Text object.

getElementById

public Element getElementById(String elementId)

Returns the 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.

Note: 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.

Example:

<div >

  <div>

    Text in the first DIV.

  </div>

  <div >

    Some text in the second DIV.

  </div>

  <div class="thirdClass">

    Some text and <span >element</span> in the third DIV.

  </div>

  <div class="fourthClass">

    We can try <i>another elements</i>.

    It will be much more <b>interesting</b>.

  </div>

  <div>

    Text in the last DIV.

  </div>

</div>

JavaScript:

var output1 = document.getElementById('doc').nodeName;

var output2 = document.getElementById('SSS').nodeName;

Introduced in DOM Level 2.

Parameters:

elementId

-

The unique id value for an element.

Return:

Element - The matching element.

getElementByTagName

public NodeList getElementByTagName(String tagName)

Returns a NodeList of all the Element with a given tag name in the order in which they are encountered in a preorder traversal of the Document tree.

Example:

<div >

  <div>

    Text in the first DIV.

  </div>

  <div >

    Some text in the second DIV.

  </div>

  <div class="thirdClass">

    Some text and <span >element</span> in the third DIV.

  </div>

  <div class="fourthClass">

    We can try <i>another elements</i>.

    It will be much more <b>interesting</b>.

  </div>

  <div>

    Text in the last DIV.

  </div>

</div>

JavaScript:

var collection = document.getElementsByTagName('LINK');

var output = collection[1].getAttribute('rel');

Parameters:

tagName

-

The name of the tag to match on. The special value "*" matches all tags.

Return:

NodeList - A new NodeList object containing all the matched Elements.

getElementByTagNameNS

public NodeList getElementByTagNameNS(String namespaceURI,
String localName)

Returns a NodeList of all the Element with a given local name and namespaceURI in the same orderas they appear in the source document.

JavaScript:

var main = document.getElementsByTagNameNS('http://www.w3.org/1998/Math/MathML', 'apply');

var output = main.length;

Introduced in DOM Level 2.

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.

Return:

NodeList - A new NodeList object containing all the matched Elements.

importNode

public Node importNode(Node importedNode,
Boolean deep)

Imports a node from another document to this document. The returned node has no parent; (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.

For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node's 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.

Additional information is copied as appropriate to the 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.

ATTRIBUTE_NODE

The ownerElement attribute is set to null and the specified flag is set to true on the generated Attr. The descendant 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.

DOCUMENT_FRAGMENT_NODE

If the 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_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 generated 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_NODE

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.

ENTITY_REFERENCE_NODE

Only the 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_NODE

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.

PROCESSING_INSTRUCTION_NODE

The imported node copies its target and data values from those of the source node.

TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE

These three types of nodes inheriting from CharacterData copy their data and length attributes fromthose of the source node.

Introduced in DOM Level 2.

Parameters:

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.

Return:

Node - The imported node that belongs to this Document.

Throws:

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

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD