JavaScript API Reference for Oracle ADF Faces

org.w3c.dom.core
Class Element

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

public abstract class Element
extends Node

className

public String className

The class attribute of the element. This attribute has been renamed due to conflicts with the "class" keyword exposed by many languages. See the class attribute definition in HTML 4.01.

dir

public String dir

Specifies the base direction of directionally neutral text and the directionality of tables.

This attribute specifies the base direction of directionally neutral text (i.e., text that doesn't have inherent directionality as defined in [UNICODE]) in an element's content and attribute values. It also specifies the directionality of tables. Possible values:

• LTR: Left-to-right text or table.
• RTL: Right-to-left text or table.

In addition to specifying the language of a document with the lang attribute, authors may need to specify the base directionality (left-to-right or right-to-left) of portions of a document's text, of table structure, etc. This is done with the dir attribute.

The [UNICODE] specification assigns directionality to characters and defines a (complex) algorithm for determining the proper directionality of text. If a document does not contain a displayable right-to-left character, a conforming user agent is not required to apply the [UNICODE] bidirectional algorithm. If a document contains right-to-left characters, and if the user agent displays these characters, the user agent must use the bidirectional algorithm.

Although Unicode specifies special characters that deal with text direction, HTML offers higher-level markup constructs that do the same thing: the dir attribute (do not confuse with the DIR element) and the BDO element. Thus, to express a Hebrew quotation, it is more intuitive to write

<Q lang="he" dir="rtl"

id

public String id

lang

public String lang

tagName

public String tagName

The name of the element. For example, in:

 <elementExample id="demo"> ... </elementExample> , 

tagName has the value "elementExample". Note that this is case-preserving in XML, as are all of the operations of the DOM. The HTML DOM returns the tagName of an HTML element in the canonical uppercase form, regardless of the case in the source HTML 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 Code Example:

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

var output = main.tagName;

title

public String title

getAttribute

public String getAttribute(String name)

Retrieves an attribute value by name.

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 Code Example:

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

var output1 = main.getAttribute('id');

var output2 = main.getAttribute('class');

Parameters:

name

-

The name of the attribute to retieve.

Return:

String - The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

getAttributeNode

public Attr getAttributeNode(String name)

Retrieves an attribute node by name. To retrieve an attribute node by qualified name and namespace URI, use the getAttributeNodeNS method.

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 main = document.getElementById('doc');

var output = main.getAttributeNode('id').value;

Parameters:

name

-

The name (nodeName) of the attribute to retrieve.

Return:

Attr - The Attr node with the specified name (nodeName) or null if there is no such attribute.

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI,
                               String localName)

Retrieves an Attr node by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.

Example:

<div id="doc" xmlns:svg="http://www.w3.org/2000/svg">
  <div>
    Text in the first DIV.
  </div>
  <svg:svg id="logo" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="60">
    <svg:g style="fill:#3399cc; font-size:36pt; font-family:'dialog'; font-weight: bold">
      <svg:a xlink:type="simple" xlink:href="http://www.zvon.org">
        <svg:text x="50%" y="65%" text-anchor="middle">ZVON.org</svg:text>
      </svg:a>
    </svg:g>
  </svg:svg>
  <apply xmlns="http://www.w3.org/1998/Math/MathML">
    <int/>
    <bvar>
      <ci> x </ci>
    </bvar>
    <interval>
      <ci> a </ci>
      <ci> b </ci>
    </interval>
    <apply>
      <cos/>
      <ci> x </ci>
    </apply>
  </apply>
  <div>
    Text in the last DIV.
  </div>
</div>

JavaScript:

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

var elem1 = main.getElementsByTagName('svg:a')[0];

var output1 = elem1.getAttributeNS('http://www.w3.org/1999/xlink', 'type');

var output2 = elem1.getAttribute('xlink:type');

Introduced in DOM Level 2.

Parameters:

namespaceURI	-	The namespace URI of the attribute to retrieve.
localName	-	The local name of the attribute to retrieve.

Return:

Attr - The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.

getAttributeNS

public String getAttributeNS(String namespaceURI,
                             String localName)

Retrieves an attribute value by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.

Example:

<div id="doc" xmlns:svg="http://www.w3.org/2000/svg">
  <div>
    Text in the first DIV.
  </div>
  <svg:svg id="logo" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="60">
    <svg:g style="fill:#3399cc; font-size:36pt; font-family:'dialog'; font-weight: bold">
      <svg:a xlink:type="simple" xlink:href="http://www.zvon.org">
        <svg:text x="50%" y="65%" text-anchor="middle">ZVON.org</svg:text>
      </svg:a>
    </svg:g>
  </svg:svg>
  <apply xmlns="http://www.w3.org/1998/Math/MathML">
    <int/>
    <bvar>
      <ci> x </ci>
    </bvar>
    <interval>
      <ci> a </ci>
      <ci> b </ci>
    </interval>
    <apply>
      <cos/>
      <ci> x </ci>
    </apply>
  </apply>
  <div>
    Text in the last DIV.
  </div>
</div>

JavaScript:

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

var elem1 = main.getElementsByTagName('svg:a')[0];

var output1 = elem1.getAttributeNS('http://www.w3.org/1999/xlink', 'type');

var output2 = elem1.getAttribute('xlink:type');

Introduced in DOM Level 2.

Parameters:

namespaceURI	-	The namespace URI of the attribute to retrieve.
localName	-	The local name of the attribute to retrieve.

Return:

String - The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

getElementsByTagName

public NodeList getElementsByTagName(String name)

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

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 main = document.getElementById('doc');

var collection = main.getElementsByTagName('div');

var output1 = collection.length;

var output2 = collection[0].firstChild.nodeValue;

Parameters:

name

-

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

Return:

NodeList - A list of matching Element nodes.

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)

Returns a NodeList of all the descendant Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of this Element tree. HTML-only DOM implementations do not need to implement this method.

Example:

<div id="doc" xmlns:svg="http://www.w3.org/2000/svg">
  <div>
    Text in the first DIV.
  </div>
  <svg:svg id="logo" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="60">
    <svg:g style="fill:#3399cc; font-size:36pt; font-family:'dialog'; font-weight: bold">
      <svg:a xlink:type="simple" xlink:href="http://www.zvon.org">
        <svg:text x="50%" y="65%" text-anchor="middle">ZVON.org</svg:text>
      </svg:a>
    </svg:g>
  </svg:svg>
  <apply xmlns="http://www.w3.org/1998/Math/MathML">
    <int/>
    <bvar>
      <ci> x </ci>
    </bvar>
    <interval>
      <ci> a </ci>
      <ci> b </ci>
    </interval>
    <apply>
      <cos/>
      <ci> x </ci>
    </apply>
  </apply>
  <div>
    Text in the last DIV.
  </div>
</div>

JavaScript:

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

var elem1 = main.getElementsByTagName('svg:a')[0];

var output1 = elem1.getAttributeNS('http://www.w3.org/1999/xlink', 'type');

var output2 = elem1.getAttribute('xlink:type');

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.

hasAttribute

public Boolean hasAttribute(String name)

Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.

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 elem1 = document.getElementById('doc');

var elem2 = document.getElementById('DDD');

var output1 = elem1.hasAttribute('class');

var output2 = elem2.hasAttribute('class');

Introduced in DOM Level 2.

Parameters:

name

-

The name of the attribute to look for.

Return:

Boolean - true if an attribute with the given name is specified on this element or has a default value, false otherwise.

hasAttributeNS

public Boolean hasAttributeNS(String namespaceURI,
                              String localName)

Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise. HTML-only DOM implementations do not need to implement this method.

Example:

<div id="doc" xmlns:svg="http://www.w3.org/2000/svg">
  <div>
    Text in the first DIV.
  </div>
  <svg:svg id="logo" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="60">
    <svg:g style="fill:#3399cc; font-size:36pt; font-family:'dialog'; font-weight: bold">
      <svg:a xlink:type="simple" xlink:href="http://www.zvon.org">
        <svg:text x="50%" y="65%" text-anchor="middle">ZVON.org</svg:text>
      </svg:a>
    </svg:g>
  </svg:svg>
  <apply xmlns="http://www.w3.org/1998/Math/MathML">
    <int/>
    <bvar>
      <ci> x </ci>
    </bvar>
    <interval>
      <ci> a </ci>
      <ci> b </ci>
    </interval>
    <apply>
      <cos/>
      <ci> x </ci>
    </apply>
  </apply>
  <div>
    Text in the last DIV.
  </div>
</div>

JavaScript:

var elem = document.getElementsByTagName('svg:a')[0];

var output = elem.hasAttributeNS('http://www.w3.org/1999/xlink', 'type');

Introduced in DOM Level 2.

Parameters:

namespaceURI	-	The namespace URI of the attribute to look for.
localName	-	The local name of the attribute to look for.

Return:

Boolean - True if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise.

removeAttribute

public void removeAttribute(String name)

Removes an attribute by name. If the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.

To remove an attribute by local name and namespace URI, use the removeAttributeNS(String, String) method.

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 main = document.getElementById('doc');

main.removeAttribute('id');

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

Parameters:

name

-

The name of the attribute to remove.

Return:

void - null

Throws:

DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

removeAttributeNode

public Attr removeAttributeNode(Attr oldAttr)

Removes the specified attribute node. If the removed Attr has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix, when applicable.

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 main = document.getElementById('doc');

var attr = main.attributes[0];

var attrOut = main.removeAttributeNode(attr);

var output1 = main.getAttributeNode('id');

var output2 = attrOut.value;

Parameters:

oldAttr

-

The Attr node to remove from the attribute list.

Return:

Attr - The Attr node that was removed.

Throws:

DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

removeAttributeNS

public void removeAttributeNS(String namespaceURI,
                              String localName)

Removes an attribute by local name and namespace URI. If the removed attribute has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix.

HTML-only DOM implementations do not need to implement this method.

Example:

<div id="doc" xmlns:svg="http://www.w3.org/2000/svg">
  <div>
    Text in the first DIV.
  </div>
  <svg:svg id="logo" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="60">
    <svg:g style="fill:#3399cc; font-size:36pt; font-family:'dialog'; font-weight: bold">
      <svg:a xlink:type="simple" xlink:href="http://www.zvon.org">
        <svg:text x="50%" y="65%" text-anchor="middle">ZVON.org</svg:text>
      </svg:a>
    </svg:g>
  </svg:svg>
  <apply xmlns="http://www.w3.org/1998/Math/MathML">
    <int/>
    <bvar>
      <ci> x </ci>
    </bvar>
    <interval>
      <ci> a </ci>
      <ci> b </ci>
    </interval>
    <apply>
      <cos/>
      <ci> x </ci>
    </apply>
  </apply>
  <div>
    Text in the last DIV.
  </div>
</div>

JavaScript:

var elem = document.getElementsByTagName('svg:a')[0];

elem.removeAttributeNS('http://www.w3.org/1999/xlink', 'href');

var output = elem.getAttributeNS('http://www.w3.org/1999/xlink', 'href');

Introduced in DOM Level 2.

Parameters:

namespaceURI	-	The namespace URI of the attribute to remove.
localName	-	The local name of the attribute to remove.

Return:

void - null

Throws:

DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

DOMException NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element.

setAttribute

public void setAttribute(String name,
                         String value)

Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNode(Attr) to assign it as the value of an attribute.

To set an attribute with a qualified name and namespace URI, use the setAttributeNS(String, String, String) method.

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 main = document.getElementById('doc');

main.setAttribute('attr', 'temp');

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

Parameters:

name	-	The name of the attribute to create or alter.
value	-	Value to set in string form.

Return:

void - null

Throws:

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

DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

setAttributeNode

public Attr setAttributeNode(Attr newAttr)

