Titanium SDK # Titanium.XML.Document
The DOM Document returned from parseString.
0.9
0.9
9.2.0# Overview
Implements the DOM Level 2 API (opens new window) on Android and iOS.
As of version 3.1, Android does not truly support DTDs. A document with a DTD can be parsed, however it is not validated, its default attributes are not be automatically added into the DOM tree, and so on.
This has been reported as Android Issue #7395 (opens new window).
# Properties
# apiName READONLY
3.2.0 3.2.0 9.2.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# attributes READONLY
0.9 0.9 9.2.0A map of this node's attributes.
As defined by the DOM specification, only Titanium.XML.Element nodes have attributes.
For all other node types, this property is always null.
# bubbleParent
3.0.0 3.0.0 9.2.0Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
# childNodes READONLY
0.9 0.9 9.2.0A Titanium.XML.NodeList of this node's children.
# doctype READONLY
0.9 0.9 9.2.0An interface to the list of entities that are defined for the document, such as via a Document Type Definition (DTD).
See note about Android and DTDs.
# documentElement READONLY
0.9 0.9 9.2.0Root element of this document.
# implementation READONLY
0.9 0.9 9.2.0Titanium.XML.DOMImplementation object associated with this document.
# lifecycleContainer
3.6.0The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
# localName
0.9 0.9 9.2.0Local part of the qualified name of this node.
The local part of the qualified name that comes after the colon. That is, the name without the namespace prefix.
# nodeName READONLY
0.9 0.9 9.2.0Name of this node.
Certain node types have constant values defined by the DOM specification:
- Text node:
#text - Comment node:
#comment - CDATA section node:
#cdata-section - Document node:
#document - Document fragment node:
#document-fragment
# nodeType READONLY
0.9 0.9 9.2.0This node's type. One of ELEMENT_NODE, ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE,
ENTITY_REFERENCE_NODE, ENTITY_NODE, PROCESSING_INSTRUCTION_NODE, COMMENT_NODE,
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, DOCUMENT_FRAGMENT_NODE, NOTATION_NODE.
# nodeValue
0.9 0.9 9.2.0Content (value) of this node.
As defined in the DOM specification, the node value is always null for
Document, DocumentFragment, DocumentType, Element, Entity, EntityReference, and
Notation nodes.
# ownerDocument READONLY
0.9 0.9 9.2.0This node's owning document.
Note that a node always has an owning document, even if it is not part of the document tree.
For more on node ownership, see ownerDocument issues in the W3C DOM FAQ.
# prefix
0.9 0.9 9.2.0Namespace prefix of this node.
Read-only on iOS, read-write on other platforms.
# previousSibling READONLY
0.9 0.9 9.2.0This node's previous sibling.
# text READONLYDEPRECATED
0.9 9.2.0DEPRECATED SINCE 2.0.0
Use textContent instead.
Content (value) of all text nodes within this node.
# textContent READONLY
0.9 9.2.0Content (value) of all text nodes within this node.
On Android, textContent is supported on Titanium.XML.Element and
Titanium.XML.Text nodes only.
# Methods
# addEventListener
0.9 0.9 9.2.0Adds the specified callback as an event listener for the named event.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# appendChild
0.9 0.9 9.2.0Appends the node newChild as a child of this node.
On iOS, appendChild is supported on Titanium.XML.Element
nodes only.
Parameters
| Name | Type | Description |
|---|---|---|
newChild | Titanium.XML.Node | New node to append. |
Returns
Newly-appended node.
- Type
- Titanium.XML.Node
# applyProperties
3.0.0 3.0.0 9.2.0Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# cloneNode
0.9 0.9 9.2.0Returns a duplicate of this node.
Parameters
| Name | Type | Description |
|---|---|---|
deep | Boolean | Whether or not to perform a deep copy of this node. |
Returns
Cloned node.
- Type
- Titanium.XML.Node
# createAttribute
0.9 0.9 9.2.0Creates an attribute with the given name.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name for the new attribute. |
Returns
Attribute object, ready to be added to an element.
- Type
- Titanium.XML.Attr
# createAttributeNS
0.9 0.9 9.2.0Creates an attribute with the given name and namespace.
Parameters
| Name | Type | Description |
|---|---|---|
namespaceURI | String | Namespace URI for the new attribute. |
name | String | Qualified name for the new attribute (can include a prefix). |
Returns
Attribute object, ready to be added to an element.
- Type
- Titanium.XML.Attr
# createCDATASection
0.9 0.9 9.2.0Creates and returns a Titanium.XML.CDATASection.
Parameters
| Name | Type | Description |
|---|---|---|
data | String | String data to go into the CDATA section. |
Returns
CDATA section with the given data, ready to be added to an element.
# createComment
0.9 0.9 9.2.0Creates a Titanium.XML.Comment with the supplied string data.
Parameters
| Name | Type | Description |
|---|---|---|
data | String | Comment text. |
Returns
Comment object, ready to be appended to the DOM tree.
- Type
- Titanium.XML.Comment
# createDocumentFragment
0.9 0.9 9.2.0Creates an empty Titanium.XML.DocumentFragment.
Returns
The empty Titanium.XML.DocumentFragment.
# createElement
0.9 0.9 9.2.0Creates an element with the given tag name.
Parameters
| Name | Type | Description |
|---|---|---|
tagName | String | Name for the created element. |
Returns
Newly created element.
- Type
- Titanium.XML.Element
# createElementNS
0.9 0.9 9.2.0Create a new element with the given namespace and name.
Parameters
| Name | Type | Description |
|---|---|---|
namespaceURI | String | URI for the namespace the new element belongs to. |
name | String | Qualified for the new element (can include a prefix). |
Returns
New namespace-qualified element.
- Type
- Titanium.XML.Element
# createEntityReference
0.9 0.9 9.2.0Creates an Titanium.XML.EntityReference with the given name.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name for the new entity reference. |
Returns
Newly-created entity reference.
# createProcessingInstruction
0.9 0.9 9.2.0Creates a processing instruction for inserting into the DOM tree.
Parameters
| Name | Type | Description |
|---|---|---|
target | String | Target part for the processing instruction. |
data | String | Data for the processing instruction node. |
Returns
New processing instruction.
# createTextNode
0.9 0.9 9.2.0Creates a text node.
Parameters
| Name | Type | Description |
|---|---|---|
data | String | The string value for the text node. |
Returns
Newly-created text node.
- Type
- Titanium.XML.Text
# fireEvent
0.9 0.9 9.2.0Fires a synthesized event to any registered listeners.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Returns
- Type
- void
# getElementById
0.9 0.9 9.2.0Returns an Titanium.XML.Element that has an ID attribute with the given value.
Parameters
| Name | Type | Description |
|---|---|---|
elementId | String | A unique ID value for an element to search for. |
Returns
The Element matching the given ID, if any.
- Type
- Titanium.XML.Element
# getElementsByTagName
0.9 0.9 9.2.0Returns a node list of elements in the document which have the given tag.
Parameters
| Name | Type | Description |
|---|---|---|
tagname | String | Tag name to search for. |
Returns
List of elements in the document which have the given tag name.
# getElementsByTagNameNS
0.9 0.9 9.2.0Returns a node list of elements in the document which belong to the given namespace and have the given tag name.
Parameters
| Name | Type | Description |
|---|---|---|
namespaceURI | String | Namespace URI used for matching elements. |
localname | String | Tag name to search for. |
Returns
List of elements in the document which belong to the given namespace and have the given tag name.
# hasAttributes
0.9 0.9 9.2.0Returns true if this node has attributes.
Returns
True if this node has attributes, false if it does not.
- Type
- Boolean
# hasChildNodes
0.9 0.9 9.2.0Returns true if this node has child nodes.
Returns
True if this node has children, false if it does not.
- Type
- Boolean
# importNode
0.9 0.9 9.2.0Imports a node from another document to this document, without altering or removing the source node from the original document.
This method creates a new copy of the source node, ready to be inserted into
this document. The returned node has an ownerDocument
property that points to this document, but its parentNode
property is null, since it has not been inserted into the current document.
For more on node ownership, see ownerDocument issues in the W3C DOM FAQ.
Parameters
| Name | Type | Description |
|---|---|---|
importedNode | Titanium.XML.Node | Node to import. |
deep | Boolean | If true, recursively import the subtree under the specified node; if false, import only the node itself. |
Returns
Imported node that belongs now to this document.
- Type
- Titanium.XML.Node
# insertBefore
0.9 0.9 9.2.0Inserts the node newChild before the node refChild.
On iOS, insertBefore is supported on Titanium.XML.Element
nodes only.
Parameters
| Name | Type | Description |
|---|---|---|
newChild | Titanium.XML.Node | Node to insert. |
refChild | Titanium.XML.Node | Node to insert |
Returns
The inserted node.
- Type
- Titanium.XML.Node
# isSupported
0.9 0.9 9.2.0Tests whether the DOM implementation supports a specific feature.
Parameters
| Name | Type | Description |
|---|---|---|
feature | String | Name of the feature. |
version | String | Version number of the feature. |
Returns
True if the feature is supported, false if it is not.
- Type
- Boolean
# normalize
0.9Normalizes text and attribute nodes in this node's child hierarchy.
Returns
- Type
- void
# removeChild
0.9 0.9 9.2.0Removes a child node from this node.
On iOS, removeChild is supported on Titanium.XML.Element
nodes only.
Parameters
| Name | Type | Description |
|---|---|---|
oldChild | Titanium.XML.Node | Node to remove. |
Returns
Node that was removed.
- Type
- Titanium.XML.Node
# removeEventListener
0.9 0.9 9.2.0Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void
# replaceChild
0.9 0.9 9.2.0Replaces the node oldChild with the node newChild.
On iOS, replaceChild is supported on Titanium.XML.Element
nodes only.
Parameters
| Name | Type | Description |
|---|---|---|
newChild | Titanium.XML.Node | New node. |
oldChild | Titanium.XML.Node | Node being replaced. |
Returns
Node that was replaced.
- Type
- Titanium.XML.Node
# Constants
# ATTRIBUTE_NODE
0.9 0.9 9.2.0Used with nodeType to identify an Titanium.XML.Attr node.
# CDATA_SECTION_NODE
0.9 0.9 9.2.0Used with nodeType to identify a Titanium.XML.CDATASection node.
# COMMENT_NODE
0.9 0.9 9.2.0Used with nodeType to identify a Titanium.XML.Comment node.
# DOCUMENT_FRAGMENT_NODE
0.9 0.9 9.2.0Used with nodeType to identify a Titanium.XML.DocumentFragment node.
# DOCUMENT_NODE
0.9 0.9 9.2.0Used with nodeType to identify a Titanium.XML.Document node.
# DOCUMENT_TYPE_NODE
0.9 0.9 9.2.0Used with nodeType to identify a Titanium.XML.DocumentType node.
# ELEMENT_NODE
0.9 0.9 9.2.0Used with nodeType to identify an Titanium.XML.Element node.
# ENTITY_NODE
0.9 0.9 9.2.0Used with nodeType to identify an Titanium.XML.Entity node.
# ENTITY_REFERENCE_NODE
0.9 0.9 9.2.0Used with nodeType to identify an Titanium.XML.EntityReference node.
# NOTATION_NODE
0.9 0.9 9.2.0Used with nodeType to identify a Titanium.XML.Notation node.
# PROCESSING_INSTRUCTION_NODE
0.9 0.9 9.2.0Used with nodeType to identify a Titanium.XML.ProcessingInstruction node.
# TEXT_NODE
0.9 0.9 9.2.0Used with nodeType to identify a Titanium.XML.Text node.