Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.trolltech.qt.xml
Class QDomElement

    java.lang.Object
      com.trolltech.qt.internal.QSignalEmitterInternal
          com.trolltech.qt.QSignalEmitter
              com.trolltech.qt.QtJambiObject
                  com.trolltech.qt.xml.QDomNode
                      com.trolltech.qt.xml.QDomElement

All Implemented Interfaces:
  QtJambiInterface, java.lang.Cloneable

    public class QDomElement

extends QDomNode
implements java.lang.Cloneable

The `QDomElement` class represents one element in the DOM tree. Elements have a `tagName()` and zero or more attributes associated with them. The tag name can be changed with `setTagName()`.

Element attributes are represented by `QDomAttr` objects that can be queried using the `attribute()` and `attributeNode()` functions. You can set attributes with the `setAttribute()` and `setAttributeNode()` functions. Attributes can be removed with `removeAttribute()`. There are namespace-aware equivalents to these functions, i.e. `setAttributeNS()`, `setAttributeNodeNS()` and `removeAttributeNS()`.

If you want to access the text of a node use `text()`, e.g.

        QDomElement e = //...
        //...
        java.lang.String s = e.text()

The `text()` function operates recursively to find the text (since not all elements contain text). If you want to find all the text in all of a node's children, iterate over the children looking for `QDomText` nodes, e.g.

        java.lang.String text = new java.lang.String();
        QDomElement element = doc.documentElement();
        for(QDomNode node = element.firstChild(); !node.isNull(); node = node.nextSibling())
        {
            QDomText t = node.toText();
            if (!t.isNull())
                text += t.data();
        }

Note that we attempt to convert each node to a text node and use `text()` rather than using `firstChild()`.`toText()`.data() or n.`toText()`.data() directly on the node, because the node may not be a text element.

You can get a list of all the decendents of an element which have a specified tag name with `elementsByTagName()` or `elementsByTagNameNS()`.

To browse the elements of a dom document use `firstChildElement()`, `lastChildElement()`, `nextSiblingElement()` and `previousSiblingElement()`. For example, to iterate over all child elements called "entry" in a root element called "database", you can use:

        QDomDocument doc = // ...
        QDomElement root = doc.firstChildElement("database");
        QDomElement elt = root.firstChildElement("entry");
        for (; !elt.isNull(); elt = elt.nextSiblingElelement("entry")) {
            // ...
        }

For further information about the Document Object Model see Level 1 and Level 2 Core. For a more general introduction of the DOM implementation see the `QDomDocument` documentation.

Nested Class Summary

Nested classes/interfaces inherited from class com.trolltech.qt.xml.QDomNode
`QDomNode.EncodingPolicy, QDomNode.NodeType`

Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
`QSignalEmitter.AbstractSignal, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9`

Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
`com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal`

Field Summary

Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
`currentSender`

Constructor Summary
`QDomElement()` Constructs an empty element.
`QDomElement(QDomElement x)` Constructs a copy of `x`.