Adds a new attribute node. If an attribute with that name (nodeName) is already present in the element, it is replaced by the new one.

To add a new attribute node with a qualified name and namespace URI, use the setAttributeNodeNS(Attr) method.

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 main = document.getElementById('doc');

var collection = main.getElementsByTagName('div');

var elem = collection[0];

var attr = collection[2].getAttributeNode('class');

elem.setAttributeNode(attr);

var output = elem.getAttributeNode('class').value;

Parameters:

newAttr

-

The Attr node to add to the attribute list.

Return:

Attr - If the newAttr attribute replaces an existing attribute, the replaced Attr node is returned, otherwise null is returned.

Throws:

DOMException WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.

DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

DOMException INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr newAttr)

Adds a new attribute. If an attribute with that local name and that namespace URI is already present in the element, it is replaced by the new one.

HTML-only DOM implementations do not need to implement this method.

Example:

<div id="doc" xmlns:svg="http://www.w3.org/2000/svg">
  <div>
    Text in the first DIV.
  </div>
  <svg:svg id="logo" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="60">
    <svg:g style="fill:#3399cc; font-size:36pt; font-family:'dialog'; font-weight: bold">
      <svg:a xlink:type="simple" xlink:href="http://www.zvon.org">
        <svg:text x="50%" y="65%" text-anchor="middle">ZVON.org</svg:text>
      </svg:a>
    </svg:g>
  </svg:svg>
  <apply xmlns="http://www.w3.org/1998/Math/MathML">
    <int/>
    <bvar>
      <ci> x </ci>
    </bvar>
    <interval>
      <ci> a </ci>
      <ci> b </ci>
    </interval>
    <apply>
      <cos/>
      <ci> x </ci>
    </apply>
  </apply>
  <div>
    Text in the last DIV.
  </div>
</div>

JavaScript:

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

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

attr.value = 'temporary';

elem.setAttributeNodeNS(attr);

var output = elem.getAttributeNodeNS('http://zvon.org/namespaces/test', 'zvon:temp').value;

Introduced in DOM Level 2.

Parameters:

newAttr

-

The Attr node to add to the attribute list.

Return:

Attr - If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the replaced Attr node is returned, otherwise null is returned.

Throws:

DOMException WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.

DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

DOMException INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

setAttributeNS

public void setAttributeNS(String namespaceURI,
                           String qualifiedName,
                           String value)

Adds a new attribute. If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNodeNS(Attr) or setAttributeNode(Attr) to assign it as the value of an attribute.

HTML-only DOM implementations do not need to implement this method.

Example:

<div id="doc" xmlns:svg="http://www.w3.org/2000/svg">
  <div>
    Text in the first DIV.
  </div>
  <svg:svg id="logo" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="60">
    <svg:g style="fill:#3399cc; font-size:36pt; font-family:'dialog'; font-weight: bold">
      <svg:a xlink:type="simple" xlink:href="http://www.zvon.org">
        <svg:text x="50%" y="65%" text-anchor="middle">ZVON.org</svg:text>
      </svg:a>
    </svg:g>
  </svg:svg>
  <apply xmlns="http://www.w3.org/1998/Math/MathML">
    <int/>
    <bvar>
      <ci> x </ci>
    </bvar>
    <interval>
      <ci> a </ci>
      <ci> b </ci>
    </interval>
    <apply>
      <cos/>
      <ci> x </ci>
    </apply>
  </apply>
  <div>
    Text in the last DIV.
  </div>
</div>

JavaScript:

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

elem.setAttributeNS('http://zvon.org/namespaces/test', 'attr', 'temporary');

var output = elem.getAttributeNS('http://zvon.org/namespaces/test', 'attr');

Introduced in DOM Level 2.

Parameters:

namespaceURI	-	The namespace URI of the attribute to create or alter.
qualifiedName	-	The qualified name of the attribute to create or alter.
value	-	The value to set in string form.

Return:

void - null

Throws:

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

DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

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