Method Summary
`java.lang.String` | `attribute(java.lang.String name)` Returns the attribute called `name`.
`java.lang.String` | `attribute(java.lang.String name, java.lang.String defValue)` Returns the attribute called `name`.
`QDomAttr` | `attributeNode(java.lang.String name)` Returns the `QDomAttr` object that corresponds to the attribute called `name`.
`QDomAttr` | `attributeNodeNS(java.lang.String nsURI, java.lang.String localName)` Returns the `QDomAttr` object that corresponds to the attribute with the local name `localName` and the namespace URI `nsURI`.
`java.lang.String` | `attributeNS(java.lang.String nsURI, java.lang.String localName)` Returns the attribute with the local name `localName` and the namespace URI `nsURI`.
`java.lang.String` | `attributeNS(java.lang.String nsURI, java.lang.String localName, java.lang.String defValue)` Returns the attribute with the local name `localName` and the namespace URI `nsURI`.
`QDomNamedNodeMap` | `attributes()` Returns a `QDomNamedNodeMap` containing all this element's attributes.
`QDomElement` | `clone()` This method is reimplemented for internal reasons
`QDomNodeList` | `elementsByTagName(java.lang.String tagname)` Returns a `QDomNodeList` containing all descendants of this element named `tagname` encountered during a preorder traversal of the element subtree with this element as its root.
`QDomNodeList` | `elementsByTagNameNS(java.lang.String nsURI, java.lang.String localName)` Returns a `QDomNodeList` containing all descendants of this element with local name `localName` and namespace URI `nsURI` encountered during a preorder traversal of the element subtree with this element as its root.
`boolean` | `hasAttribute(java.lang.String name)` Returns true if this element has an attribute called `name`; otherwise returns false.
`boolean` | `hasAttributeNS(java.lang.String nsURI, java.lang.String localName)` Returns true if this element has an attribute with the local name `localName` and the namespace URI `nsURI`; otherwise returns false.
`void` | `removeAttribute(java.lang.String name)` Removes the attribute called name `name` from this element.
`QDomAttr` | `removeAttributeNode(QDomAttr oldAttr)` Removes the attribute `oldAttr` from the element and returns it.
`void` | `removeAttributeNS(java.lang.String nsURI, java.lang.String localName)` Removes the attribute with the local name `localName` and the namespace URI `nsURI` from this element.
`void` | `setAttribute(java.lang.String name, double value)` This is an overloaded method provided for convenience.
`void` | `setAttribute(java.lang.String name, float value)` This is an overloaded method provided for convenience.
`void` | `setAttribute(java.lang.String name, int value)` This is an overloaded method provided for convenience.
`void` | `setAttribute(java.lang.String name, long value)` This is an overloaded method provided for convenience.
`void` | `setAttribute(java.lang.String name, java.lang.String value)` Adds an attribute called `name` with value `value`.
`QDomAttr` | `setAttributeNode(QDomAttr newAttr)` Adds the attribute `newAttr` to this element.
`QDomAttr` | `setAttributeNodeNS(QDomAttr newAttr)` Adds the attribute `newAttr` to this element.
`void` | `setAttributeNS(java.lang.String nsURI, java.lang.String qName, double value)` This is an overloaded method provided for convenience.
`void` | `setAttributeNS(java.lang.String nsURI, java.lang.String qName, int value)` This is an overloaded method provided for convenience.
`void` | `setAttributeNS(java.lang.String nsURI, java.lang.String qName, long value)` This is an overloaded method provided for convenience.
`void` | `setAttributeNS(java.lang.String nsURI, java.lang.String qName, java.lang.String value)` Adds an attribute with the qualified name `qName` and the namespace URI `nsURI` with the value `value`.
`void` | `setTagName(java.lang.String name)` Sets this element's tag name to `name`.
`java.lang.String` | `tagName()` Returns the tag name of this element.
`java.lang.String` | `text()` Returns the element's text or an empty string.

Methods inherited from class com.trolltech.qt.xml.QDomNode
`appendChild, childNodes, clear, cloneNode, cloneNode, columnNumber, firstChild, firstChildElement, firstChildElement, hasAttributes, hasChildNodes, insertAfter, insertBefore, isAttr, isCDATASection, isCharacterData, isComment, isDocument, isDocumentFragment, isDocumentType, isElement, isEntity, isEntityReference, isNotation, isNull, isProcessingInstruction, isSupported, isText, lastChild, lastChildElement, lastChildElement, lineNumber, localName, namedItem, namespaceURI, nextSibling, nextSiblingElement, nextSiblingElement, nodeName, nodeType, nodeValue, normalize, ownerDocument, parentNode, prefix, previousSibling, previousSiblingElement, previousSiblingElement, removeChild, replaceChild, save, save, setNodeValue, setPrefix, toAttr, toCDATASection, toCharacterData, toComment, toDocument, toDocumentFragment, toDocumentType, toElement, toEntity, toEntityReference, toNotation, toProcessingInstruction, toText, writeTo`

Methods inherited from class com.trolltech.qt.QtJambiObject
`dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr`

Methods inherited from class com.trolltech.qt.QSignalEmitter
`blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread`

Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
`__qt_signalInitialization`

Methods inherited from class java.lang.Object
`getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.trolltech.qt.QtJambiInterface
`disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership`

Constructor Detail

### QDomElement

    public QDomElement()

  Constructs an empty element. Use the `QDomDocument::createElement()` function to construct elements with content.

### QDomElement

    public QDomElement(QDomElement x)

  Constructs a copy of `x`.

  The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use `cloneNode()`.

Method Detail

### attribute

    public final java.lang.String attribute(java.lang.String name)

  Returns the attribute called `name`. If the attribute does not exist `defValue` is returned.

See also:
  `setAttribute()`, `attributeNode()`, `setAttributeNode()`, and `attributeNS()`.

### attribute

    public final java.lang.String attribute(java.lang.String name,
                                            java.lang.String defValue)

  Returns the attribute called `name`. If the attribute does not exist `defValue` is returned.

See also:
  `setAttribute()`, `attributeNode()`, `setAttributeNode()`, and `attributeNS()`.

### attributeNS

    public final java.lang.String attributeNS(java.lang.String nsURI,
                                              java.lang.String localName)

  Returns the attribute with the local name `localName` and the namespace URI `nsURI`. If the attribute does not exist `defValue` is returned.

See also:
  `setAttributeNS()`, `attributeNodeNS()`, `setAttributeNodeNS()`, and `attribute()`.

### attributeNS

    public final java.lang.String attributeNS(java.lang.String nsURI,
                                              java.lang.String localName,
                                              java.lang.String defValue)

  Returns the attribute with the local name `localName` and the namespace URI `nsURI`. If the attribute does not exist `defValue` is returned.

See also:
  `setAttributeNS()`, `attributeNodeNS()`, `setAttributeNodeNS()`, and `attribute()`.

### attributeNode

    public final QDomAttr attributeNode(java.lang.String name)

  Returns the `QDomAttr` object that corresponds to the attribute called `name`. If no such attribute exists a `null attribute` is returned.

See also:
  `setAttributeNode()`, `attribute()`, `setAttribute()`, and `attributeNodeNS()`.

### attributeNodeNS

    public final QDomAttr attributeNodeNS(java.lang.String nsURI,
                                          java.lang.String localName)

  Returns the `QDomAttr` object that corresponds to the attribute with the local name `localName` and the namespace URI `nsURI`. If no such attribute exists a `null attribute` is returned.

See also:
  `setAttributeNodeNS()`, `setAttributeNode()`, `attribute()`, and `setAttribute()`.

### attributes

    public final QDomNamedNodeMap attributes()

  Returns a `QDomNamedNodeMap` containing all this element's attributes.

See also:
  `attribute()`, `setAttribute()`, `attributeNode()`, and `setAttributeNode()`.

### elementsByTagName

    public final QDomNodeList elementsByTagName(java.lang.String tagname)

  Returns a `QDomNodeList` containing all descendants of this element named `tagname` encountered during a preorder traversal of the element subtree with this element as its root. The order of the elements in the returned list is the order they are encountered during the preorder traversal.

See also:
  `elementsByTagNameNS()`, and `QDomDocument::elementsByTagName()`.

### elementsByTagNameNS

    public final QDomNodeList elementsByTagNameNS(java.lang.String nsURI,
                                                  java.lang.String localName)

  Returns a `QDomNodeList` containing all descendants of this element with local name `localName` and namespace URI `nsURI` encountered during a preorder traversal of the element subtree with this element as its root. The order of the elements in the returned list is the order they are encountered during the preorder traversal.

See also:
  `elementsByTagName()`, and `QDomDocument::elementsByTagNameNS()`.

### hasAttribute

    public final boolean hasAttribute(java.lang.String name)

  Returns true if this element has an attribute called `name`; otherwise returns false.

  Note: This function does not take the presence of namespaces into account. As a result, the specified name will be tested against fully-qualified attribute names that include any namespace prefixes that may be present.

  Use `hasAttributeNS()` to explicitly test for attributes with specific namespaces and names.

### hasAttributeNS

    public final boolean hasAttributeNS(java.lang.String nsURI,
                                        java.lang.String localName)

  Returns true if this element has an attribute with the local name `localName` and the namespace URI `nsURI`; otherwise returns false.

### removeAttribute

    public final void removeAttribute(java.lang.String name)

  Removes the attribute called name `name` from this element.

See also:
  `setAttribute()`, `attribute()`, and `removeAttributeNS()`.

### removeAttributeNS

    public final void removeAttributeNS(java.lang.String nsURI,
                                        java.lang.String localName)

  Removes the attribute with the local name `localName` and the namespace URI `nsURI` from this element.

See also:
  `setAttributeNS()`, `attributeNS()`, and `removeAttribute()`.

### removeAttributeNode

    public final QDomAttr removeAttributeNode(QDomAttr oldAttr)

  Removes the attribute `oldAttr` from the element and returns it.

See also:
  `attributeNode()`, and `setAttributeNode()`.

### setAttribute

    public final void setAttribute(java.lang.String name,
                                   java.lang.String value)

  Adds an attribute called `name` with value `value`. If an attribute with the same name exists, its value is replaced by `value`.

See also:
  `attribute()`, `setAttributeNode()`, and `setAttributeNS()`.

### setAttribute

    public final void setAttribute(java.lang.String name,
                                   double value)

  This is an overloaded method provided for convenience.

### setAttribute

    public final void setAttribute(java.lang.String name,
                                   float value)

  This is an overloaded method provided for convenience.

### setAttribute

    public final void setAttribute(java.lang.String name,
                                   int value)

  This is an overloaded method provided for convenience.

### setAttribute

    public final void setAttribute(java.lang.String name,
                                   long value)

  This is an overloaded method provided for convenience.

### setAttributeNS

    public final void setAttributeNS(java.lang.String nsURI,
                                     java.lang.String qName,
                                     java.lang.String value)

  Adds an attribute with the qualified name `qName` and the namespace URI `nsURI` with the value `value`. If an attribute with the same local name and namespace URI exists, its prefix is replaced by the prefix of `qName` and its value is repaced by `value`.

  Although `qName` is the qualified name, the local name is used to decide if an existing attribute's value should be replaced.

See also:
  `attributeNS()`, `setAttributeNodeNS()`, and `setAttribute()`.

### setAttributeNS

    public final void setAttributeNS(java.lang.String nsURI,
                                     java.lang.String qName,
                                     double value)

  This is an overloaded method provided for convenience.

### setAttributeNS

    public final void setAttributeNS(java.lang.String nsURI,
                                     java.lang.String qName,
                                     int value)

  This is an overloaded method provided for convenience.

### setAttributeNS

    public final void setAttributeNS(java.lang.String nsURI,
                                     java.lang.String qName,
                                     long value)

  This is an overloaded method provided for convenience.

### setAttributeNode

    public final QDomAttr setAttributeNode(QDomAttr newAttr)

  Adds the attribute `newAttr` to this element.

  If the element has another attribute that has the same name as `newAttr`, this function replaces that attribute and returns it; otherwise the function returns a `null attribute`.

See also:
  `attributeNode()`, `setAttribute()`, and `setAttributeNodeNS()`.

### setAttributeNodeNS

    public final QDomAttr setAttributeNodeNS(QDomAttr newAttr)

  Adds the attribute `newAttr` to this element.

  If the element has another attribute that has the same local name and namespace URI as `newAttr`, this function replaces that attribute and returns it; otherwise the function returns a `null attribute`.

See also:
  `attributeNodeNS()`, `setAttributeNS()`, and `setAttributeNode()`.

### setTagName

    public final void setTagName(java.lang.String name)

  Sets this element's tag name to `name`.

See also:
  `tagName()`.

### tagName

    public final java.lang.String tagName()

  Returns the tag name of this element. For an XML element like this:

          <img src="myimg.png">

  the tagname would return "img".

See also:
  `setTagName()`.

### text

    public final java.lang.String text()

  Returns the element's text or an empty string.

  Example:

          <h1>Hello <b>Qt</b> <![CDATA[<xml is cool>]]></h1>

  The function `text()` of the `QDomElement` for the `<h1>` tag, will return the following text:

          Hello Qt t;xml is coolt;

  Comments are ignored by this function. It only evaluates `QDomText` and `QDomCDATASection` objects.

### clone

    public QDomElement clone()

  This method is reimplemented for internal reasons

  Overrides:
    `clone` in class `QDomNode`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD