{ "Titanium.XML.NodeList": { "properties": [ { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.NodeList.length-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The length of the node list.

", "type": "Number", "name": "length" } ], "description": null, "subtype": "proxy", "deprecated": null, "filename": "Titanium.XML.NodeList-object", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.NodeList.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.NodeList.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.XML.NodeList.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.NodeList.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.NodeList.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.XML.NodeList.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.NodeList.getLength-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the length property.

", "name": "getLength" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.NodeList.item-method.index-param", "optional": false, "summary": "

The index of the node to retrieve. Indexing starts at 0.

", "type": "Number", "name": "index" } ], "deprecated": null, "filename": "Titanium.XML.NodeList.item-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "Titanium.XML.Node", "summary": "The node at the index, or `null` if the index is out of bounds." }, "examples": [], "summary": "

Returns the Titanium.XML.Node object at the specified index.

", "name": "item" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.NodeList.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.NodeList.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.XML.NodeList.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" } ], "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

A list of Titanium.XML.Node objects. This conforms to the DOM Level 2 definition of a DOM NodeList.

", "type": "object", "events": [], "name": "Titanium.XML.NodeList" }, "Titanium.XML.Entity": { "properties": [ { "description": null, "permission": "read-only", "deprecated": null, "value": 2, "filename": "Titanium.XML.Entity.ATTRIBUTE_NODE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The value of when this node is a Titanium.XML.Attr

", "type": "Number", "name": "ATTRIBUTE_NODE" }, { "description": null, "permission": "read-only", "deprecated": null, "value": 4, "filename": "Titanium.XML.Entity.CDATA_SECTION_NODE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The value of when this node is a CData section (a type of Titanium.XML.Text)

", "type": "Number", "name": "CDATA_SECTION_NODE" }, { "description": null, "permission": "read-only", "deprecated": null, "value": 8, "filename": "Titanium.XML.Entity.COMMENT_NODE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The value of when this node is a Titanium.XML.Comment

", "type": "Number", "name": "COMMENT_NODE" }, { "description": null, "permission": "read-only", "deprecated": null, "value": 11, "filename": "Titanium.XML.Entity.DOCUMENT_FRAGMENT_NODE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The value of when this node is a Titanium.XML.DocumentFragment

", "type": "Number", "name": "DOCUMENT_FRAGMENT_NODE" }, { "description": null, "permission": "read-only", "deprecated": null, "value": 9, "filename": "Titanium.XML.Entity.DOCUMENT_NODE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The value of when this node is a Titanium.XML.Document

", "type": "Number", "name": "DOCUMENT_NODE" }, { "description": null, "permission": "read-only", "deprecated": null, "value": 10, "filename": "Titanium.XML.Entity.DOCUMENT_TYPE_NODE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The value of when this node is a Titanium.XML.DocumentType

", "type": "Number", "name": "DOCUMENT_TYPE_NODE" }, { "description": null, "permission": "read-only", "deprecated": null, "value": 1, "filename": "Titanium.XML.Entity.ELEMENT_NODE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The value of when this node is a Titanium.XML.Element

", "type": "Number", "name": "ELEMENT_NODE" }, { "description": null, "permission": "read-only", "deprecated": null, "value": 6, "filename": "Titanium.XML.Entity.ENTITY_NODE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The value of when this node is a Titanium.XML.Entity

", "type": "Number", "name": "ENTITY_NODE" }, { "description": null, "permission": "read-only", "deprecated": null, "value": 5, "filename": "Titanium.XML.Entity.ENTITY_REFERENCE_NODE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The value of when this node is an Entity reference (a type of Titanium.XML.Node)

", "type": "Number", "name": "ENTITY_REFERENCE_NODE" }, { "description": null, "permission": "read-only", "deprecated": null, "value": 12, "filename": "Titanium.XML.Entity.NOTATION_NODE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The value of when this node is a Titanium.XML.Notation

", "type": "Number", "name": "NOTATION_NODE" }, { "description": null, "permission": "read-only", "deprecated": null, "value": 7, "filename": "Titanium.XML.Entity.PROCESSING_INSTRUCTION_NODE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The value of when this node is a Titanium.XML.ProcessingInstruction

", "type": "Number", "name": "PROCESSING_INSTRUCTION_NODE" }, { "description": null, "permission": "read-only", "deprecated": null, "value": 3, "filename": "Titanium.XML.Entity.TEXT_NODE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The value of when this node is a Titanium.XML.Text

", "type": "Number", "name": "TEXT_NODE" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.attributes-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

A map of this node's attributes

", "type": "Titanium.XML.NamedNodeMap", "name": "attributes" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.childNodes-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

A Titanium.XML.NodeList of this node's children

", "type": "Titanium.XML.NodeList", "name": "childNodes" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.firstChild-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

This node's first child

", "type": "Titanium.XML.Node", "name": "firstChild" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.lastChild-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

This node's last child

", "type": "Titanium.XML.Node", "name": "lastChild" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.localName-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The local part of the qualified name of this node

", "type": "String", "name": "localName" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.namespaceURI-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The namespace URI of this node

", "type": "String", "name": "namespaceURI" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.nextSibling-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

This node's next sibling

", "type": "Titanium.XML.Node", "name": "nextSibling" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.nodeName-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The name of this node

", "type": "String", "name": "nodeName" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.nodeType-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

This node's type. One of , , , , , , , , , , ,

", "type": "Number", "name": "nodeType" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.nodeValue-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The content (value) of this node

", "type": "String", "name": "nodeValue" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.notationName-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

For unparsed entities, the name of the notation for the entity. For parsed entities, this is null.

", "type": "String", "name": "notationName" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.ownerDocument-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

This node's owning Document

", "type": "Titanium.XML.Document", "name": "ownerDocument" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.parentNode-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

This node's parent node

", "type": "Titanium.XML.Node", "name": "parentNode" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.prefix-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The namespace prefix of this node

", "type": "String", "name": "prefix" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.previousSibling-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

This node's previous sibling

", "type": "Titanium.XML.Node", "name": "previousSibling" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.publicId-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The public identifier associated with the entity, if specified. If the public identifier was not specified, this is null.

", "type": "String", "name": "publicId" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Entity.systemId-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The system identifier associated with the entity, if specified. If the system identifier was not specified, this is null.

", "type": "String", "name": "systemId" } ], "description": null, "subtype": "proxy", "deprecated": null, "filename": "Titanium.XML.Entity-object", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.XML.Entity.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.appendChild-method.newChild-param", "optional": false, "summary": "

The new node to append

", "type": "Titanium.XML.Node", "name": "newChild" } ], "deprecated": null, "filename": "Titanium.XML.Entity.appendChild-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "Titanium.XML.Node", "summary": "The appended node" }, "examples": [], "summary": "

Appends the node newChild as a child of this node

", "name": "appendChild" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.cloneNode-method.deep-param", "optional": false, "summary": "

Whether or not to perform a deep copy of this node

", "type": "Boolean", "name": "deep" } ], "deprecated": null, "filename": "Titanium.XML.Entity.cloneNode-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "Titanium.XML.Node", "summary": "The appended node" }, "examples": [], "summary": "

Returns a duplicate of this node

", "name": "cloneNode" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.XML.Entity.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getAttributes-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Titanium.XML.NamedNodeMap" } ], "examples": [], "summary": "

Gets the value of the attributes property.

", "name": "getAttributes" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getChildNodes-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Titanium.XML.NodeList" } ], "examples": [], "summary": "

Gets the value of the childNodes property.

", "name": "getChildNodes" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getFirstChild-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Titanium.XML.Node" } ], "examples": [], "summary": "

Gets the value of the firstChild property.

", "name": "getFirstChild" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getLastChild-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Titanium.XML.Node" } ], "examples": [], "summary": "

Gets the value of the lastChild property.

", "name": "getLastChild" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getLocalName-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the localName property.

", "name": "getLocalName" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getNamespaceURI-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the namespaceURI property.

", "name": "getNamespaceURI" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getNextSibling-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Titanium.XML.Node" } ], "examples": [], "summary": "

Gets the value of the nextSibling property.

", "name": "getNextSibling" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getNodeName-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the nodeName property.

", "name": "getNodeName" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getNodeType-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the nodeType property.

", "name": "getNodeType" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getNodeValue-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the nodeValue property.

", "name": "getNodeValue" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getNotationName-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the notationName property.

", "name": "getNotationName" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getOwnerDocument-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Titanium.XML.Document" } ], "examples": [], "summary": "

Gets the value of the ownerDocument property.

", "name": "getOwnerDocument" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getParentNode-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Titanium.XML.Node" } ], "examples": [], "summary": "

Gets the value of the parentNode property.

", "name": "getParentNode" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getPrefix-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the prefix property.

", "name": "getPrefix" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getPreviousSibling-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Titanium.XML.Node" } ], "examples": [], "summary": "

Gets the value of the previousSibling property.

", "name": "getPreviousSibling" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getPublicId-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the publicId property.

", "name": "getPublicId" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.getSystemId-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the systemId property.

", "name": "getSystemId" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.hasAttributes-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "Boolean" }, "examples": [], "summary": "

Whether or not this node has attributes

", "name": "hasAttributes" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.hasChildNodes-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "Boolean" }, "examples": [], "summary": "

Whether or not this node has child nodes

", "name": "hasChildNodes" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.insertBefore-method.newChild-param", "optional": false, "summary": "

The node to insert

", "type": "Titanium.XML.Node", "name": "newChild" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.insertBefore-method.refChild-param", "optional": false, "summary": "

The node to insert newChild before

", "type": "Titanium.XML.Node", "name": "refChild" } ], "deprecated": null, "filename": "Titanium.XML.Entity.insertBefore-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "Titanium.XML.Node", "summary": "The inserted node" }, "examples": [], "summary": "", "name": "insertBefore" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.isSupported-method.feature-param", "optional": false, "summary": "

The name of the feature

", "type": "String", "name": "feature" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.isSupported-method.version-param", "optional": false, "summary": "

The version number of the feature

", "type": "String", "name": "version" } ], "deprecated": null, "filename": "Titanium.XML.Entity.isSupported-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "Boolean", "summary": "Whether or not the feature is supported" }, "examples": [], "summary": "

Tests whether the DOM implementation supports a specific feature

", "name": "isSupported" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Entity.normalize-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Normalizes text and attribute nodes in this node's child hierarchy

", "name": "normalize" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.removeChild-method.oldChild-param", "optional": false, "summary": "

The node to remove

", "type": "Titanium.XML.Node", "name": "oldChild" } ], "deprecated": null, "filename": "Titanium.XML.Entity.removeChild-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "Titanium.XML.Node", "summary": "The node that was removed" }, "examples": [], "summary": "

Removes a child node from this node

", "name": "removeChild" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.XML.Entity.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.replaceChild-method.newChild-param", "optional": false, "summary": "

The new node

", "type": "Titanium.XML.Node", "name": "newChild" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.replaceChild-method.oldChild-param", "optional": false, "summary": "

The node being replaced

", "type": "Titanium.XML.Node", "name": "oldChild" } ], "deprecated": null, "filename": "Titanium.XML.Entity.replaceChild-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Replaces the node oldChild with the node newChild

", "name": "replaceChild" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Entity.setLocalName-method.localName-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "localName" } ], "deprecated": null, "filename": "Titanium.XML.Entity.setLocalName-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the localName property.

", "name": "setLocalName" } ], "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

This interface represents an entity, either parsed or unparsed, in an XML document. Note that this models the entity itself not the entity declaration. The nodeName attribute that is inherited from Node contains the name of the entity. An Entity node does not have any parent. This conforms to the DOM Level 2 defintion of a DOM Entity.

", "type": "object", "events": [], "name": "Titanium.XML.Entity" }, "Titanium.Android.NotificationManager": { "properties": [ { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.NotificationManager.DEFAULT_ALL-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Use all default values (where applicable).

", "type": "Number", "name": "DEFAULT_ALL" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.NotificationManager.DEFAULT_LIGHTS-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Use the default notification lights.

", "type": "Number", "name": "DEFAULT_LIGHTS" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.NotificationManager.DEFAULT_SOUND-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Use the default notification sound.

", "type": "Number", "name": "DEFAULT_SOUND" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.NotificationManager.DEFAULT_VIBRATE-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Use the default notification vibrate.

", "type": "Number", "name": "DEFAULT_VIBRATE" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.NotificationManager.FLAG_AUTO_CANCEL-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Bit to be bitwise-ored into the flags field that should be set if the notification should be canceled when it is clicked by the user.

", "type": "Number", "name": "FLAG_AUTO_CANCEL" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.NotificationManager.FLAG_INSISTENT-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Bit to be bitwise-ored into the flags field that if set, the audio will be repeated until the notification is cancelled or the notification window is opened.

", "type": "Number", "name": "FLAG_INSISTENT" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.NotificationManager.FLAG_NO_CLEAR-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Bit to be bitwise-ored into the flags field that should be set if the notification should not be canceled when the user clicks the Clear all button.

", "type": "Number", "name": "FLAG_NO_CLEAR" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.NotificationManager.FLAG_ONGOING_EVENT-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Bit to be bitwise-ored into the flags field that should be set if this notification is in reference to something that is ongoing, like a phone call.

", "type": "Number", "name": "FLAG_ONGOING_EVENT" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.NotificationManager.FLAG_ONLY_ALERT_ONCE-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Bit to be bitwise-ored into the flags field that should be set if you want the sound and/or vibration play each time the notification is sent, even if it has not been canceled before that.

", "type": "Number", "name": "FLAG_ONLY_ALERT_ONCE" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.NotificationManager.FLAG_SHOW_LIGHTS-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Bit to be bitwise-ored into the flags field that should be set if you want the LED on for this notification.

", "type": "Number", "name": "FLAG_SHOW_LIGHTS" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.NotificationManager.STREAM_DEFAULT-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Use this constant as the value for audioStreamType to request that the default stream type for notifications be used.

", "type": "Number", "name": "STREAM_DEFAULT" } ], "description": "

The NotificationManager module is a thin wrapper on the Android NotificationManager class.

\n

The constants in this module are derived from the Android Notification class.

", "subtype": null, "deprecated": null, "filename": "Titanium.Android.NotificationManager-module", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.NotificationManager.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.NotificationManager.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Android.NotificationManager.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.NotificationManager.cancel-method.id-param", "optional": false, "summary": "

The id you assigned to a notification.

", "type": "Number", "name": "id" } ], "deprecated": null, "filename": "Titanium.Android.NotificationManager.cancel-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Cancel a previously shown notification.

", "name": "cancel" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.NotificationManager.cancelAll-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Cancel all previously shown notifications.

", "name": "cancelAll" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.NotificationManager.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.NotificationManager.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.Android.NotificationManager.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.NotificationManager.notify-method.id-param", "optional": false, "summary": "

An id that may be used to cancel a shown notification.

", "type": "Number", "name": "id" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.NotificationManager.notify-method.notification-param", "optional": false, "summary": "

An instance of Titanium.Android.Notification created with Titanium.Android.createNotification.

", "type": "Titanium.Android.Notification", "name": "notification" } ], "deprecated": null, "filename": "Titanium.Android.NotificationManager.notify-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Add a persistent notification to the status bar.

", "name": "notify" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.NotificationManager.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.NotificationManager.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Android.NotificationManager.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" } ], "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "objects": [], "examples": [], "summary": "

Module to notify users of events that happen.

", "type": "module", "events": [], "name": "Titanium.Android.NotificationManager" }, "Titanium.Facebook": { "properties": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.accessToken-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

OAuth token set after a successful authorize.

", "type": "String", "name": "accessToken" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.appid-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

your Facebook application id. You need to set this for anything to work.

", "type": "String", "name": "appid" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.expirationDate-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Time at which the accessToken expires.

", "type": "Date", "name": "expirationDate" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.forceDialogAuth-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Set to false to enable \"Single-Sign-On\" in cases where the official Facebook app is on the device. Default is true, meaning the traditional, dialog-based authentication is used rather than Single-Sign-On. See Facebook Mobile Guide for details of their Single-Sign-On schem.

", "type": "Boolean", "name": "forceDialogAuth" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.loggedIn-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

returns true if the user has logged in

", "type": "Boolean", "name": "loggedIn" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.permissions-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

set/return an array of permissions to request for your app. Be sure the permissions you want are set before calling authorize.

", "type": "Object", "name": "permissions" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.uid-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

the unique user id returned from Facebook.

", "type": "String", "name": "uid" } ], "description": "

The Facebook module is used for connecting your application with \nFacebook through the Facebook Graph API \n(see requestWithGraphPath) or the deprecated \nFacebook REST API (see request).\nDue to how the facebook login process works on iOS, your app will need to have the following \nin your tiapp.xml if you target those platforms:

\n
<property name=\"ti.facebook.appid\">your_facebook_app_id_here</property>\n
\n

You must still set Ti.Facebook.appid within your app itself to use the facebook module.
\nThis property is used only for configuring your app to interface with the facebook \nlogin process.

\n

Previous Versions

\n

Titanium Mobile SDK 1.6.0 marked a significant change for this module. Older versions of \nthe module were not compatible with the new Graph API. Applications written for the \npre-1.6.0 version of this module will not work with the 1.6.0 and higher versions.
\nNor is the code shown in the examples here backwards-compatible with pre-1.6.0 Titanium \nMobile SDK.

", "subtype": null, "deprecated": null, "filename": "Titanium.Facebook-module", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Facebook.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Facebook.authorize-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Login the user (if not already logged in) and authorize your application. Be sure to set your desired permissions and your appid before calling this.

", "name": "authorize" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.createLoginButton-method.parameters-param", "optional": false, "summary": "

(Optional) A dictionary object with properties as defined in Titanium.Facebook.LoginButton.

", "type": "Dictionary", "name": "parameters" } ], "deprecated": null, "filename": "Titanium.Facebook.createLoginButton-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "Titanium.Facebook.LoginButton" }, "examples": [], "summary": "

Create and return an instance of Titanium.Facebook.LoginButton.

", "name": "createLoginButton" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.dialog-method.action-param", "optional": false, "summary": "

Specifies which dialog to show, such as \"feed\".

", "type": "String", "name": "action" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.dialog-method.params-param", "optional": false, "summary": "

A dictionary object for pre-filling some of the dialog's fields. See example.

", "type": "Object", "name": "params" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.dialog-method.callback-param", "optional": false, "summary": "

A callback for when dialog is completed/cancelled. The callback should accept a single argument which will be filled with a dictionary object concerning call results: items in the dictionary can be \"success\" (boolean), \"error\" (string with the error message), \"cancelled\" (set to true if user cancelled) and \"result\" (the data returned by Facebook.)

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Facebook.dialog-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Open a supported Facebook dialog. \"feed\" is just about the only useful one.

", "name": "dialog" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.Facebook.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Facebook.getAccessToken-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the accessToken property.

", "name": "getAccessToken" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Facebook.getAppid-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the appid property.

", "name": "getAppid" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Facebook.getExpirationDate-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Date" } ], "examples": [], "summary": "

Gets the value of the expirationDate property.

", "name": "getExpirationDate" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Facebook.getForceDialogAuth-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the forceDialogAuth property.

", "name": "getForceDialogAuth" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Facebook.getLoggedIn-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the loggedIn property.

", "name": "getLoggedIn" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Facebook.getPermissions-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Object" } ], "examples": [], "summary": "

Gets the value of the permissions property.

", "name": "getPermissions" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Facebook.getUid-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the uid property.

", "name": "getUid" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Facebook.logout-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Clear the OAuth accessToken and logout the user.

", "name": "logout" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Facebook.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.request-method.method-param", "optional": false, "summary": "

The REST API method to call.

", "type": "String", "name": "method" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.request-method.params-param", "optional": false, "summary": "

A dictionary object for setting parameters required by the call, if any. See examples.

", "type": "Object", "name": "params" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.request-method.callback-param", "optional": false, "summary": "

A callback for when call is completed. The callback should accept a single argument which will be filled with a dictionary object concerning call results: items in the dictionary can be \"success\" (boolean), \"error\" (string with the error message), \"method\" (the REST method call you specified), \"result\" (the data returned by Facebook.)

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Facebook.request-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Make a request to the deprecated Facebook REST API.

", "name": "request" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.requestWithGraphPath-method.path-param", "optional": false, "summary": "

The graph API path to request. For example, \"me\" requests information about the logged-in user.

", "type": "String", "name": "path" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.requestWithGraphPath-method.params-param", "optional": false, "summary": "

A dictionary object for setting parameters required by the call, if any. See examples.

", "type": "Object", "name": "params" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.requestWithGraphPath-method.httpMethod-param", "optional": false, "summary": "

The http method (GET/POST/DELETE) to use for the call.

", "type": "String", "name": "httpMethod" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.requestWithGraphPath-method.callback-param", "optional": false, "summary": "

A callback for when call is completed. The callback should accept a single argument which will be filled with a dictionary object concerning call results: items in the dictionary can be \"success\" (boolean), \"error\" (string with the error message), \"path\" (the graph call path you specified), \"result\" (the JSON returned by Facebook.)

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Facebook.requestWithGraphPath-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Make a Facebook Graph API request. If the request requires user authorization, be sure user is already logged-in and your app is authorized. (You can check loggedIn for that.)

", "name": "requestWithGraphPath" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.setAccessToken-method.accessToken-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "accessToken" } ], "deprecated": null, "filename": "Titanium.Facebook.setAccessToken-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the accessToken property.

", "name": "setAccessToken" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.setAppid-method.appid-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "appid" } ], "deprecated": null, "filename": "Titanium.Facebook.setAppid-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the appid property.

", "name": "setAppid" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.setExpirationDate-method.expirationDate-param", "optional": false, "summary": "

New value for the property.

", "type": "Date", "name": "expirationDate" } ], "deprecated": null, "filename": "Titanium.Facebook.setExpirationDate-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the expirationDate property.

", "name": "setExpirationDate" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.setForceDialogAuth-method.forceDialogAuth-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "forceDialogAuth" } ], "deprecated": null, "filename": "Titanium.Facebook.setForceDialogAuth-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the forceDialogAuth property.

", "name": "setForceDialogAuth" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.setLoggedIn-method.loggedIn-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "loggedIn" } ], "deprecated": null, "filename": "Titanium.Facebook.setLoggedIn-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the loggedIn property.

", "name": "setLoggedIn" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.setPermissions-method.permissions-param", "optional": false, "summary": "

New value for the property.

", "type": "Object", "name": "permissions" } ], "deprecated": null, "filename": "Titanium.Facebook.setPermissions-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the permissions property.

", "name": "setPermissions" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.setUid-method.uid-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "uid" } ], "deprecated": null, "filename": "Titanium.Facebook.setUid-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the uid property.

", "name": "setUid" } ], "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "objects": [ "Titanium.Facebook.LoginButton" ], "examples": [ { "code": "

Shows official Facebook dialog for logging in the user and prompting the user to approve your requested permissions. Listen for the module's \"login\" event to determine success/failure.

\n
Titanium.Facebook.appid = '[YOUR APPID]';\nTitanium.Facebook.permissions = ['publish_stream']; // Permissions your app needs\nTitanium.Facebook.addEventListener('login', function(e) {\n    if (e.success) {\n        alert('Logged In');\n    } else if (e.error) {\n        alert(e.error);\n    } else if (e.cancelled) {\n        alert(\"Cancelled\");\n    }\n});\nTitanium.Facebook.authorize();\n
", "description": "Authorize" }, { "code": "

Logout the user and forget the authorization token. Listen for the module's \"logout\" event to determine when logout is finished.

\n
Titanium.Facebook.addEventListener('logout', function(e) {\n    alert('Logged out');\n});\nTitanium.Facebook.logout();\n
", "description": "Logout" }, { "code": "

We've provided the Facebook-themed LoginButton which updates its state automatically depending on whether the user is logged-in or not. I.e., when the user is logged-in, then the button will show \"Logout\", and vice-versa.

\n

Note that you don't need to set a click listener or anything else on the button. It \"just works\". To listen for the actual login and logout events (which are part of the Titanium Facebook module and not specific to the login button), add listeners at the module level as in the example below.

\n
// Don't forget to set your appid and requested permissions, else the login button\n// won't be effective.\nTitanium.Facebook.appid = '[your appid]';\nTitanium.Facebook.permissions = ['publish_stream'];\nTitanium.Facebook.addEventListener('login', function(e) {\n    if (e.success) {\n        alert('Logged in');\n    }\n});\nTitanium.Facebook.addEventListener('logout', function(e) {\n    alert('Logged out');\n});\n\n// add the button.  Note that it doesn't need a click event or anything.\nTitanium.UI.currentWindow.add(Titanium.Facebook.createLoginButton({ top: 50, style: 'wide' }));\n
\n

The style:'wide' shows a wide version of the button that displays \"Connect with Facebook\" instead of just \"Connect\".

", "description": "Authorize/Logout via the special LoginButton" }, { "code": "

This example makes a call to the \"me\" graph path and displays the results, which will be JSON from Facebook. It assumes the user is already logged-in (you can check this with Titanium.Facebook.loggedIn.)

\n
Titanium.Facebook.requestWithGraphPath('me', {}, 'GET', function(e) {\n    if (e.success) {\n        alert(e.result);\n    } else if (e.error) {\n        alert(e.error);\n    } else {\n        alert('Unknown response');\n    }\n});\n
", "description": "Simple Graph API call" }, { "code": "

This example uses the Graph API to create an event in the logged-on user's Facebook account. This requires the \"create_event\" permission.

\n
// First make sure this permission exists\nTitanium.Facebook.permissions = ['create_event'];\nTitanium.Facebook.authorize();\n\n// ...\n// ...\n\n// Now create the event after you've confirmed authorize() was successful.\nvar starttime = new Date(2011, 4, 31, 17, 0);\nvar endtime = new Date(2011, 4, 31, 19, 0);\nvar title = \"Barry's Birthday Celebration\";\nvar description = \"Barry will have a great party\";\nvar data = {\n    start_time: JSON.stringify(starttime), // API expects a JSON stringified date\n    end_time: JSON.stringify(endtime),\n    summary: description,\n    name: title\n};\nTitanium.Facebook.requestWithGraphPath('me/events', data, 'POST', function(e) {\n    if (e.success) {\n        alert(\"Success! Returned from FB: \" + e.result);\n    } else {\n        if (e.error) {\n            alert(e.error);\n        } else {\n            alert(\"Unknown result\");\n        }\n    }\n});\n
", "description": "Create an Event with Graph API" }, { "code": "

Use the Graph API to set the user's Facebook status. Requires the \"publish_stream\" permissions.

\n
// First make sure this permission exists\nTitanium.Facebook.permissions = ['publish_stream'];\nTitanium.Facebook.authorize();\n\n// ...\n// ...\n\n// Now create the status message after you've confirmed that authorize() succeeded\nTitanium.Facebook.requestWithGraphPath('me/feed', {message: \"Trying out FB Graph API and it's fun!\"}, \"POST\", function(e) {\n    if (e.success) {\n        alert(\"Success!  From FB: \" + e.result);\n    } else {\n        if (e.error) {\n            alert(e.error);\n        } else {\n            alert(\"Unkown result\");\n        }\n    }\n});\n
", "description": "Set user's Facebook status with Graph API" }, { "code": "

This example posts a photo to the user's account using the Graph API. Another example below shows how to do this with the REST API, if desired. This requires the \"publish_stream\" permission.

\n
// First make sure this permission exists\nTitanium.Facebook.permissions = ['publish_stream'];\nTitanium.Facebook.authorize();\n\n// ...\n// ...\n\n// Now post the photo after you've confirmed that authorize() succeeded\nvar f = Ti.Filesystem.getFile('pumpkin.jpg');\nvar blob = f.read();\nvar data = {\n    message: 'This is a pumpkin',\n    picture: blob\n};\nTitanium.Facebook.requestWithGraphPath('me/photos', data, 'POST', function(e){\n    if (e.success) {\n        alert(\"Success!  From FB: \" + e.result);\n    } else {\n        if (e.error) {\n            alert(e.error);\n        } else {\n            alert(\"Unkown result\");\n        }\n    }\n});\n
", "description": "Post a photo using the Graph API" }, { "code": "

This example posts a photo to the user's account using the REST API. Another example above shows how to do this with the Graph API. This requires the \"publish_stream\" permission.

\n
// First make sure this permission exists\nTitanium.Facebook.permissions = ['publish_stream'];\nTitanium.Facebook.authorize();\n\n// ...\n// ...\n\n// Now post the photo after you've confirmed that authorize() succeeded\nvar f = Ti.Filesystem.getFile('pumpkin.jpg');\nvar blob = f.read();\nvar data = {\n    caption: 'This is a pumpkin',\n    picture: blob\n};\nTitanium.Facebook.request('photos.upload', data, function(e){\n    if (e.success) {\n        alert(\"Success!  From FB: \" + e.result);\n    } else {\n        if (e.error) {\n            alert(e.error);\n        } else {\n            alert(\"Unkown result\");\n        }\n    }\n});\n
", "description": "Post a photo using the REST API" }, { "code": "

This example shows how to display the official Facebook dialog for making a post to the user's feed. In this example, we'll prefill some of the feed fields by passing a data dictionary to the dialog() method; this is not required.

\n
var data = {\n    link: \"http://www.appcelerator.com\",\n    name: \"Appcelerator Titanium Mobile\",\n    message: \"Checkout this cool open source project for creating mobile apps\",\n    caption: \"Appcelerator Titanium Mobile\",\n    picture: \"http://developer.appcelerator.com/assets/img/DEV_titmobile_image.png\",\n    description: \"You've got the ideas, now you've got the power. Titanium translates your hard won web skills into native applications...\"\n};\nTitanium.Facebook.dialog(\"feed\", data, function(e) {\n    if (e.success) {\n        alert(\"Success!  From FB: \" + e.result);\n    } else {\n        if (e.error) {\n            alert(e.error);\n        } else if (e.cancelled) {\n            alert('Cancelled');\n        } else {\n            alert(\"Unkown result\");\n        }\n    }\n});\n
", "description": "Show the Facebook Feed Dialog" } ], "summary": "

The top level Facebook module.
\n

", "type": "module", "events": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.login-event", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

fired at session login

", "properties": [ { "deprecated": null, "description": null, "filename": "Titanium.Facebook.login.cancelled-callback-property", "name": "cancelled", "summary": "

true if the user cancelled the request by closing the dialog

" }, { "deprecated": null, "description": null, "filename": "Titanium.Facebook.login.data-callback-property", "name": "data", "summary": "

data returned by Facebook when we query for the uid (using graph path \"me\") after successful login. Data is in JSON format. Includes information such as user name, locale and gender.

" }, { "deprecated": null, "description": null, "filename": "Titanium.Facebook.login.error-callback-property", "name": "error", "summary": "

error message if success was false

" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.login.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "deprecated": null, "description": null, "filename": "Titanium.Facebook.login.success-callback-property", "name": "success", "summary": "

true if the login was successful

" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.login.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" }, { "deprecated": null, "description": null, "filename": "Titanium.Facebook.login.uid-callback-property", "name": "uid", "summary": "

the user id returned by Facebook if the login was successful.

" } ], "name": "login" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.logout-event", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

fired at session logout

", "properties": [ { "description": null, "deprecated": null, "filename": "Titanium.Facebook.logout.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.Facebook.logout.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" } ], "name": "logout" } ], "name": "Titanium.Facebook" }, "Titanium.Map": { "properties": [ { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Map.HYBRID_TYPE-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Displays a satellite image of the area with road and road name information layered on top.

", "type": "Number", "name": "HYBRID_TYPE" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Map.SATELLITE_TYPE-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Displays satellite imagery of the area.

", "type": "Number", "name": "SATELLITE_TYPE" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Map.STANDARD_TYPE-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Displays a street map that shows the position of all roads and some road names.

", "type": "Number", "name": "STANDARD_TYPE" } ], "description": null, "subtype": null, "deprecated": null, "filename": "Titanium.Map-module", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Map.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Map.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Map.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Map.createAnnotation-method.parameters-param", "optional": false, "summary": "

(Optional) A dictionary object with properties as defined in Titanium.Map.Annotation.

", "type": "Dictionary", "name": "parameters" } ], "deprecated": null, "filename": "Titanium.Map.createAnnotation-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "Titanium.Map.Annotation" }, "examples": [], "summary": "

Create and return an instance of Titanium.Map.Annotation.

", "name": "createAnnotation" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Map.createView-method.parameters-param", "optional": false, "summary": "

(Optional) A dictionary object with properties as defined in Titanium.Map.View.

", "type": "Dictionary", "name": "parameters" } ], "deprecated": null, "filename": "Titanium.Map.createView-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "Titanium.Map.View" }, "examples": [], "summary": "

Create and return an instance of Titanium.Map.View.

", "name": "createView" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Map.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Map.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.Map.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Map.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Map.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Map.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" } ], "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "objects": [ "Titanium.Map.View", "Titanium.Map.Annotation" ], "examples": [ { "code": "

This is a basic map example that uses a custom annotation on the map.

\n
var mountainView = Titanium.Map.createAnnotation({\n    latitude:37.390749,\n    longitude:-122.081651,\n    title:\"Appcelerator Headquarters\",\n    subtitle:'Mountain View, CA',\n    pincolor:Titanium.Map.ANNOTATION_RED,\n    animate:true,\n    leftButton: '../images/appcelerator_small.png',\n    myid:1 // CUSTOM ATTRIBUTE THAT IS PASSED INTO EVENT OBJECTS\n});\n\nvar mapview = Titanium.Map.createView({\n    mapType: Titanium.Map.STANDARD_TYPE,\n    region: {latitude:33.74511, longitude:-84.38993, \n            latitudeDelta:0.01, longitudeDelta:0.01},\n    animate:true,\n    regionFit:true,\n    userLocation:true,\n    annotations:[mountainView]\n});\n\nwin.add(mapview);\n
", "description": "Map Example" } ], "summary": "

The top level Map module. The Map module is used for creating in-application native maps.

", "type": "module", "events": [], "name": "Titanium.Map" }, "Titanium.BlobStream": { "properties": [], "description": null, "subtype": "proxy", "deprecated": null, "filename": "Titanium.BlobStream-object", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.BlobStream.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.BlobStream.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.BlobStream.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "1.7", "name": "android" }, { "pretty_name": "iPhone", "since": "1.7", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.7", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.BlobStream.close-method", "platforms": [ { "pretty_name": "Android", "since": "1.7", "name": "android" }, { "pretty_name": "iPhone", "since": "1.7", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.7", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

closes stream and throws exception on error

", "name": "close" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.BlobStream.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.BlobStream.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.BlobStream.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "1.7", "name": "android" }, { "pretty_name": "iPhone", "since": "1.7", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.7", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.BlobStream.isReadable-method", "platforms": [ { "pretty_name": "Android", "since": "1.7", "name": "android" }, { "pretty_name": "iPhone", "since": "1.7", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.7", "name": "ipad" } ], "returns": { "type": "Boolean", "summary": "true if stream is readable, false otherwise" }, "examples": [], "summary": "

Whether stream is readable.

", "name": "isReadable" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.BlobStream.isWriteable-method", "platforms": [ { "pretty_name": "Android", "since": "1.7", "name": "android" }, { "pretty_name": "iPhone", "since": "1.7", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.7", "name": "ipad" } ], "returns": { "type": "Boolean", "summary": "true if stream is writeable, false otherwise" }, "examples": [], "summary": "

Whether stream is writeable.

", "name": "isWriteable" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.BlobStream.read-method.buffer-param", "optional": false, "summary": "

buffer to read stream data into

", "type": "Titanium.Buffer", "name": "buffer" } ], "deprecated": null, "filename": "Titanium.BlobStream.read-method", "platforms": [ { "pretty_name": "Android", "since": "1.7", "name": "android" }, { "pretty_name": "iPhone", "since": "1.7", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.7", "name": "ipad" } ], "returns": { "type": "Number", "summary": "Number of bytes read." }, "examples": [], "summary": "

reads data from stream into a buffer

", "name": "read" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.BlobStream.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.BlobStream.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.BlobStream.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "1.7", "name": "android" }, { "pretty_name": "iPhone", "since": "1.7", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.7", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.BlobStream.write-method.buffer-param", "optional": false, "summary": "

buffer to write to stream

", "type": "Titanium.Buffer", "name": "buffer" } ], "deprecated": null, "filename": "Titanium.BlobStream.write-method", "platforms": [ { "pretty_name": "Android", "since": "1.7", "name": "android" }, { "pretty_name": "iPhone", "since": "1.7", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.7", "name": "ipad" } ], "returns": { "type": "Number", "summary": "Number of bytes written." }, "examples": [], "summary": "

writes data from buffer to stream

", "name": "write" } ], "platforms": [ { "pretty_name": "Android", "since": "1.7", "name": "android" }, { "pretty_name": "iPhone", "since": "1.7", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.7", "name": "ipad" } ], "examples": [], "summary": "

Wrapper around Titanium.Blob that implements the Titanium.IOStream interface

", "type": "object", "events": [], "name": "Titanium.BlobStream" }, "Titanium.XML.Notation": { "properties": [ { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Notation.publicId-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The public identifier of this notation. If the public identifier was not specified, this is null.

", "type": "String", "name": "publicId" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.XML.Notation.systemId-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

The system identifier of this notation. If the system identifier was not specified, this is null.

", "type": "String", "name": "systemId" } ], "description": null, "subtype": "proxy", "deprecated": null, "filename": "Titanium.XML.Notation-object", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Notation.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.Notation.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.XML.Notation.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Notation.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.Notation.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.XML.Notation.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Notation.getPublicId-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the publicId property.

", "name": "getPublicId" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.XML.Notation.getSystemId-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the systemId property.

", "name": "getSystemId" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.XML.Notation.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.XML.Notation.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.XML.Notation.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" } ], "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

represents a notation declared in the DTD. See DOM Level 2 Spec

", "type": "object", "events": [], "name": "Titanium.XML.Notation" }, "Titanium.Media.AudioPlayer": { "properties": [ { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.STATE_BUFFERING-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Audio data is being buffered from the network.

", "type": "Number", "name": "STATE_BUFFERING" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.STATE_INITIALIZED-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Audio playback is being initialized.

", "type": "Number", "name": "STATE_INITIALIZED" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.STATE_PAUSED-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Playback is paused.

", "type": "Number", "name": "STATE_PAUSED" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.STATE_PLAYING-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Audio playback is active.

", "type": "Number", "name": "STATE_PLAYING" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.STATE_STARTING-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Audio playback is starting.

", "type": "Number", "name": "STATE_STARTING" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.STATE_STOPPED-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Audio playback is stopped.

", "type": "Number", "name": "STATE_STOPPED" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.STATE_STOPPING-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Audio playback is stopping.

", "type": "Number", "name": "STATE_STOPPING" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.STATE_WAITING_FOR_DATA-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Player is waiting for audio data from the network.

", "type": "Number", "name": "STATE_WAITING_FOR_DATA" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.STATE_WAITING_FOR_QUEUE-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Player is waiting for audio data to fill the queue.

", "type": "Number", "name": "STATE_WAITING_FOR_QUEUE" }, { "description": "

Setting allowBackground to true allows the audio to continue playing, for\nexample, if the application is in the background.

", "default": false, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.allowBackground-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" } ], "examples": [], "summary": "

Boolean to indicate if audio should continue playing even if the associated\nAndroid Activity is paused.

", "type": "Boolean", "availability": "creation", "name": "allowBackground" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.bitRate-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Bit rate of the current playback stream.

", "type": "Number", "name": "bitRate" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.bufferSize-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Size of the buffer used for streaming, in bytes.

", "type": "Number", "name": "bufferSize" }, { "description": "

true if the player is in the initialized state: that is, not playing, paused, \nor waiting for data.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.idle-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Boolean indicating if the player is idle.

", "type": "Boolean", "name": "idle" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.paused-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Boolean indicating if audio playback is paused.

", "type": "Boolean", "name": "paused" }, { "description": "

Returns false if playback is stopped or paused.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.playing-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Boolean indicating if audio is currently playing.

", "type": "Boolean", "name": "playing" }, { "description": "

Returns zero if bitRate has not yet been detected.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.progress-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Current playback progress, in milliseconds.

", "type": "Number", "name": "progress" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.state-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Current state of playback, specified using one of the STATE constants defined on this object.

", "type": "Number", "name": "state" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.url-property", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

URL for the audio stream.

", "type": "String", "name": "url" }, { "description": "

This property is true if the player is in any of the waiting states, including\nbuffering, starting, waiting for data, and waiting for queue.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.waiting-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [], "summary": "

Boolean indicating if the playback is waiting for audio data from the network.

", "type": "Boolean", "name": "waiting" } ], "description": "

On Android, when you are done playing a given audio file, you must call the \nrelease method to stop buffering audio data and \nrelease associated system resources.

\n

On iOS, you can control how the audio stream interacts with other system sounds\nby setting Titanium.Media.audioSessionMode.

\n

Use the Titanium.Media.createAudioPlayer method to create an audio player.

", "subtype": "proxy", "deprecated": null, "filename": "Titanium.Media.AudioPlayer-object", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.getAllowBackground-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the allowBackground property.

", "name": "getAllowBackground" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.getBitRate-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the bitRate property.

", "name": "getBitRate" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.getBufferSize-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the bufferSize property.

", "name": "getBufferSize" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.getIdle-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the idle property.

", "name": "getIdle" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.getPaused-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "Boolean" }, "examples": [], "summary": "

Returns the value of the paused property.

", "name": "getPaused" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.getPlaying-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "Boolean" }, "examples": [], "summary": "

Returns the value of the playing property.

", "name": "getPlaying" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.getProgress-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the progress property.

", "name": "getProgress" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.getState-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the state property.

", "name": "getState" }, { "description": "

This method is not exposed on Android. Access the url property directly instead:

\n
currentURL = myAudioPlayer.url;\n
", "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.getUrl-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "String" }, "examples": [], "summary": "

Returns the value of the url property.

", "name": "getUrl" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.getWaiting-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the waiting property.

", "name": "getWaiting" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.isPaused-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" } ], "returns": { "type": "Boolean" }, "examples": [], "summary": "

Returns the value of the paused property.

", "name": "isPaused" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.isPlaying-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" } ], "returns": { "type": "Boolean" }, "examples": [], "summary": "

Returns the value of the playing property.

", "name": "isPlaying" }, { "description": "

On iOS, the pause call operates as a toggle. If the stream is already paused,\ncalling pause again resumes playing the stream.

\n

On Android, the pause call does nothing if the stream is already paused.

\n

On both platforms, calling start on a paused\nstream resumes play.

", "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.pause-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Pauses audio playback.

", "name": "pause" }, { "description": "

This method is identical to start.

", "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.play-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Starts or resumes audio playback.

", "name": "play" }, { "description": "

On Android, this method should be called when you are done streaming a given\naudio object, to release underlying resources, including buffered data.

", "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.release-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Stops buffering audio data and releases audio resources.

", "name": "release" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.setBitRate-method.bitRate-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "bitRate" } ], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.setBitRate-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the bitRate property.

", "name": "setBitRate" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.setBufferSize-method.bufferSize-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "bufferSize" } ], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.setBufferSize-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the bufferSize property.

", "name": "setBufferSize" }, { "description": "

On iOS, this method can be used to pause and unpause playback. For portability,\nit is preferable to use the pause and \nstart methods instead.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.setPaused-method.paused-param", "optional": false, "summary": "

Pass true to pause the current playback temporarily, false to unpause it.

", "type": "Boolean", "name": "paused" } ], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.setPaused-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the paused property.

", "name": "setPaused" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.setUrl-method.url-param", "optional": false, "summary": "

URL to stream audio from.

", "type": "String", "name": "url" } ], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.setUrl-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the url property.

", "name": "setUrl" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.start-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Starts or resumes audio playback.

", "name": "start" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.stateDescription-method.state-param", "optional": false, "summary": "

State value to convert.

", "type": "Number", "name": "state" } ], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.stateDescription-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "String" }, "examples": [], "summary": "

Converts a state value into a text description\nsuitable for display.

", "name": "stateDescription" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Media.AudioPlayer.stop-method", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Stops audio playback.

", "name": "stop" } ], "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "examples": [ { "code": "

The following example demonstrates using the AudioPlayer object to stream audio.

\n
var win = Titanium.UI.createWindow({  \n    title:'Audio Test',\n    backgroundColor:'#fff',\n    layout: 'vertical'\n});\n\nvar startStopButton = Titanium.UI.createButton({\n    title:'Start/Stop Streaming',\n    top:10,\n    width:200,\n    height:40\n});\n\nvar pauseResumeButton = Titanium.UI.createButton({\n    title:'Pause/Resume Streaming',\n    top:10,\n    width:200,\n    height:40,\n    enabled:false\n});\n\nwin.add(startStopButton);\nwin.add(pauseResumeButton);\n\n// allowBackground: true on Android allows the \n// player to keep playing when the app is in the \n// background.\nvar audioPlayer = Ti.Media.createAudioPlayer({ \n    url: 'www.example.com/podcast.mp3',\n    allowBackground: true\n});\n\nstartStopButton.addEventListener('click',function() {\n    // When paused, playing returns false.\n    // If both are false, playback is stopped.\n    if (audioPlayer.playing || audioPlayer.paused)\n    {\n        audioPlayer.stop();\n        pauseResumeButton.enabled = false;\n        if (Ti.Platform.name === 'android')\n        { \n            audioPlayer.release();\n        }   \n    }\n    else\n    {\n        audioPlayer.start();\n        pauseResumeButton.enabled = true;\n    }\n});\n\npauseResumeButton.addEventListener('click', function() {\n    if (audioPlayer.paused) {\n        audioPlayer.start();\n    }\n    else {\n        audioPlayer.pause();\n    }\n});\n\naudioPlayer.addEventListener('progress',function(e) {\n    Ti.API.info('Time Played: ' + Math.round(e.progress) + ' milliseconds');\n});\n\naudioPlayer.addEventListener('change',function(e)\n{\n    Ti.API.info('State: ' + e.description + ' (' + e.state + ')');\n});\n\nwin.addEventListener('close',function() {\n    audioPlayer.stop();\n    if (Ti.Platform.osname === 'android')\n    { \n        audioPlayer.release();\n    }\n});\n\nwin.open();\n
", "description": "Audio Streaming" } ], "summary": "

An audio player object used for streaming audio to the device, and low-level control of the audio playback.

", "type": "object", "events": [ { "description": "

This event can be generated by programmatic events, such as pausing or stopping the audio,\nand also by external events, such as the current state of network buffering.

", "deprecated": null, "filename": "Titanium.Media.AudioPlayer.change-event", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "summary": "

Fired when the state of the playback changes.

", "properties": [ { "deprecated": null, "description": null, "filename": "Titanium.Media.AudioPlayer.change.description-callback-property", "name": "description", "summary": "

Text description of the state of playback.

" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.change.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.change.state-callback-property", "summary": "

Current state of playback, specified using one of the STATE constants defined on this object.

", "type": "Number", "name": "state" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.change.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" } ], "name": "change" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.progress-event", "platforms": [ { "pretty_name": "Android", "since": "0.9", "name": "android" }, { "pretty_name": "iPhone", "since": "0.9", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.9", "name": "ipad" } ], "summary": "

Fired once per second with the current progress during playback.

", "properties": [ { "deprecated": null, "description": null, "filename": "Titanium.Media.AudioPlayer.progress.progress-callback-property", "name": "progress", "summary": "

Current progress, in milliseconds.

" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.progress.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.AudioPlayer.progress.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" } ], "name": "progress" } ], "name": "Titanium.Media.AudioPlayer" }, "Titanium.Network": { "properties": [ { "description": null, "permission": "read-only", "deprecated": { "since": "1.7.0" }, "filename": "Titanium.Network.INADDR_ANY-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Special hostname value for listening sockets, representing all\nlocally available network interfaces.

", "type": "String", "name": "INADDR_ANY" }, { "description": "

This network type is only used by the Mobile Web platform, when the application\nis running in a desktop browser attached to a LAN.

\n

This constant is also a possible value for the networkType property of the \nchange event.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.NETWORK_LAN-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

A networkType value indicating that the device is\ncommunicating over a local-area network.

", "type": "Number", "name": "NETWORK_LAN" }, { "description": "

This constant is also a possible value for the networkType property of the \nchange event.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.NETWORK_MOBILE-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

A networkType value indicating that the device is\ncommunicating over a mobile network.

", "type": "Number", "name": "NETWORK_MOBILE" }, { "description": "

This constant is also a possible value for the networkType property of the \nchange event.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.NETWORK_NONE-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

A networkType value indicating that no \nnetwork is available.

", "type": "Number", "name": "NETWORK_NONE" }, { "description": "

This constant is also a possible value for the networkType property of the \nchange event.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.NETWORK_UNKNOWN-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

A networkType value indicating that the
\ncurrent network type is unknown.

", "type": "Number", "name": "NETWORK_UNKNOWN" }, { "description": "

This constant is also a possible value for the networkType property of the \nchange event.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.NETWORK_WIFI-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

A networkType value indicating that the
\ndevice is communicating over a WiFi network.

", "type": "Number", "name": "NETWORK_WIFI" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.NOTIFICATION_TYPE_ALERT-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant value for an Alert style push notification.

", "type": "Number", "name": "NOTIFICATION_TYPE_ALERT" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.NOTIFICATION_TYPE_BADGE-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant value for a Badge style push notification.

", "type": "Number", "name": "NOTIFICATION_TYPE_BADGE" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.NOTIFICATION_TYPE_SOUND-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant value for a Sound style push notification.

", "type": "Number", "name": "NOTIFICATION_TYPE_SOUND" }, { "description": "

Used with the deprecated Titanium.Network.TCPSocket only.

", "permission": "read-only", "deprecated": { "since": "1.7.0" }, "filename": "Titanium.Network.READ_MODE-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Constant value specifying read-only mode for sockets.

", "type": "Number", "name": "READ_MODE" }, { "description": "

Used with the deprecated Titanium.Network.TCPSocket only.

", "permission": "read-only", "deprecated": { "since": "1.7.0" }, "filename": "Titanium.Network.READ_WRITE_MODE-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Constant value specifying read-write mode for sockets.

", "type": "Number", "name": "READ_WRITE_MODE" }, { "description": "

Used with the deprecated Titanium.Network.TCPSocket only.

\n

See Titanium.Network.Socket for constants used with\nTitanium.Network.Socket.TCP sockets.

", "permission": "read-only", "deprecated": { "since": "1.7.0" }, "filename": "Titanium.Network.SOCKET_CLOSED-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant value representing a socket in the CLOSED state.

", "type": "Number", "name": "SOCKET_CLOSED" }, { "description": "

Used with the deprecated Titanium.Network.TCPSocket only.

\n

See Titanium.Network.Socket for constants used with\nTitanium.Network.Socket.TCP sockets.

", "permission": "read-only", "deprecated": { "since": "1.7.0" }, "filename": "Titanium.Network.SOCKET_CONNECTED-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant value representing a socket in the CONNECTED state.

", "type": "Number", "name": "SOCKET_CONNECTED" }, { "description": "

Used with the deprecated Titanium.Network.TCPSocket only.

\n

See Titanium.Network.Socket for constants used with\nTitanium.Network.Socket.TCP sockets.

", "permission": "read-only", "deprecated": { "since": "1.7.0" }, "filename": "Titanium.Network.SOCKET_ERROR-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant value representing a socket in the ERROR state.

", "type": "Number", "name": "SOCKET_ERROR" }, { "description": "

Used with the deprecated Titanium.Network.TCPSocket only.

\n

See Titanium.Network.Socket for constants used with\nTitanium.Network.Socket.TCP sockets.

", "permission": "read-only", "deprecated": { "since": "1.7.0" }, "filename": "Titanium.Network.SOCKET_INITIALIZED-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant value representing a socket in the INITIALIZED state.

", "type": "Number", "name": "SOCKET_INITIALIZED" }, { "description": "

Used with the deprecated Titanium.Network.TCPSocket only.

\n

See Titanium.Network.Socket for constants used with\nTitanium.Network.Socket.TCP sockets.

", "permission": "read-only", "deprecated": { "since": "1.7.0" }, "filename": "Titanium.Network.SOCKET_LISTENING-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant value representing a socket in the LISTENING state.

", "type": "Number", "name": "SOCKET_LISTENING" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.TLS_VERSION_1_0-property", "platforms": [ { "pretty_name": "iPhone", "since": "1.8.0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.8.0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant value specifying TLS version 1.0 for SSL.

", "type": "Number", "name": "TLS_VERSION_1_0" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.TLS_VERSION_1_1-property", "platforms": [ { "pretty_name": "iPhone", "since": "1.8.0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.8.0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant value specifying TLS version 1.1 for SSL.

", "type": "Number", "name": "TLS_VERSION_1_1" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.TLS_VERSION_1_2-property", "platforms": [ { "pretty_name": "iPhone", "since": "1.8.0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.8.0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant value specifying TLS version 1.2 for SSL.

", "type": "Number", "name": "TLS_VERSION_1_2" }, { "description": "

Used with the deprecated Titanium.Network.TCPSocket only.

", "permission": "read-only", "deprecated": { "since": "1.7.0" }, "filename": "Titanium.Network.WRITE_MODE-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Constant value specifying write-only mode for sockets.

", "type": "Number", "name": "WRITE_MODE" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.address-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

The IP address of the device's WiFi network interface.

", "type": "String", "name": "address" }, { "description": "

The URL to connect to is passed in as the only function argument, and the function \nis expected to return a URL. The function should return null if an error occurs, \nwhich will cancel the HTTP request.

\n

This function allows URLs to be formatted for use with the application's proxy to \nget around cross domain issues.

", "deprecated": null, "filename": "Titanium.Network.httpURLFormatter-property", "platforms": [ { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

User-defined function that is called everytime HTTPClient connects to a remote resource.

", "type": "Callback", "name": "httpURLFormatter" }, { "description": "

One of the NETWORK constants defined in Titanium.Network.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.networkType-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Network type value as a constant.

", "type": "Number", "name": "networkType" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.networkTypeName-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Network type as a String. Returns one of NONE, WIFI, LAN, MOBILE, or UNKNOWN.

", "type": "String", "name": "networkTypeName" }, { "description": "

The online property is true if the device can currently reach the Internet\nusing either WiFi, mobile network or LAN.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.online-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Boolean value indicating if the device can reach the Internet.

", "type": "Boolean", "name": "online" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.remoteDeviceUUID-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Remote device UUID if the device is registered with the Apple Push Notification\nService, or null if it is not registered.

", "type": "String", "name": "remoteDeviceUUID" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.remoteNotificationTypes-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Array of push notification type constants enabled for the application.

", "type": "Array", "name": "remoteNotificationTypes" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Network.remoteNotificationsEnabled-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Indicates whether push notifications have been enabled using \nregisterForPushNotifications.

", "type": "Boolean", "name": "remoteNotificationsEnabled" } ], "description": "

The Network module is used to access networking related functionality.

\n

For TCP sockets, see Titanium.Network.Socket.TCP.

\n

The legacy Titanium.Network.TCPSocket object is still required\nby the BonjourBrowser and\nBonjourService objects.

\n

For all other socket needs, use Titanium.Network.Socket.TCP.

", "subtype": null, "deprecated": null, "filename": "Titanium.Network-module", "methods": [ { "description": "

This legacy method adds a connectivity listener to listen for network changes.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.addConnectivityListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke upon network connectivity changes.

", "type": "Callback", "name": "callback" } ], "deprecated": { "removed": "1.9.0", "since": "1.7.0" }, "filename": "Titanium.Network.addConnectivityListener-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Use the change event to monitor connectivity changes.

", "name": "addConnectivityListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Network.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.createBonjourBrowser-method.serviceType-param", "optional": false, "summary": "

Service to search for, must include the protocol type suffix (._tcp).

", "type": "String", "name": "serviceType" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.createBonjourBrowser-method.domain-param", "optional": false, "summary": "

Bonjour service domain to conduct the search in.

", "type": "String", "name": "domain" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.createBonjourBrowser-method.parameters-param", "type": "Dictionary", "summary": "

A dictionary object of properties defined in Titanium.Network.BonjourBrowser.

", "optional": true, "name": "parameters" } ], "deprecated": null, "filename": "Titanium.Network.createBonjourBrowser-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "Titanium.Network.BonjourBrowser" }, "examples": [], "summary": "

Creates and returns a BonjourBrowser object.

", "name": "createBonjourBrowser" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.createBonjourService-method.name-param", "optional": false, "summary": "

Name of the service. Must be a unique identifier for this service type and domain.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.createBonjourService-method.type-param", "optional": false, "summary": "

Type of service. Must include the protocol identifier (._tcp).

", "type": "String", "name": "type" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.createBonjourService-method.domain-param", "optional": false, "summary": "

Domain to publish the service in.

", "type": "String", "name": "domain" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.createBonjourService-method.parameters-param", "type": "Dictionary", "summary": "

Dictionary object of properties defined in Titanium.Network.BonjourService.

", "optional": true, "name": "parameters" } ], "deprecated": null, "filename": "Titanium.Network.createBonjourService-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "Titanium.Network.BonjourService" }, "examples": [], "summary": "

Creates and returns a BonjourService object.

", "name": "createBonjourService" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.createHTTPClient-method.parameters-param", "optional": false, "summary": "

(Optional) A dictionary object with properties as defined in Titanium.Network.HTTPClient.

", "type": "Dictionary", "name": "parameters" } ], "deprecated": null, "filename": "Titanium.Network.createHTTPClient-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "Titanium.Network.HTTPClient" }, "examples": [], "summary": "

Create and return an instance of Titanium.Network.HTTPClient.

", "name": "createHTTPClient" }, { "description": "

Legacy method to create and return an instance of Titanium.Network.TCPSocket.

\n

Note that TCPSocket is still used with the Bonjour services. For other uses,\nsee Titanium.Network.Socket.TCP.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.createTCPSocket-method.hostName-param", "optional": false, "summary": "

Host name to connect to/listen on.

", "type": "String", "name": "hostName" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.createTCPSocket-method.port-param", "optional": false, "summary": "

Port for the socket.

", "type": "Number", "name": "port" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.createTCPSocket-method.mode-param", "optional": false, "summary": "

Socket's mode; one of Titanium.Network.READ_MODE, Titanium.Network.WRITE_MODE, \nTitanium.Network.READ_WRITE_MODE.

", "type": "Number", "name": "mode" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.createTCPSocket-method.parameters-param", "optional": false, "summary": "

Dictionary object with properties defined in Titanium.Network.TCPSocket.

", "type": "Dictionary", "name": "parameters" } ], "deprecated": { "since": "1.7.0" }, "filename": "Titanium.Network.createTCPSocket-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "Titanium.Network.TCPSocket" }, "examples": [], "summary": "

Use Titanium.Network.Socket.createTCP instead.

", "name": "createTCPSocket" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.decodeURIComponent-method.value-param", "optional": false, "summary": "

URI encoded input value to be decoded.

", "type": "String", "name": "value" } ], "deprecated": null, "filename": "Titanium.Network.decodeURIComponent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "String" }, "examples": [], "summary": "

Returns a decoded version of a URI encoded value.

", "name": "decodeURIComponent" }, { "description": "

On iOS, this also escapes the following characters, which are allowed in a \nURL but may not be allowed or desirable inside a path component:

\n
!*'();:@+$,/?%#[]=&\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.encodeURIComponent-method.value-param", "optional": false, "summary": "

Input value to be encoded.

", "type": "String", "name": "value" } ], "deprecated": null, "filename": "Titanium.Network.encodeURIComponent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "String" }, "examples": [], "summary": "

Returns a URI encoded version of the specified URI component.

", "name": "encodeURIComponent" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.Network.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Network.getAddress-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the address property.

", "name": "getAddress" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Network.getHttpURLFormatter-method", "platforms": [ { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "Callback" } ], "examples": [], "summary": "

Gets the value of the httpURLFormatter property.

", "name": "getHttpURLFormatter" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Network.getNetworkType-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the networkType property.

", "name": "getNetworkType" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Network.getNetworkTypeName-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the networkTypeName property.

", "name": "getNetworkTypeName" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Network.getOnline-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the online property.

", "name": "getOnline" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Network.getRemoteDeviceUUID-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the remoteDeviceUUID property.

", "name": "getRemoteDeviceUUID" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Network.getRemoteNotificationTypes-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": [ { "type": "Array" } ], "examples": [], "summary": "

Gets the value of the remoteNotificationTypes property.

", "name": "getRemoteNotificationTypes" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Network.getRemoteNotificationsEnabled-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the remoteNotificationsEnabled property.

", "name": "getRemoteNotificationsEnabled" }, { "description": "

This method should be called at application startup.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.registerForPushNotifications-method.config-param", "optional": false, "summary": "

Dictionary specifying push-notification related options.

", "type": "PushNotificationConfig", "name": "config" } ], "deprecated": null, "filename": "Titanium.Network.registerForPushNotifications-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Registers for push notifications with the Apple Push Notification Service.

", "name": "registerForPushNotifications" }, { "description": "

This legacy method removes a connectivity listener.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.removeConnectivityListener-method.callback-param", "optional": false, "summary": "

Callback function to remove.

", "type": "Callback", "name": "callback" } ], "deprecated": { "removed": "1.9.0", "since": "1.7.0" }, "filename": "Titanium.Network.removeConnectivityListener-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Use the change event to monitor connectivity changes.

", "name": "removeConnectivityListener" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Network.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.setAddress-method.address-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "address" } ], "deprecated": null, "filename": "Titanium.Network.setAddress-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the address property.

", "name": "setAddress" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.setHttpURLFormatter-method.httpURLFormatter-param", "optional": false, "summary": "

New value for the property.

", "type": "Callback", "name": "httpURLFormatter" } ], "deprecated": null, "filename": "Titanium.Network.setHttpURLFormatter-method", "platforms": [ { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the httpURLFormatter property.

", "name": "setHttpURLFormatter" }, { "description": "

Per Apple's documentation, it is rarely necessary to call this method. See:\nunregisterForRemoteNotifications in the UIApplication Class\nReference

\n

For example, calling this method would be required if a new version of \nyour application no longer supports push notifications.

", "parameters": [], "deprecated": null, "filename": "Titanium.Network.unregisterForPushNotifications-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Unregisters the application for push notifications.

", "name": "unregisterForPushNotifications" } ], "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "objects": [ "Titanium.Network.BonjourService", "Titanium.Network.TCPSocket", "Titanium.Network.BonjourBrowser", "Titanium.Network.HTTPClient" ], "examples": [], "summary": "

The top level network module.

", "type": "module", "events": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.change-event", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "summary": "

Fired when network connectivity changes.

", "properties": [ { "description": null, "deprecated": null, "filename": "Titanium.Network.change.networkType-callback-property", "summary": "

New network type, one of the NETWORK constants defined in Titanium.Network.

", "type": "Number", "name": "networkType" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.change.networkTypeName-callback-property", "summary": "

New network type as a string.

", "type": "String", "name": "networkTypeName" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.change.online-callback-property", "summary": "

Boolean to indicate if the device is online.

", "type": "Boolean", "name": "online" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.change.reason-callback-property", "summary": "

Human-readable text describing the reason for the change.

", "type": "String", "name": "reason" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.change.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.Network.change.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" } ], "name": "change" } ], "name": "Titanium.Network" }, "Titanium.Module": { "properties": [], "description": null, "subtype": null, "deprecated": null, "filename": "Titanium.Module-module", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Module.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Module.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Module.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Module.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Module.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.Module.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Module.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Module.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Module.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" } ], "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "objects": [], "examples": [], "summary": "

The base for all module types

", "type": "module", "events": [], "name": "Titanium.Module" }, "BarItemType": { "properties": [ { "description": null, "default": true, "deprecated": null, "filename": "BarItemType.enabled-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Whether the button is enabled initially.

", "type": "Boolean", "name": "enabled" }, { "description": null, "deprecated": null, "filename": "BarItemType.image-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Button icon. If specified, takes precedence over title.

", "type": [ "String", "Titanium.Blob", "Titanium.Filesystem.File" ], "name": "image" }, { "description": null, "deprecated": null, "filename": "BarItemType.title-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Button title, used if no image is specified.

", "type": "String", "name": "title" }, { "description": null, "deprecated": null, "filename": "BarItemType.width-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Width for this button.

", "type": "Number", "name": "width" } ], "description": "

A button bar or tabbed bar item can have an image or a title, but not both.\nButtons with images and buttons with text can be mixed in the same bar, however.

\n

If both image and title properties are specified for a given item, the \nimage property takes precedence and the title property is ignored.

", "subtype": "proxy", "deprecated": null, "filename": "BarItemType-object", "methods": [], "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Object describing a button bar or tabbed bar item.

", "type": "object", "events": [], "name": "BarItemType" }, "Titanium.Media.Android": { "properties": [], "description": null, "subtype": null, "deprecated": null, "filename": "Titanium.Media.Android-module", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.Android.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.Android.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Media.Android.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "1.7.0", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.Android.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.Android.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.Media.Android.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "1.7.0", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.Android.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.Android.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Media.Android.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "1.7.0", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.Android.scanMediaFiles-method.paths-param", "optional": false, "summary": "

Array of paths to the files you want to be scanned.

", "type": "Array", "name": "paths" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.Android.scanMediaFiles-method.mimeTypes-param", "optional": false, "summary": "

Array of mime types for the files in the paths parameter. Can be null, in which case the mime type will be inferred at scan time.

", "type": "Array", "name": "mimeTypes" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.Android.scanMediaFiles-method.callback-param", "optional": false, "summary": "

A function that will be called when each file is finished being scanned. Check the callback argument's \"path\" and \"uri\" properties to see the path that was scanned and the resulting content uri.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Media.Android.scanMediaFiles-method", "platforms": [ { "pretty_name": "Android", "since": "1.7.0", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Use the Android MediaScannerConnection to request immediate scan of particular files so that they become available to the appropriate media providers (Gallery, etc.).

", "name": "scanMediaFiles" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Media.Android.setSystemWallpaper-method.image-param", "optional": false, "summary": "

Image blob such as what can be retrieved via callbacks for Titanium.Media.openPhotoGallery and Titanium.Media.showCamera, as well as from the return value of Titanium.Filesystem.File.read.

", "type": "Object", "name": "image" }, { "description": null, "deprecated": null, "filename": "Titanium.Media.Android.setSystemWallpaper-method.scale-param", "optional": false, "summary": "

Set to true if you want the image to be scaled with respect to the system wallpaper desired width, or false to leave it as-is.

", "type": "Boolean", "name": "scale" } ], "deprecated": null, "filename": "Titanium.Media.Android.setSystemWallpaper-method", "platforms": [ { "pretty_name": "Android", "since": "1.7.0", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Set the system homescreen wallpaper

", "name": "setSystemWallpaper" } ], "platforms": [ { "pretty_name": "Android", "since": "1.7.0", "name": "android" } ], "objects": [], "examples": [], "summary": "

Android-specific media-related functionality.

", "type": "module", "events": [], "name": "Titanium.Media.Android" }, "Titanium.Android.Calendar": { "properties": [ { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.METHOD_ALERT-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Reminder method property.

", "type": "Number", "name": "METHOD_ALERT" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.METHOD_DEFAULT-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Reminder method property.

", "type": "Number", "name": "METHOD_DEFAULT" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.METHOD_EMAIL-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Reminder method property.

", "type": "Number", "name": "METHOD_EMAIL" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.METHOD_SMS-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Reminder method property.

", "type": "Number", "name": "METHOD_SMS" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.STATE_DISMISSED-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Alert state property.

", "type": "Number", "name": "STATE_DISMISSED" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.STATE_FIRED-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Alert state property.

", "type": "Number", "name": "STATE_FIRED" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.STATE_SCHEDULED-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Alert state property.

", "type": "Number", "name": "STATE_SCHEDULED" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.STATUS_CANCELED-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Event status property.

", "type": "Number", "name": "STATUS_CANCELED" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.STATUS_CONFIRMED-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Event status property.

", "type": "Number", "name": "STATUS_CONFIRMED" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.STATUS_TENTATIVE-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Event status property.

", "type": "Number", "name": "STATUS_TENTATIVE" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.VISIBILITY_CONFIDENTIAL-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Event visibility property.

", "type": "Number", "name": "VISIBILITY_CONFIDENTIAL" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.VISIBILITY_DEFAULT-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Event visibility property.

", "type": "Number", "name": "VISIBILITY_DEFAULT" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.VISIBILITY_PRIVATE-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Event visibility property.

", "type": "Number", "name": "VISIBILITY_PRIVATE" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.VISIBILITY_PUBLIC-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

constant for the Titanium.Android.Calendar.Event visibility property.

", "type": "Number", "name": "VISIBILITY_PUBLIC" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.allAlerts-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Array of Titanium.Android.Calendar.Alert objects representing all alerts.

", "type": "Array", "name": "allAlerts" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.allCalendars-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Array of Titanium.Android.Calendar.Calendar objects representing all the calendars known to the native calendar app.

", "type": "Array", "name": "allCalendars" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.selectableCalendars-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

Array of Titanium.Android.Calendar.Calendar objects representing calendars selected within the native calendar app. This may be a subset of allCalendars; for example, the native calendar application may know -- via your Gooogle account -- about calendars that you have access to but have not selected to be displayed in the native calendar app.

", "type": "Array", "name": "selectableCalendars" } ], "description": "

The API supports retrieving information about existing events and creating new events. However, modifying or deleting existing events is not yet supported. Additionally, recurring events are not yet supported.

", "subtype": null, "deprecated": null, "filename": "Titanium.Android.Calendar-module", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Android.Calendar.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.Android.Calendar.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.Calendar.getAllAlerts-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": [ { "type": "Array" } ], "examples": [], "summary": "

Gets the value of the allAlerts property.

", "name": "getAllAlerts" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.Calendar.getAllCalendars-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": [ { "type": "Array" } ], "examples": [], "summary": "

Gets the value of the allCalendars property.

", "name": "getAllCalendars" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.getCalendarById-method.id-param", "optional": false, "summary": "

The system id of the calendar to be retrieved.

", "type": "Number", "name": "id" } ], "deprecated": null, "filename": "Titanium.Android.Calendar.getCalendarById-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "Titanium.Android.Calendar.Calendar" }, "examples": [], "summary": "

Returns the Titanium.Android.Calendar.Calendar object specified by the given integer id.

", "name": "getCalendarById" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.Calendar.getSelectableCalendars-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": [ { "type": "Array" } ], "examples": [], "summary": "

Gets the value of the selectableCalendars property.

", "name": "getSelectableCalendars" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Android.Calendar.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" } ], "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "objects": [ "Titanium.Android.Calendar.Reminder", "Titanium.Android.Calendar.Calendar", "Titanium.Android.Calendar.Event", "Titanium.Android.Calendar.Alert" ], "examples": [ { "code": "

Prints the names of all of your calendars known to Android, then prints the names of calendars that you have selected in the native Android calendar application. The latter could be a subset, because (for example) Android -- via your Google account -- may know about more calendars that you have access to but that you have not selected inside the calendar app.

\n
function showCalendars(calendars) {\n    for (var i = 0; i < calendars.length; i++) {\n        Ti.API.info(calendars[i].name);\n    }\n}\n\nTi.API.info('ALL CALENDARS:');\nshowCalendars(Ti.Android.Calendar.allCalendars);\nTi.API.info('SELECTABLE CALENDARS:');\nshowCalendars(Ti.Android.Calendar.selectableCalendars);\n
", "description": "All Calendars vs Selectable Calendars" }, { "code": "

This example will look at each event in a year for a given calendar. Just set the desired calendar's id and the desired year to see it in action. You can see calendar ids by running the example above.

\n
var win = Ti.UI.currentWindow;\nvar sv = Ti.UI.createScrollView();\nwin.add(sv);\n\nvar console = Ti.UI.createLabel({\n    backgroundColor: 'white', color: 'black', text: 'generating info...'\n});\nsv.add(console);\n\nvar consoleString = '';\n\nfunction print(s) {\n    Ti.API.info(s);\n    if (consoleString.length > 0) {\n        consoleString = consoleString + '\\n';\n    }\n    consoleString = consoleString + s;\n}\n\n// SHOW ALL EVENTS FOR 2010 FOR ONE CALENDAR\nvar YEAR = 2010;\nvar TEST_WITH_THIS_CAL_ID = 3;\nvar calendar = Ti.Android.Calendar.getCalendarById(TEST_WITH_THIS_CAL_ID);\n\nfunction printReminder(r) {\n    var typetext = '[method unknown]';\n    if (r.method == Ti.Android.Calendar.METHOD_EMAIL) {\n        typetext = 'Email';\n    } else if (r.method == Ti.Android.Calendar.METHOD_SMS) {\n        typetext = 'SMS';\n    } else if (r.method == Ti.Android.Calendar.METHOD_ALERT) {\n        typetext = 'Alert';\n    } else if (r.method == Ti.Android.Calendar.METHOD_DEFAULT) {\n        typetext = '[default reminder method]';\n    }\n    print(typetext + ' reminder to be sent ' + r.minutes + ' minutes before the event');\n}\n\nfunction printAlert(a) {\n    print('Alert id ' + a.id + ' begin ' + a.begin + '; end ' + a.end + '; alarmTime ' + a.alarmTime + '; minutes ' + a.minutes);\n}\n\nfunction printEvent(event) {\n    if (event.allDay) {\n        print('Event: ' + event.title + '; ' + event.begin.toLocaleDateString() + ' (all day)');\n    } else {\n        print('Event: ' + event.title + '; ' + event.begin.toLocaleDateString() + ' ' + event.begin.toLocaleTimeString()+ '-' + event.end.toLocaleTimeString());\n    }\n\n    var reminders = event.reminders;\n    if (reminders && reminders.length) {\n        print('There is/are ' + reminders.length + ' reminder(s)');\n        for (var i = 0; i < reminders.length; i++) {\n            printReminder(reminders[i]);\n        }\n    }\n\n    print('hasAlarm? ' + event.hasAlarm);\n    var alerts = event.alerts;\n    if (alerts && alerts.length) {\n        for (i = 0; i < alerts.length; i++) {\n            printAlert(alerts[i]);\n        }\n    }\n\n    var status = event.status;\n    if (status == Ti.Android.Calendar.STATUS_TENTATIVE) {\n        print('This event is tentative');\n    }\n    if (status == Ti.Android.Calendar.STATUS_CONFIRMED) {\n        print('This event is confirmed');\n    }\n    if (status == Ti.Android.Calendar.STATUS_CANCELED) {\n        print('This event was canceled');\n    }\n}\n\nvar events = calendar.getEventsInYear(YEAR);\nif (events && events.length) {\n    print(events.length + ' event(s) in ' + YEAR);\n    print('');\n    for (var i = 0; i < events.length; i++) {\n        printEvent(events[i]);\n        print('');\n    }\n} else {\n    print('No events on 2010-12-6');\n}\n\nconsole.text = consoleString;\n
", "description": "Events in a year" }, { "code": "

This example creates an event and adds an e-mail reminder for 10 minutes before the event.

\n
var CALENDAR_TO_USE = 3;\nvar calendar = Ti.Android.Calendar.getCalendarById(CALENDAR_TO_USE);\n\n// Create the event\nvar eventBegins = new Date(2010, 11, 26, 12, 0, 0);\nvar eventEnds = new Date(2010, 11, 26, 14, 0, 0);\nvar details = {\n    title: 'Do some stuff',\n    description: \"I'm going to do some stuff at this time.\",\n    begin: eventBegins,\n    end: eventEnds\n};\n\nvar event = calendar.createEvent(details);\n\n// Now add a reminder via e-mail for 10 minutes before the event.\nvar reminderDetails = {\n    minutes: 10,\n    method: Ti.Android.Calendar.METHOD_EMAIL\n};\nevent.createReminder(reminderDetails);\n
", "description": "Create an Event and Reminder" } ], "summary": "

The Android.Calendar module provides proxies and methods for accessing the native Android calendar functionality.

", "type": "module", "events": [], "name": "Titanium.Android.Calendar" }, "Titanium.Analytics": { "properties": [], "description": "

The Analytics module is used for transmitting developer-defined Analytics event for your application to the Appcelerator Analytics product. It can be used to augment additional context or application-specific information which can then be accessed during analysis using Analytics.

", "subtype": null, "deprecated": null, "filename": "Titanium.Analytics-module", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Analytics.addEvent-method.type-param", "optional": false, "summary": "

the event type

", "type": "String", "name": "type" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.addEvent-method.name-param", "optional": false, "summary": "

the event name

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.addEvent-method.data-param", "optional": false, "summary": "

event data or null if not specified. the object must be serializable as JSON

", "type": "Object", "name": "data" } ], "deprecated": null, "filename": "Titanium.Analytics.addEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

send a generic event for the application session

", "name": "addEvent" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Analytics.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Analytics.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Analytics.featureEvent-method.name-param", "optional": false, "summary": "

the event name

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.featureEvent-method.data-param", "optional": false, "summary": "

event data or null if not specified. the object must be serializable as JSON

", "type": "Object", "name": "data" } ], "deprecated": null, "filename": "Titanium.Analytics.featureEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

send an analytics feature event for the application session

", "name": "featureEvent" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Analytics.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.Analytics.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Analytics.navEvent-method.from-param", "optional": false, "summary": "

the from location in the nav event

", "type": "String", "name": "from" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.navEvent-method.to-param", "optional": false, "summary": "

the to location in the nav event

", "type": "String", "name": "to" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.navEvent-method.name-param", "optional": false, "summary": "

the event name

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.navEvent-method.data-param", "optional": false, "summary": "

event data or null if not specified. the object must be serializable as JSON

", "type": "Object", "name": "data" } ], "deprecated": null, "filename": "Titanium.Analytics.navEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

send an analytics nav event for the application session

", "name": "navEvent" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Analytics.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Analytics.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Analytics.settingsEvent-method.name-param", "optional": false, "summary": "

the event name

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.settingsEvent-method.data-param", "optional": false, "summary": "

event data or null if not specified. the object must be serializable as JSON

", "type": "Object", "name": "data" } ], "deprecated": null, "filename": "Titanium.Analytics.settingsEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

send a analytics settings event for the application session

", "name": "settingsEvent" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Analytics.timedEvent-method.name-param", "optional": false, "summary": "

the event name

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.timedEvent-method.start-param", "optional": false, "summary": "

the event start as a Date object

", "type": "Date", "name": "start" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.timedEvent-method.stop-param", "optional": false, "summary": "

the event end as a Date object

", "type": "Date", "name": "stop" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.timedEvent-method.duration-param", "optional": false, "summary": "

the event duration

", "type": "Number", "name": "duration" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.timedEvent-method.data-param", "optional": false, "summary": "

event data or null if not specified. the object must be serializable as JSON

", "type": "Object", "name": "data" } ], "deprecated": null, "filename": "Titanium.Analytics.timedEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

send an analytics timed event for the application session

", "name": "timedEvent" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Analytics.userEvent-method.name-param", "optional": false, "summary": "

the event name

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Analytics.userEvent-method.data-param", "optional": false, "summary": "

event data or null if not specified. the object must be serializable as JSON

", "type": "Object", "name": "data" } ], "deprecated": null, "filename": "Titanium.Analytics.userEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

send an analytics user event for the application session

", "name": "userEvent" } ], "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "objects": [], "examples": [ { "code": "

This examples shows how to send a featureEvent during an application session to indicate some feature was triggered/used by the user that you would like to track.

\n
Titanium.Analytics.featureEvent('app.feature.blah',{product:'killer'});\n
", "description": "Custom Feature Event" } ], "summary": "

The top level Analytics module.

", "type": "module", "events": [], "name": "Titanium.Analytics" }, "Titanium.UI.EmailDialog": { "properties": [ { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.EmailDialog.CANCELLED-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

constant for the CANCELLED status result

", "type": "Number", "name": "CANCELLED" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.EmailDialog.FAILED-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

constant for the FAILED status result

", "type": "Number", "name": "FAILED" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.EmailDialog.SAVED-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

constant for the SAVED status result

", "type": "Number", "name": "SAVED" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.EmailDialog.SENT-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

constant for the SENT status result

", "type": "Number", "name": "SENT" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.barColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

the bar color of the email dialog window when opened

", "type": "String", "name": "barColor" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.bccRecipients-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

array of email BCC: recipients

", "type": "Array", "name": "bccRecipients" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.ccRecipients-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

array of email CC: recipients

", "type": "Array", "name": "ccRecipients" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.html-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

boolean to indicate whether the email messageBody should be sent as HTML content type. defaults to false. (Android note: you should not use html messages in 1.6: after that is okay.)

", "type": "Boolean", "name": "html" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.messageBody-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

the email message body

", "type": "String", "name": "messageBody" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.subject-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

the subject line for the email

", "type": "String", "name": "subject" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.toRecipients-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

array of email recipients

", "type": "Array", "name": "toRecipients" } ], "description": null, "subtype": "proxy", "deprecated": null, "filename": "Titanium.UI.EmailDialog-object", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.addAttachment-method.attachment-param", "optional": false, "summary": "

attachment object as either a Blob or File object

", "type": "Object", "name": "attachment" } ], "deprecated": null, "filename": "Titanium.UI.EmailDialog.addAttachment-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

add an attachment to the email. The attachment can either be a Blob or File object. Note: Versions before 1.7.1 will only support one attachment in Android. Since version 1.7.1, our Android implementation will accept multiple attachments, but multiple attachments will only work if the user chooses to send via the Android Gmail app; the Android \"Mail\" app (which is anyway not available on some handsets) will only accept one attachment from a Titanium app. K9 has also been tested successfully with multiple attachments.

", "name": "addAttachment" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.UI.EmailDialog.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.UI.EmailDialog.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.EmailDialog.getBarColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the barColor property.

", "name": "getBarColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.EmailDialog.getBccRecipients-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Array" } ], "examples": [], "summary": "

Gets the value of the bccRecipients property.

", "name": "getBccRecipients" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.EmailDialog.getCcRecipients-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Array" } ], "examples": [], "summary": "

Gets the value of the ccRecipients property.

", "name": "getCcRecipients" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.EmailDialog.getHtml-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the html property.

", "name": "getHtml" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.EmailDialog.getMessageBody-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the messageBody property.

", "name": "getMessageBody" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.EmailDialog.getSubject-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the subject property.

", "name": "getSubject" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.EmailDialog.getToRecipients-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Array" } ], "examples": [], "summary": "

Gets the value of the toRecipients property.

", "name": "getToRecipients" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.EmailDialog.isSupported-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

return whether or not sending email is supported

", "name": "isSupported" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.open-method.properties-param", "optional": false, "summary": "

object of animation properties. pass animated property (as boolean) to indicate if the dialog should be animated on open.

", "type": "Object", "name": "properties" } ], "deprecated": null, "filename": "Titanium.UI.EmailDialog.open-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

open the email dialog. the email dialog itself is a modal window

", "name": "open" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.UI.EmailDialog.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.setBarColor-method.barColor-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "barColor" } ], "deprecated": null, "filename": "Titanium.UI.EmailDialog.setBarColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the barColor property.

", "name": "setBarColor" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.setBccRecipients-method.bccRecipients-param", "optional": false, "summary": "

New value for the property.

", "type": "Array", "name": "bccRecipients" } ], "deprecated": null, "filename": "Titanium.UI.EmailDialog.setBccRecipients-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the bccRecipients property.

", "name": "setBccRecipients" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.setCcRecipients-method.ccRecipients-param", "optional": false, "summary": "

New value for the property.

", "type": "Array", "name": "ccRecipients" } ], "deprecated": null, "filename": "Titanium.UI.EmailDialog.setCcRecipients-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the ccRecipients property.

", "name": "setCcRecipients" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.setHtml-method.html-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "html" } ], "deprecated": null, "filename": "Titanium.UI.EmailDialog.setHtml-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the html property.

", "name": "setHtml" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.setMessageBody-method.messageBody-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "messageBody" } ], "deprecated": null, "filename": "Titanium.UI.EmailDialog.setMessageBody-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the messageBody property.

", "name": "setMessageBody" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.setSubject-method.subject-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "subject" } ], "deprecated": null, "filename": "Titanium.UI.EmailDialog.setSubject-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the subject property.

", "name": "setSubject" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.setToRecipients-method.toRecipients-param", "optional": false, "summary": "

New value for the property.

", "type": "Array", "name": "toRecipients" } ], "deprecated": null, "filename": "Titanium.UI.EmailDialog.setToRecipients-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the toRecipients property.

", "name": "setToRecipients" } ], "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [ { "code": "

In this example, we send an email with a file attachment.

\n
var emailDialog = Titanium.UI.createEmailDialog()\nemailDialog.subject = \"Hello from Titanium\";\nemailDialog.toRecipients = ['foo@yahoo.com'];\nemailDialog.messageBody = '<b>Appcelerator Titanium Rocks!</b>';\nvar f = Ti.Filesystem.getFile('cricket.wav');\nemailDialog.addAttachment(f);\nemailDialog.open();\n
", "description": "Simple Email Dialog with Attachment" } ], "summary": "

The Email Dialog is created by Titanium.UI.createEmailDialog and allows you to send in application emails on behalf of the application user.

", "type": "object", "events": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.complete-event", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

fired when the email dialog has completed sending the email

", "properties": [ { "deprecated": null, "description": null, "filename": "Titanium.UI.EmailDialog.complete.error-callback-property", "name": "error", "summary": "

string message of the error or null if successfully sent

" }, { "deprecated": null, "description": null, "filename": "Titanium.UI.EmailDialog.complete.result-callback-property", "name": "result", "summary": "

result status either as SENT, SAVED, CANCELLED or FAILED. (Note: Android result will be SENT even if user discards or saves the message. SAVED and CANCELLED are not supported on Android.)

" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.complete.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "deprecated": null, "description": null, "filename": "Titanium.UI.EmailDialog.complete.success-callback-property", "name": "success", "summary": "

boolean to indicate if the email was successfully sent

" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.EmailDialog.complete.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" } ], "name": "complete" } ], "name": "Titanium.UI.EmailDialog" }, "Global.String": { "properties": [], "description": "

The following are built-in functions available on the String class.\nThese are Titanium-specific extensions for formatting data into locale-specific strings.

\n

Both iOS and Android use the locale configured by the user for locale-specific formatting.\nThe locale is set in device's system Settings.

", "subtype": "proxy", "deprecated": null, "filename": "Global.String-object", "methods": [ { "description": "

The format string follows the IEEE printf specification:

\n

http://www.opengroup.org/onlinepubs/009695399/functions/printf.html

\n

One value parameter should be passed for each conversion specification in the\nformat string. For example:

\n
message = String.formatString(\"Hello, %s, you are visitor number %d\", name, number);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Global.String.format-method.formatString-param", "optional": false, "summary": "

An IEEE printf format string.

", "type": "String", "name": "formatString" }, { "description": null, "deprecated": null, "filename": "Global.String.format-method.value-param", "type": [ "String", "Number" ], "summary": "

A value to substitute into the format string. An arbitrary number of value parameters may be specified.

", "optional": true, "name": "value" } ], "deprecated": null, "filename": "Global.String.format-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "String", "summary": "Formatted string." }, "examples": [], "summary": "

Formats a string using a printf-style format string.

", "name": "format" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Global.String.formatCurrency-method.value-param", "optional": false, "summary": "

Currency value to format.

", "type": "Number", "name": "value" } ], "deprecated": null, "filename": "Global.String.formatCurrency-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "String", "summary": "The specified value, with a locale-specific currency symbol." }, "examples": [], "summary": "

Formats a number into a locale-specific currency format.

", "name": "formatCurrency" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Global.String.formatDate-method.date-param", "optional": false, "summary": "

Date object to format.

", "type": "Date", "name": "date" }, { "description": null, "deprecated": null, "filename": "Global.String.formatDate-method.format-param", "type": "String", "summary": "

Date format to use, specified as 'short', 'medium', or 'long'.

", "optional": true, "name": "format" } ], "deprecated": null, "filename": "Global.String.formatDate-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "String", "summary": "String representation of the specified date." }, "examples": [], "summary": "

Formats a Date object in a localized string format.

", "name": "formatDate" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Global.String.formatDecimal-method.value-param", "optional": false, "summary": "

Value to format.

", "type": "Number", "name": "value" } ], "deprecated": null, "filename": "Global.String.formatDecimal-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "String", "summary": "String representation of the specified number, using a locale-specific decimal symbol, if required." }, "examples": [], "summary": "

Formats a number using the locale-specific decimal symbol.

", "name": "formatDecimal" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Global.String.formatTime-method.date-param", "optional": false, "summary": "

Date object to format.

", "type": "Date", "name": "date" } ], "deprecated": null, "filename": "Global.String.formatTime-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "String", "summary": "String representation of the specified time." }, "examples": [], "summary": "

Formats a Date object into a locale-specific time format.

", "name": "formatTime" } ], "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

The JavaScript built-in String type.

", "type": "object", "events": [], "name": "Global.String" }, "MatrixCreationDict": { "properties": [ { "description": null, "default": "(0.5, 0.5)", "deprecated": null, "filename": "MatrixCreationDict.anchorPoint-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "type": "Dictionary", "summary": "

Point to rotate around, specified as a dictionary object with x and y\nproperties, where { x: 0.5, y: 0.5 } represents the center of whatever is being\nrotated.

", "optional": true, "name": "anchorPoint" }, { "description": null, "default": "No rotation.", "deprecated": null, "filename": "MatrixCreationDict.rotate-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "type": "Number", "summary": "

Rotation angle, in degrees. See the rotate method\nfor a discussion of rotation.

", "optional": true, "name": "rotate" }, { "description": null, "default": 1, "deprecated": null, "filename": "MatrixCreationDict.scale-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "type": "Number", "summary": "

Scale the matrix by the specified scaling factor. The same scaling factor is used\nfor both horizontal and vertical scaling.

", "optional": true, "name": "scale" } ], "description": "

The matrix is initialized with the specified transforms.

\n

On iOS, rotation is always performed first, regardless of the order the \nproperties are specified in.

\n

On Android, specifying both scale and rotate the same dictionary results\nin an incorrect transformation.

", "subtype": "proxy", "deprecated": null, "filename": "MatrixCreationDict-object", "methods": [], "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Simple object passed to Titanium.UI.create2DMatrix to initialize a matrix.

", "type": "object", "events": [], "name": "MatrixCreationDict" }, "Titanium.API": { "properties": [], "description": null, "subtype": null, "deprecated": null, "filename": "Titanium.API-module", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.API.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.API.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.API.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.API.debug-method.message-param", "optional": false, "summary": "

the message to log

", "type": "String", "name": "message" } ], "deprecated": null, "filename": "Titanium.API.debug-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

function for logging debug messages

", "name": "debug" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.API.error-method.message-param", "optional": false, "summary": "

the message to log

", "type": "String", "name": "message" } ], "deprecated": null, "filename": "Titanium.API.error-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

function for logging error messages

", "name": "error" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.API.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.API.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.API.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.API.info-method.message-param", "optional": false, "summary": "

the message to log

", "type": "String", "name": "message" } ], "deprecated": null, "filename": "Titanium.API.info-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

function for logging informational messages

", "name": "info" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.API.log-method.level-param", "optional": false, "summary": "

the log level

", "type": "String", "name": "level" }, { "description": null, "deprecated": null, "filename": "Titanium.API.log-method.message-param", "optional": false, "summary": "

the message to log

", "type": "String", "name": "message" } ], "deprecated": null, "filename": "Titanium.API.log-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

function for logging custom severity messages

", "name": "log" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.API.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.API.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.API.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.API.warn-method.message-param", "optional": false, "summary": "

the message to log

", "type": "String", "name": "message" } ], "deprecated": null, "filename": "Titanium.API.warn-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

function for logging warning messages

", "name": "warn" } ], "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "objects": [], "examples": [], "summary": "

The top level API module. The API module is mainly used for logging.

", "type": "module", "events": [], "name": "Titanium.API" }, "TableViewIndexEntry": { "properties": [ { "description": null, "deprecated": null, "filename": "TableViewIndexEntry.index-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Row index associated with this item.

", "type": "Number", "name": "index" }, { "description": null, "deprecated": null, "filename": "TableViewIndexEntry.title-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Title to display in the index bar for this item.

", "type": "String", "name": "title" } ], "description": null, "subtype": "proxy", "deprecated": null, "filename": "TableViewIndexEntry-object", "methods": [], "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

A simple object that represents an index entry in a TableView.

", "type": "object", "events": [], "name": "TableViewIndexEntry" }, "Titanium.Android.Calendar.Reminder": { "properties": [ { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.id-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

The id of the reminder.

", "type": "String", "name": "id" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.method-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

The reminder method. Possible values are the METHOD constants in Titanium.Android.Calendar.

", "type": "Number", "name": "method" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.minutes-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

The minutes before the event when the reminder should occur.

", "type": "Number", "name": "minutes" } ], "description": "

Reminders should not be created directly, but rather by using the createReminder method \nof Titanium.Android.Calendar.Event.

\n

See Titanium.Android.Calendar for examples of retrieving reminder information and \ncreating reminders for events.

", "subtype": "proxy", "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder-object", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.getId-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the id property.

", "name": "getId" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.getMethod-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the method property.

", "name": "getMethod" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.getMinutes-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the minutes property.

", "name": "getMinutes" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Android.Calendar.Reminder.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" } ], "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

An object which represents a single reminder for an event in an Android calendar.

", "type": "object", "events": [], "name": "Titanium.Android.Calendar.Reminder" }, "Titanium.Filesystem": { "properties": [ { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Filesystem.MODE_APPEND-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant for append mode for file operations.

", "type": "Number", "name": "MODE_APPEND" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Filesystem.MODE_READ-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant for read mode for file operations.

", "type": "Number", "name": "MODE_READ" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Filesystem.MODE_WRITE-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Constant for write mode for file operations.

", "type": "Number", "name": "MODE_WRITE" }, { "description": "

This is a writable directory that can be used to store applications-specific files.

\n

On iOS, this directory is specifically designated for user documents, and a\nseparate directory,\napplicationSupportDirectory is\nused for other application data.

\n

On iOS, files in this directory are backed up unless the\nremoteBackup flag is set to false.

\n

On Android, files in this directory cannot be accessed by other applications, so \nit should not be used for files that must be used by another application \n(for example, a video file that will be passed to the system's video player application).\nThese files should be stored in the\nexternalStorageDirectory.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Filesystem.applicationDataDirectory-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Path to the application's data directory.

", "type": "String", "name": "applicationDataDirectory" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Filesystem.applicationDirectory-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Path to the iOS application directory.

", "type": "String", "name": "applicationDirectory" }, { "description": "

This is a writable directory used on iOS for application files that are not \nuser documents--including settings files, caches, and so on.

\n

On iOS, files in this directory are backed up unless the\nremoteBackup flag is set to false.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Filesystem.applicationSupportDirectory-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Path to the application support directory.

", "type": "String", "name": "applicationSupportDirectory" }, { "description": "

This directory can be used for storing arbitrary data. It is read/write and files\nin this directory can be passed to other applications, such as video\nplayers--which is not possible with the \napplicationDataDirectory.

\n

This directory may not be subject to as many memory limitations as the\napplicationDataDirectory, which is stored in the device's internal storage.\nNote, however, that the user may remove or replace the removable storage device\nwithout warning, so the application must be prepared to handle this case gracefully.

\n

The application should check\nisExternalStoragePresent before\naccessing this location. The application should also handle any exceptions generated \nif the storage device is unmounted during use, or if the files stored on external \nstorage are not available.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Filesystem.externalStorageDirectory-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" } ], "examples": [], "summary": "

Path to a directory on removable storage, such as SD card.

", "type": "String", "name": "externalStorageDirectory" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Filesystem.lineEnding-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Platform-specific line ending constant.

", "type": "String", "name": "lineEnding" }, { "description": "

This directory is read-only. If you need to modify any files in this directory,\nthey must first be copied to another directory, such as
\napplicationDataDirectory or\ntempDirectory.

\n

On iOS, \nwritable files can also be placed in the \napplicationSupportDirectory.\nOn Android, writable files can also be placed in the \nexternalStorageDirectory.

\n

Note that when running on the simulator, the resources directory may be writable,\nbut it is not writable on device.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Filesystem.resourcesDirectory-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Path to the application's resource directory.

", "type": "String", "name": "resourcesDirectory" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Filesystem.separator-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Platform-specific path separator constant.

", "type": "String", "name": "separator" }, { "description": "

This directory can be used for storing temporary files. Files in this directory\nmay not persist when the application is shut down and restarted.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.Filesystem.tempDirectory-property", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "examples": [], "summary": "

Path for the application's temporary directory.

", "type": "String", "name": "tempDirectory" } ], "description": null, "subtype": null, "deprecated": null, "filename": "Titanium.Filesystem-module", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Filesystem.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Filesystem.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Filesystem.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Filesystem.createFile-method.parameters-param", "optional": false, "summary": "

(Optional) A dictionary object with properties as defined in Titanium.Filesystem.File.

", "type": "Dictionary", "name": "parameters" } ], "deprecated": null, "filename": "Titanium.Filesystem.createFile-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "Titanium.Filesystem.File" }, "examples": [], "summary": "

Create and return an instance of Titanium.Filesystem.File.

", "name": "createFile" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Filesystem.createTempDirectory-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "Titanium.Filesystem.File" }, "examples": [], "summary": "

Creates a temporary directory and returns a File object representing the new directory.

", "name": "createTempDirectory" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Filesystem.createTempFile-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "Titanium.Filesystem.File" }, "examples": [], "summary": "

Creates a temporary file and returns a File object representing the new file.

", "name": "createTempFile" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Filesystem.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Filesystem.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.Filesystem.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Filesystem.getApplicationDataDirectory-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the applicationDataDirectory property.

", "name": "getApplicationDataDirectory" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Filesystem.getApplicationDirectory-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the applicationDirectory property.

", "name": "getApplicationDirectory" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Filesystem.getApplicationSupportDirectory-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the applicationSupportDirectory property.

", "name": "getApplicationSupportDirectory" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Filesystem.getExternalStorageDirectory-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the externalStorageDirectory property.

", "name": "getExternalStorageDirectory" }, { "description": "

Note that getFile does not create a file if one does not exist at the specified\npath. It returns a new File object referring to the specified file path. The \napplication can create a file at that path by calling \nwrite or create a directory by calling\ncreateDirectory on the File object.

\n

This method takes a variable number of arguments, where each argument is treated\nas a path component. All of the arguments are joined together using the\nplatform-specific path separator to make the final path.

\n

If a relative path is passed, the full path should be interpreted relative\nto the current file. For example, if the file Resources/login/login.js \ncontains the following code:

\n
var icon = Titanium.Filesystem.getFile('icon.png');\n
\n

The path is interpreted as Resources/login/icon.png.

\n

On iOS, all relative paths are currently interpreted as relative to the\nResources directory, not to the current context. This is a known issue\nthat will be addressed in a future release.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Filesystem.getFile-method.path-param", "optional": false, "summary": "

One or more path components. Path arguments are joined together using the platform specific path separator to form the full path.

", "type": "String", "name": "path" } ], "deprecated": null, "filename": "Titanium.Filesystem.getFile-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "Titanium.Filesystem.File" }, "examples": [], "summary": "

Returns a File object representing the file identified by the path arguments.

", "name": "getFile" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Filesystem.getLineEnding-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the lineEnding property.

", "name": "getLineEnding" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Filesystem.getResourcesDirectory-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the resourcesDirectory property.

", "name": "getResourcesDirectory" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Filesystem.getSeparator-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the separator property.

", "name": "getSeparator" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Filesystem.getTempDirectory-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the tempDirectory property.

", "name": "getTempDirectory" }, { "description": "

Returns true on Android if an external storage device, such as an SD card, is\navailable for reading and writing.

\n

Returns false on iOS.

", "parameters": [], "deprecated": null, "filename": "Titanium.Filesystem.isExternalStoragePresent-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "Boolean" }, "examples": [], "summary": "

Returns true if the device supports external storage and the external storage device is mounted.

", "name": "isExternalStoragePresent" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Filesystem.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Filesystem.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Filesystem.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" } ], "platforms": [ { "pretty_name": "Android", "since": "0.1", "name": "android" }, { "pretty_name": "iPhone", "since": "0.1", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.1", "name": "ipad" } ], "objects": [ "Titanium.Filesystem.File", "Titanium.Filesystem.FileStream" ], "examples": [], "summary": "

The top level filesystem module, used to access files and directories on the device.

", "type": "module", "events": [], "name": "Titanium.Filesystem" }, "Titanium.UI.CoverFlowView": { "properties": [ { "description": "

Anchor point is specified as a fraction of the view's size. So \n(0.5,0.5) represents the view's center and (1, 1) is the view's bottom-right \ncorner.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.anchorPoint-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Anchor point where animation should occur, relative to the view's boundaries.

", "type": "Point", "name": "anchorPoint" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.animatedCenterPoint-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Current position of the view during an animation.

", "type": "Point", "name": "animatedCenterPoint" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.backgroundColor-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Background color of the view.

", "type": "String", "name": "backgroundColor" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.backgroundDisabledColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Disabled background color of the view.

", "type": "String", "name": "backgroundDisabledColor" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.backgroundDisabledImage-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Disabled background image for the view, specified as a local file path or URL.

", "type": "String", "name": "backgroundDisabledImage" }, { "description": "

For normal views, the focused color is only used if focusable is true.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.backgroundFocusedColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Focused background color of the view.

", "type": "String", "name": "backgroundFocusedColor" }, { "description": "

For normal views, the focused background is only used if focusable is true.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.backgroundFocusedImage-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Focused background image for the view, specified as a local file path or URL.

", "type": "String", "name": "backgroundFocusedImage" }, { "description": "

A gradient can be defined as either linear or radial. A linear gradient\nvaries continuously along a line between the startPoint and endPoint.\nA radial gradient is interpolated between two circles, defined by startPoint\nand startRadius and endPoint and endRadius respectively.

\n

The start and end points and radius values can be defined in device units,\nin the view's coordinates, or as percentages of the view's size. Thus, if\na view is 60 x 60, the center point of the view can be specified as:

\n
{ x: 30, y: 30 }\n
\n

Or:\n { x: '50%', y: '50%' }

\n

When specifying multiple colors, you can specify an offset value for\neach color, defining how far into the gradient it takes effect. For example,\nthe following color array specifies a gradient that goes from red to blue back to red:

\n
colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ]\n
", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.backgroundGradient-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [ { "code": "

The following code excerpt creates two views, one with a linear gradient and one with\na radial gradient.

\n
var win1 = Titanium.UI.createWindow({\n    title:'Tab 1',\n    backgroundColor:'#fff',\n    layout: 'vertical'\n});\n\nvar radialGradient = Ti.UI.createView({\n    top: 10,\n    width: 100,\n    height: 100,\n    backgroundGradient: {\n        type: 'radial',\n        startPoint: { x: 50, y: 50 },\n        endPoint: { x: 50, y: 50 },\n        colors: [ 'red', 'blue'],\n        startRadius: '90%',\n        endRadius: 0,\n        backfillStart: true\n    }\n});\nvar linearGradient = Ti.UI.createView({\n    top: 10,\n    width: 100,\n    height: 100,\n    backgroundGradient: {\n        type: 'linear',\n        startPoint: { x: '0%', y: '50%' },\n        endPoint: { x: '100%', y: '50%' },\n        colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ],\n    }\n});\nwin1.add(radialGradient);\nwin1.add(linearGradient);\nwin1.open();\n
", "description": "Linear and Radial Gradients" } ], "summary": "

A background gradient for the view.

", "type": "Gradient", "name": "backgroundGradient" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.backgroundImage-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Background image for the view, specified as a local file path or URL.

", "type": "String", "name": "backgroundImage" }, { "description": "

End caps specify the portion of an image that should not be resized when an \nimage is stretched. This technique is used to implement buttons and other \nresizable image-based interface elements. When a button with end caps is resized, \nthe resizing occurs only in the middle of the button, in the region between the end \ncaps. The end caps themselves keep their original size and appearance. This property \nspecifies the size of the left end cap. The middle (stretchable) portion is assumed to \nbe 1 pixel wide. The right end cap is therefore computed by adding the size of the left \nend cap and the middle portion together and then subtracting that value from the width \nof the image

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.backgroundLeftCap-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Size of the left end cap.

", "type": "Number", "name": "backgroundLeftCap" }, { "description": "

Setting this to true makes the set backgroundImage repeat across\nthe view as a series of tiles. The tiling is begins in the upper-left\ncorner, where the upper-left corner of the background image is rendered.\nThe image is then tiled to fill the available space of the view.

\n

Note that setting this to true may incur performance penalties for\nlarge views or background images, as the tiling must be redone\nwhenever a view is resized.

\n

The following views do not currently support tiled backgrounds:\n Titanium.UI.Button\n Titanium.UI.TextField\n* Titanium.UI.Label

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.backgroundRepeat-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Toggle for whether or not to tile a background across a view.

", "type": "Boolean", "name": "backgroundRepeat" }, { "description": "

focusable must be true for normal views.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.backgroundSelectedColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Selected background color of the view.

", "type": "String", "name": "backgroundSelectedColor" }, { "description": "

For normal views, the selected background is only used if focusable is true.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.backgroundSelectedImage-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Selected background image url for the view, specified as a local file path or URL.

", "type": "String", "name": "backgroundSelectedImage" }, { "description": "

End caps specify the portion of an image that should not be resized when an image \nis stretched. This technique is used to implement buttons and other resizable \nimage-based interface elements. When a button with end caps is resized, the resizing \noccurs only in the middle of the button, in the region between the end caps. The end \ncaps themselves keep their original size and appearance. This property specifies the \nsize of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. \nThe bottom end cap is therefore computed by adding the size of the top end cap and the\nmiddle portion together and then subtracting that value from the height of the image.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.backgroundTopCap-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Size of the top end cap.

", "type": "Number", "name": "backgroundTopCap" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.borderColor-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Border color of the view.

", "type": "String", "name": "borderColor" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.borderRadius-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Border radius of the view.

", "type": "Number", "name": "borderRadius" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.borderWidth-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Border width of the view.

", "type": "Number", "name": "borderWidth" }, { "description": "

This position is relative to the view's parent. Exact interpretation depends on the \nparent view's layout property. Can be either a float value or \na dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.bottom-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

View's bottom position, in platform-specific units.

", "type": [ "Number", "String" ], "name": "bottom" }, { "description": "

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.center-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

View's center position, in the parent view's coordinates.

", "type": "Point", "name": "center" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.children-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Array of this view's child views.

", "type": "Array", "name": "children" }, { "description": null, "default": false, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.focusable-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Whether view should be focusable while navigating with the trackball.

", "type": "Boolean", "name": "focusable" }, { "description": "

Can be either a float value or a dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying the view's height dimension. To determine the view's \nsize once rendered, see the size property.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.height-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

View height, in platform-specific units.

", "type": [ "Number", "String" ], "name": "height" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.images-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Array of images to display in the view.

", "type": [ "Array", "Array", "Array", "Array" ], "name": "images" }, { "description": "

When true the screen will not power down. Note: enabling this feature will use more \npower, thereby adversely affecting run time when on battery.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.keepScreenOn-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Whether to keep the device screen on.

", "type": "Boolean", "name": "keepScreenOn" }, { "description": "

There are three layout options:

\n
    \n
  • \n

    absolute. Default layout. A child view's top, bottom, left, and right \n properties are interpreted as absolute values in the parent's coordinate space.

    \n

    If the child includes a top value and not a bottom value, the child is \npositioned top units from the top of the parent's bounding box, and its height\nis set based on its height property.

    \n

    If the child includes a bottom value and not a top value, the child is \npositioned bottom units from the bottom of the parent's bounding box. Its height\nis set based on its height property.

    \n

    If the child includes both top and bottom values, the behavior is \nplatform-specific.

    \n

    Similar calculations are used for left and right.

    \n

    You can also position a child by setting its center property to a Point.

    \n

    If no position is set explicitly, children are centered. For example, if a \nchild specifies a top of 20 and does not specify any other position properties,\nthe child is positioned 20 units from the parent's top, and centered horizontally.

    \n
    • \n
  • \n

    vertical. Children are laid out vertically from top to bottom. The first child \n is laid out top units from its parent's bounding box. Each subsequent child is \n laid out below the previous child. The space between children is equal to the \n upper child's bottom value plus the lower child's top value.

    \n

    Each child is positioned horizontally as for the absolute layout mode.

    \n
    • \n
  • \n

    horizontal. Like vertical layout, except children are laid out horizontally\n from left to right, using the left and right values to determine spacing.

    \n

    Each child is positioned vertically as in the absolute layout mode.

    \n
    • \n
", "default": "absolute layout", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.layout-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Specifies how the view positions its children. \nOne of: 'absolute', 'vertical', or 'horizontal'.

", "type": "String", "name": "layout" }, { "description": "

This position is relative to the view's parent. Exact interpretation depends on the \nparent view's layout property. Can be either a float value or \na dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.left-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

View's left position, in platform-specific units.

", "type": [ "Number", "String" ], "name": "left" }, { "description": null, "default": "1.0 (opaque)", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.opacity-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Opacity of this view, from 0.0 (transparent) to 1.0 (opaque).

", "type": "Number", "name": "opacity" }, { "description": "

This position is relative to the view's parent. Exact interpretation depends on the \nparent view's layout property. Can be either a float value or \na dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.right-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

View's right position, in platform-specific units.

", "type": [ "Number", "String" ], "name": "right" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.selected-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Index to make selected.

", "type": "Number", "name": "selected" }, { "description": "

The correct values will only be available when rendering is fully complete.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.size-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Rendered size of the view as a dictionary of width and height properties.

", "type": "Object", "name": "size" }, { "description": "

One of Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS, \nTitanium.UI.Android.SOFT_KEYBOARD_HIDE_ON_FOCUS, or \nTitanium.UI.Android.SOFT_KEYBOARD_SHOW_ON_FOCUS.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.softKeyboardOnFocus-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Determines keyboard behavior when this view is focused.

", "type": "Number", "name": "softKeyboardOnFocus" }, { "description": "

This position is relative to the view's parent. Exact interpretation depends on the \nparent view's layout property. Can be either a float value or \na dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.top-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

The view's top position.

", "type": [ "Number", "String" ], "name": "top" }, { "description": "

If false, will forward the events to peers.

", "default": true, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.touchEnabled-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Whether view should receive touch events.

", "type": "Boolean", "name": "touchEnabled" }, { "description": "

Android and Mobile Web only support 2DMatrix transforms.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.transform-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Transformation matrix to apply to the view.

", "type": [ "Titanium.UI.2DMatrix", "Titanium.UI.iOS.3DMatrix" ], "name": "transform" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.visible-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Boolean value indicating whether the view is visible.

", "type": "Boolean", "name": "visible" }, { "description": "

Can be either a float value or a dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying the view's width dimension. To \ndetermine the view's size once rendered, see the \nsize property.

", "deprecated": null, "filename": "Titanium.UI.CoverFlowView.width-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

View's width, in platform-specific units.

", "type": [ "Number", "String" ], "name": "width" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.zIndex-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Z index position relative to other sibling views.

", "type": "Number", "name": "zIndex" } ], "description": "

This iOS-specific API has been moved to Titanium.UI.iOS.CoverFlowView.

\n

Use the Titanium.UI.createCoverFlowView method to create a cover flow view.

", "subtype": "proxy", "deprecated": { "removed": "1.9.0", "since": "1.8.0" }, "filename": "Titanium.UI.CoverFlowView-object", "methods": [ { "description": "

There are certain top-level containers that are not intended to be added \nas the children of other views. These top-level containers include \nWindow, SplitWindow,\nand TabGroup. Other types of views must be added \nto a top-level container in order to be displayed on screen.

\n

The special containers NavigationGroup, \nSplitWindow, Tab, and \nTabGroup\nmanage windows. These managed windows may be referred to as children of the \ncontainer, but they are not added using the add method.

\n

Note that although a NavigationGroup\nmanages windows, it is not itself top-level container. It must be added to a \nWindow in order to be displayed.

\n

Tab is another kind of special container: it is not itself a top-level container, \nbut can only be used within a TabGroup. You cannot add a Tab to an arbitrary\ncontainer.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.add-method.view-param", "optional": false, "summary": "

View to add to this view's hierarchy

", "type": "Titanium.UI.View", "name": "view" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.add-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds a child to this view's hierarchy.

", "name": "add" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.addEventListener-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": "

The Animation object or dictionary passed to this\nmethod defines the end state for the animation, the duration of the animation,\nand other properties.

\n

Note that if you use animate to move a view, the view's actual position\nis changed, but its layout properties, such as top, left, center and \nso on are not changed--these reflect the original values set by the user, not\nthe actual position of the view.

\n

In this release, the view's actual position is not available to the application. \nThis feature will be added to a future release.

\n

If you need one or more of the layout properties to be updated after animation,\nyou can update them in the callback after animation is complete. For example:

\n
var newTop = view1.top - 100;\nview1.animate({ top: newTop, duration: 500 }, function () {\n    view.top = newTop; \n});\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.animate-method.obj-param", "optional": false, "summary": "

Either a dictionary of animation properties or an \nAnimation object.

", "type": [ "Titanium.UI.Animation", "Dictionary" ], "name": "obj" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.animate-method.callback-param", "optional": false, "summary": "

Function to be invoked upon completion of the animation.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.animate-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Animates this view.

", "name": "animate" }, { "description": "

If both views are connected in the native view hierarchies, returns the \npoint, converted to destinationView's coordinate system.

\n

Returns null if either view is not in the view hierarchy.\nKeep in mind that views may be removed from the view hierarchy if their window \nis blurred or if the view is offscreen (such as in some situations with \nTitanium.UI.ScrollableView).

\n

If this view is a Titanium.UI.ScrollView, the view's x and y offsets are \nsubtracted from the return value.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.convertPointToView-method.point-param", "optional": false, "summary": "

A point in this view's coordinate system.
\nIf this argument is missing an x or y property, or the properties can not \nbe converted into numbers, an exception will be raised.

", "type": "Point", "name": "point" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.convertPointToView-method.destinationView-param", "optional": false, "summary": "

View that specifies the destination coordinate system to convert to.\nIf this argument is not a view, an exception will be raised.

", "type": "Titanium.UI.View", "name": "destinationView" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.convertPointToView-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "Point" }, "examples": [], "summary": "

Translates a point from this view's coordinate system to another \nview's coordinate system.

", "name": "convertPointToView" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.fireEvent-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getAnchorPoint-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Point" } ], "examples": [], "summary": "

Gets the value of the anchorPoint property.

", "name": "getAnchorPoint" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getAnimatedCenterPoint-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Point" } ], "examples": [], "summary": "

Gets the value of the animatedCenterPoint property.

", "name": "getAnimatedCenterPoint" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBackgroundColor-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundColor property.

", "name": "getBackgroundColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBackgroundDisabledColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundDisabledColor property.

", "name": "getBackgroundDisabledColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBackgroundDisabledImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundDisabledImage property.

", "name": "getBackgroundDisabledImage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBackgroundFocusedColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundFocusedColor property.

", "name": "getBackgroundFocusedColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBackgroundFocusedImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundFocusedImage property.

", "name": "getBackgroundFocusedImage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBackgroundGradient-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Gradient" } ], "examples": [], "summary": "

Gets the value of the backgroundGradient property.

", "name": "getBackgroundGradient" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBackgroundImage-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundImage property.

", "name": "getBackgroundImage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBackgroundLeftCap-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the backgroundLeftCap property.

", "name": "getBackgroundLeftCap" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBackgroundRepeat-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the backgroundRepeat property.

", "name": "getBackgroundRepeat" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBackgroundSelectedColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundSelectedColor property.

", "name": "getBackgroundSelectedColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBackgroundSelectedImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundSelectedImage property.

", "name": "getBackgroundSelectedImage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBackgroundTopCap-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the backgroundTopCap property.

", "name": "getBackgroundTopCap" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBorderColor-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the borderColor property.

", "name": "getBorderColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBorderRadius-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the borderRadius property.

", "name": "getBorderRadius" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBorderWidth-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the borderWidth property.

", "name": "getBorderWidth" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getBottom-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the bottom property.

", "name": "getBottom" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getCenter-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Point" } ], "examples": [], "summary": "

Gets the value of the center property.

", "name": "getCenter" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getChildren-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Array" } ], "examples": [], "summary": "

Gets the value of the children property.

", "name": "getChildren" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getFocusable-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the focusable property.

", "name": "getFocusable" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getHeight-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the height property.

", "name": "getHeight" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getImages-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Array" }, { "type": "Array" }, { "type": "Array" }, { "type": "Array" } ], "examples": [], "summary": "

Gets the value of the images property.

", "name": "getImages" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getKeepScreenOn-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the keepScreenOn property.

", "name": "getKeepScreenOn" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getLayout-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the layout property.

", "name": "getLayout" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getLeft-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the left property.

", "name": "getLeft" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getOpacity-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the opacity property.

", "name": "getOpacity" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getRight-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the right property.

", "name": "getRight" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getSelected-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the selected property.

", "name": "getSelected" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getSize-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Object" } ], "examples": [], "summary": "

Gets the value of the size property.

", "name": "getSize" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getSoftKeyboardOnFocus-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the softKeyboardOnFocus property.

", "name": "getSoftKeyboardOnFocus" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getTop-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the top property.

", "name": "getTop" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getTouchEnabled-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the touchEnabled property.

", "name": "getTouchEnabled" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getTransform-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Titanium.UI.2DMatrix" }, { "type": "Titanium.UI.iOS.3DMatrix" } ], "examples": [], "summary": "

Gets the value of the transform property.

", "name": "getTransform" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getVisible-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the visible property.

", "name": "getVisible" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getWidth-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the width property.

", "name": "getWidth" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.getZIndex-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the zIndex property.

", "name": "getZIndex" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.hide-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Hides this view.

", "name": "hide" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.remove-method.view-param", "optional": false, "summary": "

View to remove from this view's hierarchy.

", "type": "Titanium.UI.View", "name": "view" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.remove-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes a child view from this view's hierarchy.

", "name": "remove" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.removeEventListener-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setAnchorPoint-method.anchorPoint-param", "optional": false, "summary": "

New value for the property.

", "type": "Point", "name": "anchorPoint" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setAnchorPoint-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the anchorPoint property.

", "name": "setAnchorPoint" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundColor-method.backgroundColor-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundColor" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundColor-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundColor property.

", "name": "setBackgroundColor" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundDisabledColor-method.backgroundDisabledColor-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundDisabledColor" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundDisabledColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundDisabledColor property.

", "name": "setBackgroundDisabledColor" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundDisabledImage-method.backgroundDisabledImage-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundDisabledImage" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundDisabledImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundDisabledImage property.

", "name": "setBackgroundDisabledImage" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundFocusedColor-method.backgroundFocusedColor-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundFocusedColor" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundFocusedColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundFocusedColor property.

", "name": "setBackgroundFocusedColor" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundFocusedImage-method.backgroundFocusedImage-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundFocusedImage" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundFocusedImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundFocusedImage property.

", "name": "setBackgroundFocusedImage" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundGradient-method.backgroundGradient-param", "optional": false, "summary": "

New value for the property.

", "type": "Gradient", "name": "backgroundGradient" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundGradient-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundGradient property.

", "name": "setBackgroundGradient" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundImage-method.backgroundImage-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundImage" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundImage-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundImage property.

", "name": "setBackgroundImage" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundLeftCap-method.backgroundLeftCap-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "backgroundLeftCap" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundLeftCap-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundLeftCap property.

", "name": "setBackgroundLeftCap" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundRepeat-method.backgroundRepeat-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "backgroundRepeat" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundRepeat-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundRepeat property.

", "name": "setBackgroundRepeat" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundSelectedColor-method.backgroundSelectedColor-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundSelectedColor" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundSelectedColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundSelectedColor property.

", "name": "setBackgroundSelectedColor" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundSelectedImage-method.backgroundSelectedImage-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundSelectedImage" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundSelectedImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundSelectedImage property.

", "name": "setBackgroundSelectedImage" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundTopCap-method.backgroundTopCap-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "backgroundTopCap" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBackgroundTopCap-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundTopCap property.

", "name": "setBackgroundTopCap" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBorderColor-method.borderColor-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "borderColor" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBorderColor-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the borderColor property.

", "name": "setBorderColor" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBorderRadius-method.borderRadius-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "borderRadius" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBorderRadius-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the borderRadius property.

", "name": "setBorderRadius" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBorderWidth-method.borderWidth-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "borderWidth" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBorderWidth-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the borderWidth property.

", "name": "setBorderWidth" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBottom-method.bottom-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Number", "String" ], "name": "bottom" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setBottom-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the bottom property.

", "name": "setBottom" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setCenter-method.center-param", "optional": false, "summary": "

New value for the property.

", "type": "Point", "name": "center" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setCenter-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the center property.

", "name": "setCenter" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setFocusable-method.focusable-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "focusable" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setFocusable-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the focusable property.

", "name": "setFocusable" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setHeight-method.height-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Number", "String" ], "name": "height" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setHeight-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the height property.

", "name": "setHeight" }, { "description": "

To specify a size for the image, you may pass the image as a simple dictionary, as\ndefined in CoverFlowImageType. If you specify a size, the size must be exact,\nnot 'auto' or a percentage size.

\n

If the image is passed as a File object or file path, the filename is checked.\nIf the filename includes the '@2x' string used to identify high-resolution images\nfor the Retina display, the image is treated accordingly.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setImage-method.index-param", "optional": false, "summary": "

Index to add the image at.

", "type": "Number", "name": "index" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setImage-method.image-param", "optional": false, "summary": "

Image to add at this index.

", "type": [ "String", "Titanium.Blob", "Titanium.File", "CoverFlowImageType" ], "name": "image" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setImage-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Changes the image for a specified index.

", "name": "setImage" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setImages-method.images-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Array", "Array", "Array", "Array" ], "name": "images" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setImages-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the images property.

", "name": "setImages" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setKeepScreenOn-method.keepScreenOn-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "keepScreenOn" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setKeepScreenOn-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the keepScreenOn property.

", "name": "setKeepScreenOn" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setLayout-method.layout-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "layout" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setLayout-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the layout property.

", "name": "setLayout" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setLeft-method.left-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Number", "String" ], "name": "left" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setLeft-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the left property.

", "name": "setLeft" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setOpacity-method.opacity-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "opacity" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setOpacity-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the opacity property.

", "name": "setOpacity" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setRight-method.right-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Number", "String" ], "name": "right" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setRight-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the right property.

", "name": "setRight" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setSelected-method.selected-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "selected" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setSelected-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the selected property.

", "name": "setSelected" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setSoftKeyboardOnFocus-method.softKeyboardOnFocus-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "softKeyboardOnFocus" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setSoftKeyboardOnFocus-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the softKeyboardOnFocus property.

", "name": "setSoftKeyboardOnFocus" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setTop-method.top-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Number", "String" ], "name": "top" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setTop-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the top property.

", "name": "setTop" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setTouchEnabled-method.touchEnabled-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "touchEnabled" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setTouchEnabled-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the touchEnabled property.

", "name": "setTouchEnabled" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setTransform-method.transform-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Titanium.UI.2DMatrix", "Titanium.UI.iOS.3DMatrix" ], "name": "transform" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setTransform-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the transform property.

", "name": "setTransform" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setVisible-method.visible-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "visible" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setVisible-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the visible property.

", "name": "setVisible" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setWidth-method.width-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Number", "String" ], "name": "width" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setWidth-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the width property.

", "name": "setWidth" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setZIndex-method.zIndex-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "zIndex" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.setZIndex-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the zIndex property.

", "name": "setZIndex" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.show-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Makes this view visible.

", "name": "show" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.toImage-method.f-param", "type": "Callback", "summary": "

Function to be invoked upon completion. If non-null, this method will be \nperformed asynchronously. If null, it will be performed immediately.

", "optional": true, "name": "f" } ], "deprecated": null, "filename": "Titanium.UI.CoverFlowView.toImage-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "Titanium.Blob" }, "examples": [], "summary": "

Returns an image of the rendered view, as a Blob.

", "name": "toImage" } ], "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [ { "code": "

Create a simple cover flow view.

\n
var view = Titanium.UI.createCoverFlowView({\n    images:['a.png','b.png','c.png'],\n    backgroundColor:'#000'\n});\nwindow.add(view);\n
", "description": "Simple 3 image cover flow example" } ], "summary": "

Use Titanium.UI.iOS.CoverFlowView instead.

", "type": "object", "events": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.change-event", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

Fired when the user changes the image using a gesture.

", "properties": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.change.index-callback-property", "summary": "

Index of the image that is now visible.

", "type": "Number", "name": "index" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.change.previous-callback-property", "summary": "

Index of the previously-visible image.

", "type": "Number", "name": "previous" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.change.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.change.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" } ], "name": "change" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.click-event", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

Fired when the user clicks on the view.

", "properties": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.click.index-callback-property", "summary": "

Index of the image that is now visible.

", "type": "Number", "name": "index" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.click.previous-callback-property", "summary": "

Index of the previously-visible image.

", "type": "Number", "name": "previous" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.click.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.CoverFlowView.click.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" } ], "name": "click" } ], "name": "Titanium.UI.CoverFlowView" }, "Titanium.UI.ScrollableView": { "properties": [ { "description": "

Anchor point is specified as a fraction of the view's size. So \n(0.5,0.5) represents the view's center and (1, 1) is the view's bottom-right \ncorner.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.anchorPoint-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Anchor point where animation should occur, relative to the view's boundaries.

", "type": "Point", "name": "anchorPoint" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.ScrollableView.animatedCenterPoint-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Current position of the view during an animation.

", "type": "Point", "name": "animatedCenterPoint" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.backgroundColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Background color of the view.

", "type": "String", "name": "backgroundColor" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.backgroundDisabledColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Disabled background color of the view.

", "type": "String", "name": "backgroundDisabledColor" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.backgroundDisabledImage-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Disabled background image for the view, specified as a local file path or URL.

", "type": "String", "name": "backgroundDisabledImage" }, { "description": "

For normal views, the focused color is only used if focusable is true.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.backgroundFocusedColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Focused background color of the view.

", "type": "String", "name": "backgroundFocusedColor" }, { "description": "

For normal views, the focused background is only used if focusable is true.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.backgroundFocusedImage-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Focused background image for the view, specified as a local file path or URL.

", "type": "String", "name": "backgroundFocusedImage" }, { "description": "

A gradient can be defined as either linear or radial. A linear gradient\nvaries continuously along a line between the startPoint and endPoint.\nA radial gradient is interpolated between two circles, defined by startPoint\nand startRadius and endPoint and endRadius respectively.

\n

The start and end points and radius values can be defined in device units,\nin the view's coordinates, or as percentages of the view's size. Thus, if\na view is 60 x 60, the center point of the view can be specified as:

\n
{ x: 30, y: 30 }\n
\n

Or:\n { x: '50%', y: '50%' }

\n

When specifying multiple colors, you can specify an offset value for\neach color, defining how far into the gradient it takes effect. For example,\nthe following color array specifies a gradient that goes from red to blue back to red:

\n
colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ]\n
", "deprecated": null, "filename": "Titanium.UI.ScrollableView.backgroundGradient-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [ { "code": "

The following code excerpt creates two views, one with a linear gradient and one with\na radial gradient.

\n
var win1 = Titanium.UI.createWindow({\n    title:'Tab 1',\n    backgroundColor:'#fff',\n    layout: 'vertical'\n});\n\nvar radialGradient = Ti.UI.createView({\n    top: 10,\n    width: 100,\n    height: 100,\n    backgroundGradient: {\n        type: 'radial',\n        startPoint: { x: 50, y: 50 },\n        endPoint: { x: 50, y: 50 },\n        colors: [ 'red', 'blue'],\n        startRadius: '90%',\n        endRadius: 0,\n        backfillStart: true\n    }\n});\nvar linearGradient = Ti.UI.createView({\n    top: 10,\n    width: 100,\n    height: 100,\n    backgroundGradient: {\n        type: 'linear',\n        startPoint: { x: '0%', y: '50%' },\n        endPoint: { x: '100%', y: '50%' },\n        colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ],\n    }\n});\nwin1.add(radialGradient);\nwin1.add(linearGradient);\nwin1.open();\n
", "description": "Linear and Radial Gradients" } ], "summary": "

A background gradient for the view.

", "type": "Gradient", "name": "backgroundGradient" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.backgroundImage-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Background image for the view, specified as a local file path or URL.

", "type": "String", "name": "backgroundImage" }, { "description": "

End caps specify the portion of an image that should not be resized when an \nimage is stretched. This technique is used to implement buttons and other \nresizable image-based interface elements. When a button with end caps is resized, \nthe resizing occurs only in the middle of the button, in the region between the end \ncaps. The end caps themselves keep their original size and appearance. This property \nspecifies the size of the left end cap. The middle (stretchable) portion is assumed to \nbe 1 pixel wide. The right end cap is therefore computed by adding the size of the left \nend cap and the middle portion together and then subtracting that value from the width \nof the image

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.backgroundLeftCap-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Size of the left end cap.

", "type": "Number", "name": "backgroundLeftCap" }, { "description": "

Setting this to true makes the set backgroundImage repeat across\nthe view as a series of tiles. The tiling is begins in the upper-left\ncorner, where the upper-left corner of the background image is rendered.\nThe image is then tiled to fill the available space of the view.

\n

Note that setting this to true may incur performance penalties for\nlarge views or background images, as the tiling must be redone\nwhenever a view is resized.

\n

The following views do not currently support tiled backgrounds:\n Titanium.UI.Button\n Titanium.UI.TextField\n* Titanium.UI.Label

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.backgroundRepeat-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Toggle for whether or not to tile a background across a view.

", "type": "Boolean", "name": "backgroundRepeat" }, { "description": "

focusable must be true for normal views.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.backgroundSelectedColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Selected background color of the view.

", "type": "String", "name": "backgroundSelectedColor" }, { "description": "

For normal views, the selected background is only used if focusable is true.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.backgroundSelectedImage-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Selected background image url for the view, specified as a local file path or URL.

", "type": "String", "name": "backgroundSelectedImage" }, { "description": "

End caps specify the portion of an image that should not be resized when an image \nis stretched. This technique is used to implement buttons and other resizable \nimage-based interface elements. When a button with end caps is resized, the resizing \noccurs only in the middle of the button, in the region between the end caps. The end \ncaps themselves keep their original size and appearance. This property specifies the \nsize of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. \nThe bottom end cap is therefore computed by adding the size of the top end cap and the\nmiddle portion together and then subtracting that value from the height of the image.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.backgroundTopCap-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Size of the top end cap.

", "type": "Number", "name": "backgroundTopCap" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.borderColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Border color of the view.

", "type": "String", "name": "borderColor" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.borderRadius-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Border radius of the view.

", "type": "Number", "name": "borderRadius" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.borderWidth-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Border width of the view.

", "type": "Number", "name": "borderWidth" }, { "description": "

This position is relative to the view's parent. Exact interpretation depends on the \nparent view's layout property. Can be either a float value or \na dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.bottom-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

View's bottom position, in platform-specific units.

", "type": [ "Number", "String" ], "name": "bottom" }, { "description": "

Views are rendered in the range (currentPage +/- (cacheSize - 1)/2), ROUNDED DOWN for even \nvalues (i.e. cacheSize=4 renders 3 views into the cache.) Keep in mind that improved \nperformance (larger cache) will lead to faster performance, but greater memory usage.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.cacheSize-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Number of views to cache (pre-render).

", "type": "Number", "name": "cacheSize" }, { "description": "

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.center-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

View's center position, in the parent view's coordinates.

", "type": "Point", "name": "center" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.ScrollableView.children-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Array of this view's child views.

", "type": "Array", "name": "children" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.currentPage-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Index of the active page.

", "type": "Number", "name": "currentPage" }, { "description": null, "default": false, "deprecated": null, "filename": "Titanium.UI.ScrollableView.disableBounce-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Determines whether view bouncing effect is disabled.

", "type": "Boolean", "name": "disableBounce" }, { "description": null, "default": false, "deprecated": null, "filename": "Titanium.UI.ScrollableView.focusable-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Whether view should be focusable while navigating with the trackball.

", "type": "Boolean", "name": "focusable" }, { "description": "

Can be either a float value or a dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying the view's height dimension. To determine the view's \nsize once rendered, see the size property.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.height-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

View height, in platform-specific units.

", "type": [ "Number", "String" ], "name": "height" }, { "description": "

When true the screen will not power down. Note: enabling this feature will use more \npower, thereby adversely affecting run time when on battery.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.keepScreenOn-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Whether to keep the device screen on.

", "type": "Boolean", "name": "keepScreenOn" }, { "description": "

There are three layout options:

\n
    \n
  • \n

    absolute. Default layout. A child view's top, bottom, left, and right \n properties are interpreted as absolute values in the parent's coordinate space.

    \n

    If the child includes a top value and not a bottom value, the child is \npositioned top units from the top of the parent's bounding box, and its height\nis set based on its height property.

    \n

    If the child includes a bottom value and not a top value, the child is \npositioned bottom units from the bottom of the parent's bounding box. Its height\nis set based on its height property.

    \n

    If the child includes both top and bottom values, the behavior is \nplatform-specific.

    \n

    Similar calculations are used for left and right.

    \n

    You can also position a child by setting its center property to a Point.

    \n

    If no position is set explicitly, children are centered. For example, if a \nchild specifies a top of 20 and does not specify any other position properties,\nthe child is positioned 20 units from the parent's top, and centered horizontally.

    \n
    • \n
  • \n

    vertical. Children are laid out vertically from top to bottom. The first child \n is laid out top units from its parent's bounding box. Each subsequent child is \n laid out below the previous child. The space between children is equal to the \n upper child's bottom value plus the lower child's top value.

    \n

    Each child is positioned horizontally as for the absolute layout mode.

    \n
    • \n
  • \n

    horizontal. Like vertical layout, except children are laid out horizontally\n from left to right, using the left and right values to determine spacing.

    \n

    Each child is positioned vertically as in the absolute layout mode.

    \n
    • \n
", "default": "absolute layout", "deprecated": null, "filename": "Titanium.UI.ScrollableView.layout-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Specifies how the view positions its children. \nOne of: 'absolute', 'vertical', or 'horizontal'.

", "type": "String", "name": "layout" }, { "description": "

This position is relative to the view's parent. Exact interpretation depends on the \nparent view's layout property. Can be either a float value or \na dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.left-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

View's left position, in platform-specific units.

", "type": [ "Number", "String" ], "name": "left" }, { "description": null, "default": "1.0 (opaque)", "deprecated": null, "filename": "Titanium.UI.ScrollableView.opacity-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Opacity of this view, from 0.0 (transparent) to 1.0 (opaque).

", "type": "Number", "name": "opacity" }, { "description": null, "default": "black", "deprecated": null, "filename": "Titanium.UI.ScrollableView.pagingControlColor-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Color of the paging control, in \nweb color name or hex format.

", "type": "String", "name": "pagingControlColor" }, { "description": null, "default": 20, "deprecated": null, "filename": "Titanium.UI.ScrollableView.pagingControlHeight-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Height of the paging control, in pixels.

", "type": "Number", "name": "pagingControlHeight" }, { "description": null, "default": 3000, "deprecated": null, "filename": "Titanium.UI.ScrollableView.pagingControlTimeout-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Number of milliseconds to wait before hiding the paging control. Less than or equal to \n0 disables timeout, keeping controls displayed.

", "type": "Number", "availability": "creation", "name": "pagingControlTimeout" }, { "description": "

This position is relative to the view's parent. Exact interpretation depends on the \nparent view's layout property. Can be either a float value or \na dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.right-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

View's right position, in platform-specific units.

", "type": [ "Number", "String" ], "name": "right" }, { "description": null, "default": false, "deprecated": null, "filename": "Titanium.UI.ScrollableView.showPagingControl-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Determines whether the paging control is visible.

", "type": "Boolean", "name": "showPagingControl" }, { "description": "

The correct values will only be available when rendering is fully complete.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.ScrollableView.size-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Rendered size of the view as a dictionary of width and height properties.

", "type": "Object", "name": "size" }, { "description": "

One of Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS, \nTitanium.UI.Android.SOFT_KEYBOARD_HIDE_ON_FOCUS, or \nTitanium.UI.Android.SOFT_KEYBOARD_SHOW_ON_FOCUS.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.softKeyboardOnFocus-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Determines keyboard behavior when this view is focused.

", "type": "Number", "name": "softKeyboardOnFocus" }, { "description": "

This position is relative to the view's parent. Exact interpretation depends on the \nparent view's layout property. Can be either a float value or \na dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.top-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

The view's top position.

", "type": [ "Number", "String" ], "name": "top" }, { "description": "

If false, will forward the events to peers.

", "default": true, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchEnabled-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Whether view should receive touch events.

", "type": "Boolean", "name": "touchEnabled" }, { "description": "

Android and Mobile Web only support 2DMatrix transforms.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.transform-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Transformation matrix to apply to the view.

", "type": [ "Titanium.UI.2DMatrix", "Titanium.UI.iOS.3DMatrix" ], "name": "transform" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.views-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Sets the views within this Scrollable View.

", "type": "Array", "name": "views" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.visible-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Boolean value indicating whether the view is visible.

", "type": "Boolean", "name": "visible" }, { "description": "

Can be either a float value or a dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying the view's width dimension. To \ndetermine the view's size once rendered, see the \nsize property.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.width-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

View's width, in platform-specific units.

", "type": [ "Number", "String" ], "name": "width" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.zIndex-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Z index position relative to other sibling views.

", "type": "Number", "name": "zIndex" } ], "description": "

Use the Titanium.UI.createScrollableView method to create a scrollable view.

\n

ScrollableView supports a visual paging control that may be enabled to indicate on-screen that \na view is visible.

\n

Only the scroll event exists on Android. To support those that are missing, event listeners \nmay be added to its child views.

\n

In a previous Titanium version for iOS, the maxZoomScale and minZoomScale properties were \nremoved for performance and parity reasons. As they still remain in Titanium.UI.ScrollView, \nthe equivalent functionality may be obtained by adding a ScrollView to ScrollableView. See the \n\"Simple Scrollable View with 2 Zoomable Images\" example for a demonstration.

", "subtype": "proxy", "deprecated": null, "filename": "Titanium.UI.ScrollableView-object", "methods": [ { "description": "

There are certain top-level containers that are not intended to be added \nas the children of other views. These top-level containers include \nWindow, SplitWindow,\nand TabGroup. Other types of views must be added \nto a top-level container in order to be displayed on screen.

\n

The special containers NavigationGroup, \nSplitWindow, Tab, and \nTabGroup\nmanage windows. These managed windows may be referred to as children of the \ncontainer, but they are not added using the add method.

\n

Note that although a NavigationGroup\nmanages windows, it is not itself top-level container. It must be added to a \nWindow in order to be displayed.

\n

Tab is another kind of special container: it is not itself a top-level container, \nbut can only be used within a TabGroup. You cannot add a Tab to an arbitrary\ncontainer.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.add-method.view-param", "optional": false, "summary": "

View to add to this view's hierarchy

", "type": "Titanium.UI.View", "name": "view" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.add-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds a child to this view's hierarchy.

", "name": "add" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.addView-method.view-param", "optional": false, "summary": "

The view to add.

", "type": "Object", "name": "view" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.addView-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds a new view to this Scrollable View.

", "name": "addView" }, { "description": "

The Animation object or dictionary passed to this\nmethod defines the end state for the animation, the duration of the animation,\nand other properties.

\n

Note that if you use animate to move a view, the view's actual position\nis changed, but its layout properties, such as top, left, center and \nso on are not changed--these reflect the original values set by the user, not\nthe actual position of the view.

\n

In this release, the view's actual position is not available to the application. \nThis feature will be added to a future release.

\n

If you need one or more of the layout properties to be updated after animation,\nyou can update them in the callback after animation is complete. For example:

\n
var newTop = view1.top - 100;\nview1.animate({ top: newTop, duration: 500 }, function () {\n    view.top = newTop; \n});\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.animate-method.obj-param", "optional": false, "summary": "

Either a dictionary of animation properties or an \nAnimation object.

", "type": [ "Titanium.UI.Animation", "Dictionary" ], "name": "obj" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.animate-method.callback-param", "optional": false, "summary": "

Function to be invoked upon completion of the animation.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.animate-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Animates this view.

", "name": "animate" }, { "description": "

If both views are connected in the native view hierarchies, returns the \npoint, converted to destinationView's coordinate system.

\n

Returns null if either view is not in the view hierarchy.\nKeep in mind that views may be removed from the view hierarchy if their window \nis blurred or if the view is offscreen (such as in some situations with \nTitanium.UI.ScrollableView).

\n

If this view is a Titanium.UI.ScrollView, the view's x and y offsets are \nsubtracted from the return value.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.convertPointToView-method.point-param", "optional": false, "summary": "

A point in this view's coordinate system.
\nIf this argument is missing an x or y property, or the properties can not \nbe converted into numbers, an exception will be raised.

", "type": "Point", "name": "point" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.convertPointToView-method.destinationView-param", "optional": false, "summary": "

View that specifies the destination coordinate system to convert to.\nIf this argument is not a view, an exception will be raised.

", "type": "Titanium.UI.View", "name": "destinationView" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.convertPointToView-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "Point" }, "examples": [], "summary": "

Translates a point from this view's coordinate system to another \nview's coordinate system.

", "name": "convertPointToView" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getAnchorPoint-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Point" } ], "examples": [], "summary": "

Gets the value of the anchorPoint property.

", "name": "getAnchorPoint" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getAnimatedCenterPoint-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Point" } ], "examples": [], "summary": "

Gets the value of the animatedCenterPoint property.

", "name": "getAnimatedCenterPoint" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBackgroundColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundColor property.

", "name": "getBackgroundColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBackgroundDisabledColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundDisabledColor property.

", "name": "getBackgroundDisabledColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBackgroundDisabledImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundDisabledImage property.

", "name": "getBackgroundDisabledImage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBackgroundFocusedColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundFocusedColor property.

", "name": "getBackgroundFocusedColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBackgroundFocusedImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundFocusedImage property.

", "name": "getBackgroundFocusedImage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBackgroundGradient-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "Gradient" } ], "examples": [], "summary": "

Gets the value of the backgroundGradient property.

", "name": "getBackgroundGradient" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBackgroundImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundImage property.

", "name": "getBackgroundImage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBackgroundLeftCap-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the backgroundLeftCap property.

", "name": "getBackgroundLeftCap" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBackgroundRepeat-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the backgroundRepeat property.

", "name": "getBackgroundRepeat" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBackgroundSelectedColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundSelectedColor property.

", "name": "getBackgroundSelectedColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBackgroundSelectedImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundSelectedImage property.

", "name": "getBackgroundSelectedImage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBackgroundTopCap-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the backgroundTopCap property.

", "name": "getBackgroundTopCap" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBorderColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the borderColor property.

", "name": "getBorderColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBorderRadius-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the borderRadius property.

", "name": "getBorderRadius" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBorderWidth-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the borderWidth property.

", "name": "getBorderWidth" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getBottom-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the bottom property.

", "name": "getBottom" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getCacheSize-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the cacheSize property.

", "name": "getCacheSize" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getCenter-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Point" } ], "examples": [], "summary": "

Gets the value of the center property.

", "name": "getCenter" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getChildren-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Array" } ], "examples": [], "summary": "

Gets the value of the children property.

", "name": "getChildren" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getCurrentPage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the currentPage property.

", "name": "getCurrentPage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getDisableBounce-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the disableBounce property.

", "name": "getDisableBounce" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getFocusable-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the focusable property.

", "name": "getFocusable" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getHeight-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the height property.

", "name": "getHeight" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getKeepScreenOn-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the keepScreenOn property.

", "name": "getKeepScreenOn" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getLayout-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the layout property.

", "name": "getLayout" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getLeft-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the left property.

", "name": "getLeft" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getOpacity-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the opacity property.

", "name": "getOpacity" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getPagingControlColor-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the pagingControlColor property.

", "name": "getPagingControlColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getPagingControlHeight-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the pagingControlHeight property.

", "name": "getPagingControlHeight" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getPagingControlTimeout-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the pagingControlTimeout property.

", "name": "getPagingControlTimeout" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getRight-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the right property.

", "name": "getRight" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getShowPagingControl-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the showPagingControl property.

", "name": "getShowPagingControl" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getSize-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Object" } ], "examples": [], "summary": "

Gets the value of the size property.

", "name": "getSize" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getSoftKeyboardOnFocus-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the softKeyboardOnFocus property.

", "name": "getSoftKeyboardOnFocus" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getTop-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the top property.

", "name": "getTop" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getTouchEnabled-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the touchEnabled property.

", "name": "getTouchEnabled" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getTransform-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Titanium.UI.2DMatrix" }, { "type": "Titanium.UI.iOS.3DMatrix" } ], "examples": [], "summary": "

Gets the value of the transform property.

", "name": "getTransform" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getViews-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Array" } ], "examples": [], "summary": "

Gets the value of the views property.

", "name": "getViews" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getVisible-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the visible property.

", "name": "getVisible" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getWidth-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the width property.

", "name": "getWidth" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.getZIndex-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the zIndex property.

", "name": "getZIndex" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.hide-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Hides this view.

", "name": "hide" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.moveNext-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the current page to the next consecutive view in Titanium.UI.ScrollableView.views.

", "name": "moveNext" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.movePrevious-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the current page to the previous consecutive view in Titanium.UI.ScrollableView.views.

", "name": "movePrevious" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.remove-method.view-param", "optional": false, "summary": "

View to remove from this view's hierarchy.

", "type": "Titanium.UI.View", "name": "view" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.remove-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes a child view from this view's hierarchy.

", "name": "remove" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.removeView-method.view-param", "optional": false, "summary": "

A Titanium.UI.View object or integer index (iPhone, iPad only) of a view to remove.

", "type": [ "Number", "Object" ], "name": "view" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.removeView-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes an existing view from this Scrollable View. Does nothing if view proivded does \nnot exist.

", "name": "removeView" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.scrollToView-method.view-param", "optional": false, "summary": "

An integer index or a Titanium.UI.View object of the view to set as the current page.

", "type": [ "Number", "Object" ], "name": "view" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.scrollToView-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Scrolls to the specified view in Titanium.UI.ScrollableView.views.

", "name": "scrollToView" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setAnchorPoint-method.anchorPoint-param", "optional": false, "summary": "

New value for the property.

", "type": "Point", "name": "anchorPoint" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setAnchorPoint-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the anchorPoint property.

", "name": "setAnchorPoint" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundColor-method.backgroundColor-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundColor" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundColor property.

", "name": "setBackgroundColor" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundDisabledColor-method.backgroundDisabledColor-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundDisabledColor" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundDisabledColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundDisabledColor property.

", "name": "setBackgroundDisabledColor" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundDisabledImage-method.backgroundDisabledImage-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundDisabledImage" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundDisabledImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundDisabledImage property.

", "name": "setBackgroundDisabledImage" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundFocusedColor-method.backgroundFocusedColor-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundFocusedColor" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundFocusedColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundFocusedColor property.

", "name": "setBackgroundFocusedColor" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundFocusedImage-method.backgroundFocusedImage-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundFocusedImage" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundFocusedImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundFocusedImage property.

", "name": "setBackgroundFocusedImage" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundGradient-method.backgroundGradient-param", "optional": false, "summary": "

New value for the property.

", "type": "Gradient", "name": "backgroundGradient" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundGradient-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundGradient property.

", "name": "setBackgroundGradient" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundImage-method.backgroundImage-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundImage" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundImage property.

", "name": "setBackgroundImage" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundLeftCap-method.backgroundLeftCap-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "backgroundLeftCap" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundLeftCap-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundLeftCap property.

", "name": "setBackgroundLeftCap" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundRepeat-method.backgroundRepeat-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "backgroundRepeat" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundRepeat-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundRepeat property.

", "name": "setBackgroundRepeat" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundSelectedColor-method.backgroundSelectedColor-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundSelectedColor" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundSelectedColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundSelectedColor property.

", "name": "setBackgroundSelectedColor" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundSelectedImage-method.backgroundSelectedImage-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "backgroundSelectedImage" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundSelectedImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundSelectedImage property.

", "name": "setBackgroundSelectedImage" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundTopCap-method.backgroundTopCap-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "backgroundTopCap" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBackgroundTopCap-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the backgroundTopCap property.

", "name": "setBackgroundTopCap" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBorderColor-method.borderColor-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "borderColor" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBorderColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the borderColor property.

", "name": "setBorderColor" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBorderRadius-method.borderRadius-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "borderRadius" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBorderRadius-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the borderRadius property.

", "name": "setBorderRadius" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBorderWidth-method.borderWidth-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "borderWidth" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBorderWidth-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the borderWidth property.

", "name": "setBorderWidth" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBottom-method.bottom-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Number", "String" ], "name": "bottom" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setBottom-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the bottom property.

", "name": "setBottom" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setCacheSize-method.cacheSize-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "cacheSize" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setCacheSize-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the cacheSize property.

", "name": "setCacheSize" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setCenter-method.center-param", "optional": false, "summary": "

New value for the property.

", "type": "Point", "name": "center" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setCenter-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the center property.

", "name": "setCenter" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setCurrentPage-method.currentPage-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "currentPage" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setCurrentPage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the currentPage property.

", "name": "setCurrentPage" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setDisableBounce-method.disableBounce-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "disableBounce" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setDisableBounce-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the disableBounce property.

", "name": "setDisableBounce" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setFocusable-method.focusable-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "focusable" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setFocusable-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the focusable property.

", "name": "setFocusable" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setHeight-method.height-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Number", "String" ], "name": "height" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setHeight-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the height property.

", "name": "setHeight" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setKeepScreenOn-method.keepScreenOn-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "keepScreenOn" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setKeepScreenOn-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the keepScreenOn property.

", "name": "setKeepScreenOn" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setLayout-method.layout-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "layout" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setLayout-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the layout property.

", "name": "setLayout" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setLeft-method.left-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Number", "String" ], "name": "left" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setLeft-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the left property.

", "name": "setLeft" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setOpacity-method.opacity-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "opacity" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setOpacity-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the opacity property.

", "name": "setOpacity" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setPagingControlColor-method.pagingControlColor-param", "optional": false, "summary": "

New value for the property.

", "type": "String", "name": "pagingControlColor" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setPagingControlColor-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the pagingControlColor property.

", "name": "setPagingControlColor" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setPagingControlHeight-method.pagingControlHeight-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "pagingControlHeight" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setPagingControlHeight-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the pagingControlHeight property.

", "name": "setPagingControlHeight" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setRight-method.right-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Number", "String" ], "name": "right" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setRight-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the right property.

", "name": "setRight" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setShowPagingControl-method.showPagingControl-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "showPagingControl" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setShowPagingControl-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the showPagingControl property.

", "name": "setShowPagingControl" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setSoftKeyboardOnFocus-method.softKeyboardOnFocus-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "softKeyboardOnFocus" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setSoftKeyboardOnFocus-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the softKeyboardOnFocus property.

", "name": "setSoftKeyboardOnFocus" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setTop-method.top-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Number", "String" ], "name": "top" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setTop-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the top property.

", "name": "setTop" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setTouchEnabled-method.touchEnabled-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "touchEnabled" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setTouchEnabled-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the touchEnabled property.

", "name": "setTouchEnabled" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setTransform-method.transform-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Titanium.UI.2DMatrix", "Titanium.UI.iOS.3DMatrix" ], "name": "transform" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setTransform-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the transform property.

", "name": "setTransform" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setViews-method.views-param", "optional": false, "summary": "

New value for the property.

", "type": "Array", "name": "views" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setViews-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the views property.

", "name": "setViews" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setVisible-method.visible-param", "optional": false, "summary": "

New value for the property.

", "type": "Boolean", "name": "visible" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setVisible-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the visible property.

", "name": "setVisible" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setWidth-method.width-param", "optional": false, "summary": "

New value for the property.

", "type": [ "Number", "String" ], "name": "width" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setWidth-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the width property.

", "name": "setWidth" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.setZIndex-method.zIndex-param", "optional": false, "summary": "

New value for the property.

", "type": "Number", "name": "zIndex" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.setZIndex-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Sets the value of the zIndex property.

", "name": "setZIndex" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.ScrollableView.show-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Makes this view visible.

", "name": "show" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.toImage-method.f-param", "type": "Callback", "summary": "

Function to be invoked upon completion. If non-null, this method will be \nperformed asynchronously. If null, it will be performed immediately.

", "optional": true, "name": "f" } ], "deprecated": null, "filename": "Titanium.UI.ScrollableView.toImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "Titanium.Blob" }, "examples": [], "summary": "

Returns an image of the rendered view, as a Blob.

", "name": "toImage" } ], "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [ { "code": "

Create three views and place each into a scrollable view.

\n
var win = Ti.UI.createWindow();\n\nvar view1 = Ti.UI.createView({ backgroundColor:'#123' });\nvar view2 = Ti.UI.createView({ backgroundColor:'#246' });\nvar view3 = Ti.UI.createView({ backgroundColor:'#48b' });\n\nvar scrollableView = Ti.UI.createScrollableView({\n  views:[view1,view2,view3],\n  showPagingControl:true\n});\n\nwin.add(scrollableView);\nwin.open();\n
", "description": "Simple Scrollable View with 3 Views" }, { "code": "

Create two scroll views, each containing an image view, and place them in a scrollable view.

\n
var img1 = Ti.UI.createImageView({\n    image:'http://upload.wikimedia.org/wikipedia/commons/thumb/e/ec/' +\n    'Mona_Lisa%2C_by_Leonardo_da_Vinci%2C_from_C2RMF_retouched.jpg/' +\n    '402px-Mona_Lisa%2C_by_Leonardo_da_Vinci%2C_from_C2RMF_retouched.jpg'\n});\nvar img1Wrapper = Ti.UI.createScrollView({\n    maxZoomScale:4.0,\n});\nimg1Wrapper.add(img1);\n\nvar img2 = Ti.UI.createImageView({\n    image:'http://www.nasa.gov/images/content/' + \n    '616903main_rover_comparison1600_1600-1200.jpg'\n});\nvar img2Wrapper = Ti.UI.createScrollView({\n    maxZoomScale:4.0,\n});\nimg2Wrapper.add(img2);\nvar photosView = Ti.UI.createScrollableView({\n    showPagingControl:true,\n    views:[img1Wrapper,img2Wrapper]\n});\nwin.add(photosView);\n
", "description": "Simple Scrollable View with 2 Zoomable Images" } ], "summary": "

A view that encapsulates a horizontally-scrolling set of sub-views, navigable using its built-in \nhorizontal swipe gestures.

", "type": "object", "events": [ { "description": "

There is a subtle difference between singletap and click events.

\n

A singletap event is generated when the user taps the screen briefly without moving their \nfinger. This gesture will also generate a click event.

\n

However, a click event can also be generated when the user touches, moves their finger, and \nthen removes it from the screen.

\n

On Android, a click event can also be generated by a trackball click.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.click-event", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

Fired when the device detects a click against this view.

", "properties": [ { "deprecated": { "since": "1.8.0" }, "description": null, "filename": "Titanium.UI.ScrollableView.click.globalPoint-callback-property", "name": "globalPoint", "summary": "

Dictionary with properties x and y describing the location of the event in screen \ncoordinates.

" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.click.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.click.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.click.x-callback-property", "summary": "

X coordinate of the event from the source view.

", "type": "Number", "name": "x" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.click.y-callback-property", "summary": "

Y coordinate of the event from the source view.

", "type": "Number", "name": "y" } ], "name": "click" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.doubletap-event", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

Fired when the device detects a double tap against this view.

", "properties": [ { "deprecated": { "since": "1.8.0" }, "description": null, "filename": "Titanium.UI.ScrollableView.doubletap.globalPoint-callback-property", "name": "globalPoint", "summary": "

Dictionary with properties x and y describing the location of the event in screen \ncoordinates.

" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.doubletap.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.doubletap.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.doubletap.x-callback-property", "summary": "

X coordinate of the event from the source view.

", "type": "Number", "name": "x" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.doubletap.y-callback-property", "summary": "

Y coordinate of the event from the source view.

", "type": "Number", "name": "y" } ], "name": "doubletap" }, { "description": "

Generated by touching and holding on a touchscreen, this event occurs before the \nfinger is lifted again. Note that longpress cannot be generated with a trackball.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.longpress-event", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

Fired when the device detects a long press against this view.

", "properties": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.longpress.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.longpress.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.longpress.x-callback-property", "summary": "

X coordinate of the event from the source view.

", "type": "Number", "name": "x" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.longpress.y-callback-property", "summary": "

Y coordinate of the event from the source view.

", "type": "Number", "name": "y" } ], "name": "longpress" }, { "description": "

Generated by a touch and expand or contract with two fingers, this event occurs continuously \nuntil a finger is lifted again.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.pinch-event", "platforms": [ { "pretty_name": "iPhone", "since": "1.8.0", "name": "iphone" }, { "pretty_name": "iPad", "since": "1.8.0", "name": "ipad" } ], "summary": "

Fired when the device detects a pinch gesture against this view.

", "properties": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.pinch.scale-callback-property", "summary": "

The scale factor relative to the points of the two touches in screen coordinates.

", "type": "Number", "name": "scale" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.pinch.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.pinch.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.pinch.velocity-callback-property", "summary": "

The velocity of the pinch in scale factor per second.

", "type": "Number", "name": "velocity" } ], "name": "pinch" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.scroll-event", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

Fired when the current view is changed.

", "properties": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.scroll.currentPage-callback-property", "summary": "

Index of the current view of Titanium.UI.ScrollableView.views.

", "type": "Number", "name": "currentPage" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.scroll.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.scroll.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.scroll.view-callback-property", "summary": "

The current view.

", "type": "Object", "name": "view" } ], "name": "scroll" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.singletap-event", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

Fired when the device detects a single tap against this view.

", "properties": [ { "deprecated": { "since": "1.8.0" }, "description": null, "filename": "Titanium.UI.ScrollableView.singletap.globalPoint-callback-property", "name": "globalPoint", "summary": "

Dictionary with properties x and y describing the location of the event in screen \ncoordinates.

" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.singletap.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.singletap.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.singletap.x-callback-property", "summary": "

X coordinate of the event from the source view.

", "type": "Number", "name": "x" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.singletap.y-callback-property", "summary": "

Y coordinate of the event from the source view.

", "type": "Number", "name": "y" } ], "name": "singletap" }, { "description": "

Generated in various circumstances, including an incoming call to allow the UI to clean \nup state.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchcancel-event", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

Fired when a touch gesture is interrupted by the device.

", "properties": [ { "deprecated": { "since": "1.8.0" }, "description": null, "filename": "Titanium.UI.ScrollableView.touchcancel.globalPoint-callback-property", "name": "globalPoint", "summary": "

Dictionary with properties x and y describing the location of the event in screen \ncoordinates.

" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchcancel.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchcancel.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchcancel.x-callback-property", "summary": "

X coordinate of the event from the source view.

", "type": "Number", "name": "x" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchcancel.y-callback-property", "summary": "

Y coordinate of the event from the source view.

", "type": "Number", "name": "y" } ], "name": "touchcancel" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchend-event", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

Fired when a touch gesture is complete.

", "properties": [ { "deprecated": { "since": "1.8.0" }, "description": null, "filename": "Titanium.UI.ScrollableView.touchend.globalPoint-callback-property", "name": "globalPoint", "summary": "

Dictionary with properties x and y describing the location of the event in screen \ncoordinates.

" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchend.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchend.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchend.x-callback-property", "summary": "

X coordinate of the event from the source view.

", "type": "Number", "name": "x" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchend.y-callback-property", "summary": "

Y coordinate of the event from the source view.

", "type": "Number", "name": "y" } ], "name": "touchend" }, { "description": "

Event coordinates are relative to the view for which the initial touch occurred.

", "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchmove-event", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

Fired when a touch gesture is moved.

", "properties": [ { "deprecated": { "since": "1.8.0" }, "description": null, "filename": "Titanium.UI.ScrollableView.touchmove.globalPoint-callback-property", "name": "globalPoint", "summary": "

Dictionary with properties x and y describing the location of the event in screen \ncoordinates.

" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchmove.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchmove.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchmove.x-callback-property", "summary": "

X coordinate of the event from the source view.

", "type": "Number", "name": "x" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchmove.y-callback-property", "summary": "

Y coordinate of the event from the source view.

", "type": "Number", "name": "y" } ], "name": "touchmove" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchstart-event", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "summary": "

Fired as soon as the device detects a touch gesture against this view.

", "properties": [ { "deprecated": { "since": "1.8.0" }, "description": null, "filename": "Titanium.UI.ScrollableView.touchstart.globalPoint-callback-property", "name": "globalPoint", "summary": "

Dictionary with properties x and y describing the location of the event in screen \ncoordinates.

" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchstart.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchstart.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchstart.x-callback-property", "summary": "

X coordinate of the event from the source view.

", "type": "Number", "name": "x" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.ScrollableView.touchstart.y-callback-property", "summary": "

Y coordinate of the event from the source view.

", "type": "Number", "name": "y" } ], "name": "touchstart" } ], "name": "Titanium.UI.ScrollableView" }, "Titanium.Android.MenuItem": { "properties": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.enabled-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

set the enabled state of the item

", "type": "Boolean", "name": "enabled" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.MenuItem.groupId-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

groupId for this item

", "type": "Number", "name": "groupId" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.MenuItem.itemId-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

itemId for this item

", "type": "Number", "name": "itemId" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.Android.MenuItem.order-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

integer used for controlling sort order

", "type": "Number", "name": "order" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.title-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

item title

", "type": "String", "name": "title" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.titleCondensed-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

condensed item title

", "type": "String", "name": "titleCondensed" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.visible-property", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

set the visible state of the item

", "type": "Boolean", "name": "visible" } ], "description": null, "subtype": "proxy", "deprecated": null, "filename": "Titanium.Android.MenuItem-object", "methods": [ { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Android.MenuItem.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.Android.MenuItem.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.MenuItem.getEnabled-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the enabled property.

", "name": "getEnabled" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.MenuItem.getGroupId-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "Number" }, "examples": [], "summary": "

retrieve the groupId for this item

", "name": "getGroupId" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.MenuItem.getItemId-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "Number" }, "examples": [], "summary": "

retrieve the itemId for this item

", "name": "getItemId" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.MenuItem.getOrder-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "Number" }, "examples": [], "summary": "

retrieve the sort order

", "name": "getOrder" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.MenuItem.getTitle-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "String" }, "examples": [], "summary": "

retrieve the title of the item

", "name": "getTitle" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.MenuItem.getTitleCondensed-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "String" }, "examples": [], "summary": "

retrieve the condensed title of the item

", "name": "getTitleCondensed" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.MenuItem.getVisible-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the visible property.

", "name": "getVisible" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.MenuItem.isEnabled-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "Boolean" }, "examples": [], "summary": "

retrieve the enabled state of the menu

", "name": "isEnabled" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.Android.MenuItem.isVisible-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "Boolean" }, "examples": [], "summary": "

retrieve the visible state of the menu

", "name": "isVisible" }, { "description": "

Multiple listeners can be registered for the same event, so the \ncallback parameter is used to determine which listener to remove.

\n

When adding a listener, you must save a reference to the callback function\nin order to remove the listener later:

\n
var listener = function() { Ti.API.info(\"Event listener called.); }\nwindow.addEventListener('click', listener);\n
\n

To remove the listener, pass in a reference to the callback function:

\n
window.removeEventListener('click', listener);\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.removeEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.removeEventListener-method.callback-param", "optional": false, "summary": "

Callback function to remove. Must be the same function passed to addEventListener.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.Android.MenuItem.removeEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Removes the specified callback as an event listener for the named event.

", "name": "removeEventListener" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.setEnabled-method.enabled-param", "optional": false, "summary": "

true to enable item, false to disable

", "type": "Boolean", "name": "enabled" } ], "deprecated": null, "filename": "Titanium.Android.MenuItem.setEnabled-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

set the enabled state of the item

", "name": "setEnabled" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.setIcon-method.icon-param", "optional": false, "summary": "

icon to use with the item

", "type": "Object", "name": "icon" } ], "deprecated": null, "filename": "Titanium.Android.MenuItem.setIcon-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

set the icon for the item

", "name": "setIcon" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.setTitle-method.title-param", "optional": false, "summary": "

new title

", "type": "String", "name": "title" } ], "deprecated": null, "filename": "Titanium.Android.MenuItem.setTitle-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

set the title for the item

", "name": "setTitle" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.setTitleCondensed-method.condensedTitle-param", "optional": false, "summary": "

new condensed title

", "type": "String", "name": "condensedTitle" } ], "deprecated": null, "filename": "Titanium.Android.MenuItem.setTitleCondensed-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

set the condensed title for the item

", "name": "setTitleCondensed" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.setVisible-method.visible-param", "optional": false, "summary": "

true to show the item, false to hide

", "type": "Boolean", "name": "visible" } ], "deprecated": null, "filename": "Titanium.Android.MenuItem.setVisible-method", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "returns": { "type": "void" }, "examples": [], "summary": "

set the visible state of the item

", "name": "setVisible" } ], "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "examples": [], "summary": "

The Titanium binding of an Android MenuItem

", "type": "object", "events": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.click-event", "platforms": [ { "pretty_name": "Android", "since": "1.5", "name": "android" } ], "summary": "

fired when the user presses the button

", "properties": [ { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.click.source-callback-property", "summary": "

Source object that fired the event.

", "type": "Object", "name": "source" }, { "description": null, "deprecated": null, "filename": "Titanium.Android.MenuItem.click.type-callback-property", "summary": "

Name of the event fired.

", "type": "String", "name": "type" } ], "name": "click" } ], "name": "Titanium.Android.MenuItem" }, "Titanium.UI.TableView": { "properties": [ { "description": null, "default": true, "deprecated": null, "filename": "Titanium.UI.TableView.allowsSelection-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

True if the rows can be selected.

", "type": "Boolean", "name": "allowsSelection" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.allowsSelectionDuringEditing-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

True if the rows can be selected while editing the table.

", "type": "Boolean", "name": "allowsSelectionDuringEditing" }, { "description": "

Anchor point is specified as a fraction of the view's size. So \n(0.5,0.5) represents the view's center and (1, 1) is the view's bottom-right \ncorner.

", "deprecated": null, "filename": "Titanium.UI.TableView.anchorPoint-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Anchor point where animation should occur, relative to the view's boundaries.

", "type": "Point", "name": "anchorPoint" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.TableView.animatedCenterPoint-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Current position of the view during an animation.

", "type": "Point", "name": "animatedCenterPoint" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.backgroundColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Background color of the view.

", "type": "String", "name": "backgroundColor" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.backgroundDisabledColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Disabled background color of the view.

", "type": "String", "name": "backgroundDisabledColor" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.backgroundDisabledImage-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Disabled background image for the view, specified as a local file path or URL.

", "type": "String", "name": "backgroundDisabledImage" }, { "description": "

For normal views, the focused color is only used if focusable is true.

", "deprecated": null, "filename": "Titanium.UI.TableView.backgroundFocusedColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Focused background color of the view.

", "type": "String", "name": "backgroundFocusedColor" }, { "description": "

For normal views, the focused background is only used if focusable is true.

", "deprecated": null, "filename": "Titanium.UI.TableView.backgroundFocusedImage-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Focused background image for the view, specified as a local file path or URL.

", "type": "String", "name": "backgroundFocusedImage" }, { "description": "

A gradient can be defined as either linear or radial. A linear gradient\nvaries continuously along a line between the startPoint and endPoint.\nA radial gradient is interpolated between two circles, defined by startPoint\nand startRadius and endPoint and endRadius respectively.

\n

The start and end points and radius values can be defined in device units,\nin the view's coordinates, or as percentages of the view's size. Thus, if\na view is 60 x 60, the center point of the view can be specified as:

\n
{ x: 30, y: 30 }\n
\n

Or:\n { x: '50%', y: '50%' }

\n

When specifying multiple colors, you can specify an offset value for\neach color, defining how far into the gradient it takes effect. For example,\nthe following color array specifies a gradient that goes from red to blue back to red:

\n
colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ]\n
", "deprecated": null, "filename": "Titanium.UI.TableView.backgroundGradient-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [ { "code": "

The following code excerpt creates two views, one with a linear gradient and one with\na radial gradient.

\n
var win1 = Titanium.UI.createWindow({\n    title:'Tab 1',\n    backgroundColor:'#fff',\n    layout: 'vertical'\n});\n\nvar radialGradient = Ti.UI.createView({\n    top: 10,\n    width: 100,\n    height: 100,\n    backgroundGradient: {\n        type: 'radial',\n        startPoint: { x: 50, y: 50 },\n        endPoint: { x: 50, y: 50 },\n        colors: [ 'red', 'blue'],\n        startRadius: '90%',\n        endRadius: 0,\n        backfillStart: true\n    }\n});\nvar linearGradient = Ti.UI.createView({\n    top: 10,\n    width: 100,\n    height: 100,\n    backgroundGradient: {\n        type: 'linear',\n        startPoint: { x: '0%', y: '50%' },\n        endPoint: { x: '100%', y: '50%' },\n        colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ],\n    }\n});\nwin1.add(radialGradient);\nwin1.add(linearGradient);\nwin1.open();\n
", "description": "Linear and Radial Gradients" } ], "summary": "

A background gradient for the view.

", "type": "Gradient", "name": "backgroundGradient" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.backgroundImage-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Background image for the view, specified as a local file path or URL.

", "type": "String", "name": "backgroundImage" }, { "description": "

End caps specify the portion of an image that should not be resized when an \nimage is stretched. This technique is used to implement buttons and other \nresizable image-based interface elements. When a button with end caps is resized, \nthe resizing occurs only in the middle of the button, in the region between the end \ncaps. The end caps themselves keep their original size and appearance. This property \nspecifies the size of the left end cap. The middle (stretchable) portion is assumed to \nbe 1 pixel wide. The right end cap is therefore computed by adding the size of the left \nend cap and the middle portion together and then subtracting that value from the width \nof the image

", "deprecated": null, "filename": "Titanium.UI.TableView.backgroundLeftCap-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Size of the left end cap.

", "type": "Number", "name": "backgroundLeftCap" }, { "description": "

Setting this to true makes the set backgroundImage repeat across\nthe view as a series of tiles. The tiling is begins in the upper-left\ncorner, where the upper-left corner of the background image is rendered.\nThe image is then tiled to fill the available space of the view.

\n

Note that setting this to true may incur performance penalties for\nlarge views or background images, as the tiling must be redone\nwhenever a view is resized.

\n

The following views do not currently support tiled backgrounds:\n Titanium.UI.Button\n Titanium.UI.TextField\n* Titanium.UI.Label

", "deprecated": null, "filename": "Titanium.UI.TableView.backgroundRepeat-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Toggle for whether or not to tile a background across a view.

", "type": "Boolean", "name": "backgroundRepeat" }, { "description": "

focusable must be true for normal views.

", "deprecated": null, "filename": "Titanium.UI.TableView.backgroundSelectedColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Selected background color of the view.

", "type": "String", "name": "backgroundSelectedColor" }, { "description": "

For normal views, the selected background is only used if focusable is true.

", "deprecated": null, "filename": "Titanium.UI.TableView.backgroundSelectedImage-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Selected background image url for the view, specified as a local file path or URL.

", "type": "String", "name": "backgroundSelectedImage" }, { "description": "

End caps specify the portion of an image that should not be resized when an image \nis stretched. This technique is used to implement buttons and other resizable \nimage-based interface elements. When a button with end caps is resized, the resizing \noccurs only in the middle of the button, in the region between the end caps. The end \ncaps themselves keep their original size and appearance. This property specifies the \nsize of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. \nThe bottom end cap is therefore computed by adding the size of the top end cap and the\nmiddle portion together and then subtracting that value from the height of the image.

", "deprecated": null, "filename": "Titanium.UI.TableView.backgroundTopCap-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Size of the top end cap.

", "type": "Number", "name": "backgroundTopCap" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.borderColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Border color of the view.

", "type": "String", "name": "borderColor" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.borderRadius-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Border radius of the view.

", "type": "Number", "name": "borderRadius" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.borderWidth-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Border width of the view.

", "type": "Number", "name": "borderWidth" }, { "description": "

This position is relative to the view's parent. Exact interpretation depends on the \nparent view's layout property. Can be either a float value or \na dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.TableView.bottom-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

View's bottom position, in platform-specific units.

", "type": [ "Number", "String" ], "name": "bottom" }, { "description": "

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.TableView.center-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

View's center position, in the parent view's coordinates.

", "type": "Point", "name": "center" }, { "description": null, "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.TableView.children-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Array of this view's child views.

", "type": "Array", "name": "children" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.data-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Array of objects to be used for the rows of the table view.

", "type": [ "Array", "Array" ], "name": "data" }, { "description": null, "default": false, "deprecated": null, "filename": "Titanium.UI.TableView.editable-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Allow the user to edit the table view (this must be true for swipe-to-delete).

", "type": "Boolean", "name": "editable" }, { "description": null, "default": false, "deprecated": null, "filename": "Titanium.UI.TableView.editing-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Boolean to control the editing state of the table view.

", "type": "Boolean", "name": "editing" }, { "description": "

This property maps to your data object or a property on the row object. For example,\nif you set filterAttribute to 'title', the table view shows only those rows that\ncontain the current search text in the title property.

\n

Note that the filter is not anchored to the beginning of the string. So typing \"ha\"\nin the text box will include rows titled 'Harold' and 'Harvard', but also 'Sharon'\nand 'Jonathan'.

", "deprecated": null, "filename": "Titanium.UI.TableView.filterAttribute-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Filter attribute to be used when searching.

", "type": "String", "name": "filterAttribute" }, { "description": null, "default": true, "deprecated": null, "filename": "Titanium.UI.TableView.filterCaseInsensitive-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Boolean to indicate if the search should be case sensitive or case insensitive.

", "type": "Boolean", "name": "filterCaseInsensitive" }, { "description": null, "default": false, "deprecated": null, "filename": "Titanium.UI.TableView.focusable-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Whether view should be focusable while navigating with the trackball.

", "type": "Boolean", "name": "focusable" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.footerTitle-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Table view footer title.

", "type": "String", "name": "footerTitle" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.footerView-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Table view footer as a view that will be rendered instead of a label.

", "type": "Titanium.UI.View", "name": "footerView" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.headerTitle-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Table view header title.

", "type": "String", "name": "headerTitle" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.headerView-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Table view header as a view that will be rendered instead of a label.

", "type": "Titanium.UI.View", "name": "headerView" }, { "description": "

Can be either a float value or a dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying the view's height dimension. To determine the view's \nsize once rendered, see the size property.

", "deprecated": null, "filename": "Titanium.UI.TableView.height-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

View height, in platform-specific units.

", "type": [ "Number", "String" ], "name": "height" }, { "description": "

If an index array is specified, an index bar is displayed on the right-hand side of the \ntable view. Clicking on a title in the index bar scrolls the table view to the row \nindex associated with that title.

", "deprecated": null, "filename": "Titanium.UI.TableView.index-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Array of objects (with title and index properties) to control the table view index.

", "type": "Array", "name": "index" }, { "description": "

When true the screen will not power down. Note: enabling this feature will use more \npower, thereby adversely affecting run time when on battery.

", "deprecated": null, "filename": "Titanium.UI.TableView.keepScreenOn-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Whether to keep the device screen on.

", "type": "Boolean", "name": "keepScreenOn" }, { "description": "

There are three layout options:

\n
    \n
  • \n

    absolute. Default layout. A child view's top, bottom, left, and right \n properties are interpreted as absolute values in the parent's coordinate space.

    \n

    If the child includes a top value and not a bottom value, the child is \npositioned top units from the top of the parent's bounding box, and its height\nis set based on its height property.

    \n

    If the child includes a bottom value and not a top value, the child is \npositioned bottom units from the bottom of the parent's bounding box. Its height\nis set based on its height property.

    \n

    If the child includes both top and bottom values, the behavior is \nplatform-specific.

    \n

    Similar calculations are used for left and right.

    \n

    You can also position a child by setting its center property to a Point.

    \n

    If no position is set explicitly, children are centered. For example, if a \nchild specifies a top of 20 and does not specify any other position properties,\nthe child is positioned 20 units from the parent's top, and centered horizontally.

    \n
    • \n
  • \n

    vertical. Children are laid out vertically from top to bottom. The first child \n is laid out top units from its parent's bounding box. Each subsequent child is \n laid out below the previous child. The space between children is equal to the \n upper child's bottom value plus the lower child's top value.

    \n

    Each child is positioned horizontally as for the absolute layout mode.

    \n
    • \n
  • \n

    horizontal. Like vertical layout, except children are laid out horizontally\n from left to right, using the left and right values to determine spacing.

    \n

    Each child is positioned vertically as in the absolute layout mode.

    \n
    • \n
", "default": "absolute layout", "deprecated": null, "filename": "Titanium.UI.TableView.layout-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Specifies how the view positions its children. \nOne of: 'absolute', 'vertical', or 'horizontal'.

", "type": "String", "name": "layout" }, { "description": "

This position is relative to the view's parent. Exact interpretation depends on the \nparent view's layout property. Can be either a float value or \na dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.TableView.left-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

View's left position, in platform-specific units.

", "type": [ "Number", "String" ], "name": "left" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.maxRowHeight-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Maximum row height for table view rows.

", "type": "Number", "name": "maxRowHeight" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.minRowHeight-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Minimum row height for table view rows.

", "type": "Number", "name": "minRowHeight" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.moving-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Boolean to control the moveable state of the table view.

", "type": "Boolean", "name": "moving" }, { "description": null, "default": "1.0 (opaque)", "deprecated": null, "filename": "Titanium.UI.TableView.opacity-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Opacity of this view, from 0.0 (transparent) to 1.0 (opaque).

", "type": "Number", "name": "opacity" }, { "description": "

This position is relative to the view's parent. Exact interpretation depends on the \nparent view's layout property. Can be either a float value or \na dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.TableView.right-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

View's right position, in platform-specific units.

", "type": [ "Number", "String" ], "name": "right" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.rowHeight-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Default row height for table view rows.

", "type": "Number", "name": "rowHeight" }, { "description": null, "default": true, "deprecated": null, "filename": "Titanium.UI.TableView.scrollable-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

If true, the tableview can be scrolled.

", "type": "Boolean", "name": "scrollable" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.search-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Search field to use for the table view.

", "type": "Titanium.UI.SearchBar", "name": "search" }, { "description": null, "default": "false (search field visible)", "deprecated": null, "filename": "Titanium.UI.TableView.searchHidden-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Boolean to control the visibility of the search field.

", "type": "Boolean", "name": "searchHidden" }, { "description": null, "default": "platform-specific default color", "deprecated": null, "filename": "Titanium.UI.TableView.separatorColor-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Separator color between rows, specified as a hex or named value.

", "type": "String", "name": "separatorColor" }, { "description": "

For iOS specify one of the TableViewSeparatorStyle constants.\nFor Mobile Web specify one of the TableViewSeparatorStyle constants.

", "deprecated": null, "filename": "Titanium.UI.TableView.separatorStyle-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Separator style constant.

", "type": "Number", "name": "separatorStyle" }, { "description": null, "default": true, "deprecated": null, "filename": "Titanium.UI.TableView.showVerticalScrollIndicator-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Whether table view displays vertical scroll indicator

", "type": "Boolean", "name": "showVerticalScrollIndicator" }, { "description": "

The correct values will only be available when rendering is fully complete.

", "permission": "read-only", "deprecated": null, "filename": "Titanium.UI.TableView.size-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Rendered size of the view as a dictionary of width and height properties.

", "type": "Object", "name": "size" }, { "description": "

One of Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS, \nTitanium.UI.Android.SOFT_KEYBOARD_HIDE_ON_FOCUS, or \nTitanium.UI.Android.SOFT_KEYBOARD_SHOW_ON_FOCUS.

", "deprecated": null, "filename": "Titanium.UI.TableView.softKeyboardOnFocus-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "examples": [], "summary": "

Determines keyboard behavior when this view is focused.

", "type": "Number", "name": "softKeyboardOnFocus" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.style-property", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "examples": [], "summary": "

Style of the table view, specified using one of the constants from Titanium.UI.iPhone.TableViewStyle.

", "type": "Number", "name": "style" }, { "description": "

This position is relative to the view's parent. Exact interpretation depends on the \nparent view's layout property. Can be either a float value or \na dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying where the view should be positioned, and does not\nrepresent the view's calculated position.

", "deprecated": null, "filename": "Titanium.UI.TableView.top-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

The view's top position.

", "type": [ "Number", "String" ], "name": "top" }, { "description": "

If false, will forward the events to peers.

", "default": true, "deprecated": null, "filename": "Titanium.UI.TableView.touchEnabled-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Whether view should receive touch events.

", "type": "Boolean", "name": "touchEnabled" }, { "description": "

Android and Mobile Web only support 2DMatrix transforms.

", "deprecated": null, "filename": "Titanium.UI.TableView.transform-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Transformation matrix to apply to the view.

", "type": [ "Titanium.UI.2DMatrix", "Titanium.UI.iOS.3DMatrix" ], "name": "transform" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.visible-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Boolean value indicating whether the view is visible.

", "type": "Boolean", "name": "visible" }, { "description": "

Can be either a float value or a dimension string (for example, '50%' or 'auto').

\n

This is an input property for specifying the view's width dimension. To \ndetermine the view's size once rendered, see the \nsize property.

", "deprecated": null, "filename": "Titanium.UI.TableView.width-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

View's width, in platform-specific units.

", "type": [ "Number", "String" ], "name": "width" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.zIndex-property", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "examples": [], "summary": "

Z index position relative to other sibling views.

", "type": "Number", "name": "zIndex" } ], "description": "

A table view can contain a set of TableViewRows, each displaying \nan item of data. The default TableViewRow has properties for adding text, as well as \noptional images on the left and right sides, and various system-provided indicators, \nsuch as check marks. Table view rows can also be fully customized by adding child views, \nsuch as labels, buttons, or image views.

\n

When adding rows to a table view, each row can be passed as a \nTableViewRow object, or as dictionary specifying \nthe properties for a table row, in which case the TableView will create \nTableViewRow objects as needed.

\n

Use the Titanium.UI.createTableView method to create a table view.

", "subtype": "proxy", "deprecated": null, "filename": "Titanium.UI.TableView-object", "methods": [ { "description": "

There are certain top-level containers that are not intended to be added \nas the children of other views. These top-level containers include \nWindow, SplitWindow,\nand TabGroup. Other types of views must be added \nto a top-level container in order to be displayed on screen.

\n

The special containers NavigationGroup, \nSplitWindow, Tab, and \nTabGroup\nmanage windows. These managed windows may be referred to as children of the \ncontainer, but they are not added using the add method.

\n

Note that although a NavigationGroup\nmanages windows, it is not itself top-level container. It must be added to a \nWindow in order to be displayed.

\n

Tab is another kind of special container: it is not itself a top-level container, \nbut can only be used within a TabGroup. You cannot add a Tab to an arbitrary\ncontainer.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.add-method.view-param", "optional": false, "summary": "

View to add to this view's hierarchy

", "type": "Titanium.UI.View", "name": "view" } ], "deprecated": null, "filename": "Titanium.UI.TableView.add-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds a child to this view's hierarchy.

", "name": "add" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.addEventListener-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.addEventListener-method.callback-param", "optional": false, "summary": "

Callback function to invoke when the event is fired.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.UI.TableView.addEventListener-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Adds the specified callback as an event listener for the named event.

", "name": "addEventListener" }, { "description": "

The Animation object or dictionary passed to this\nmethod defines the end state for the animation, the duration of the animation,\nand other properties.

\n

Note that if you use animate to move a view, the view's actual position\nis changed, but its layout properties, such as top, left, center and \nso on are not changed--these reflect the original values set by the user, not\nthe actual position of the view.

\n

In this release, the view's actual position is not available to the application. \nThis feature will be added to a future release.

\n

If you need one or more of the layout properties to be updated after animation,\nyou can update them in the callback after animation is complete. For example:

\n
var newTop = view1.top - 100;\nview1.animate({ top: newTop, duration: 500 }, function () {\n    view.top = newTop; \n});\n
", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.animate-method.obj-param", "optional": false, "summary": "

Either a dictionary of animation properties or an \nAnimation object.

", "type": [ "Titanium.UI.Animation", "Dictionary" ], "name": "obj" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.animate-method.callback-param", "optional": false, "summary": "

Function to be invoked upon completion of the animation.

", "type": "Callback", "name": "callback" } ], "deprecated": null, "filename": "Titanium.UI.TableView.animate-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Animates this view.

", "name": "animate" }, { "description": "

Appends a single row or an array of rows to the end of the table.\nEach row can be passed as a TableViewRow object,\nor as dictionary specifying the properties for a table row, in which case\nthe TableView will create TableViewRow objects as needed.

\n

On iOS, the row(s) can be inserted with animation by specifying a properties\nparameter.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.appendRow-method.row-param", "optional": false, "summary": "

If appending a single row, this should contain only the row being appended. If appending multiple rows, this should be an array of the rows being appended.

", "type": [ "Titanium.UI.TableViewRow", "Dictionary", "Array", "Array>" ], "name": "row" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.appendRow-method.properties-param", "type": "TableViewAnimationProperties", "summary": "

Animation properties, only used on iOS.

", "optional": true, "name": "properties" } ], "deprecated": null, "filename": "Titanium.UI.TableView.appendRow-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Appends one or more rows to the table.

", "name": "appendRow" }, { "description": "

If both views are connected in the native view hierarchies, returns the \npoint, converted to destinationView's coordinate system.

\n

Returns null if either view is not in the view hierarchy.\nKeep in mind that views may be removed from the view hierarchy if their window \nis blurred or if the view is offscreen (such as in some situations with \nTitanium.UI.ScrollableView).

\n

If this view is a Titanium.UI.ScrollView, the view's x and y offsets are \nsubtracted from the return value.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.convertPointToView-method.point-param", "optional": false, "summary": "

A point in this view's coordinate system.
\nIf this argument is missing an x or y property, or the properties can not \nbe converted into numbers, an exception will be raised.

", "type": "Point", "name": "point" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.convertPointToView-method.destinationView-param", "optional": false, "summary": "

View that specifies the destination coordinate system to convert to.\nIf this argument is not a view, an exception will be raised.

", "type": "Titanium.UI.View", "name": "destinationView" } ], "deprecated": null, "filename": "Titanium.UI.TableView.convertPointToView-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "Point" }, "examples": [], "summary": "

Translates a point from this view's coordinate system to another \nview's coordinate system.

", "name": "convertPointToView" }, { "description": "

On iOS, the row can be deleted with animation by specifying a properties\nparameter.

", "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.deleteRow-method.row-param", "optional": false, "summary": "

Index of the row to delete.

", "type": "Number", "name": "row" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.deleteRow-method.properties-param", "type": "TableViewAnimationProperties", "summary": "

Animation properties. Only used on iOS.

", "optional": true, "name": "properties" } ], "deprecated": null, "filename": "Titanium.UI.TableView.deleteRow-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Deletes an existing row.

", "name": "deleteRow" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.deselectRow-method.row-param", "optional": false, "summary": "

Row index to deselect.

", "type": "Number", "name": "row" } ], "deprecated": null, "filename": "Titanium.UI.TableView.deselectRow-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Programmatically deselects a row.

", "name": "deselectRow" }, { "description": null, "parameters": [ { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.fireEvent-method.name-param", "optional": false, "summary": "

Name of the event.

", "type": "String", "name": "name" }, { "description": null, "deprecated": null, "filename": "Titanium.UI.TableView.fireEvent-method.event-param", "optional": false, "summary": "

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

", "type": "Dictionary", "name": "event" } ], "deprecated": null, "filename": "Titanium.UI.TableView.fireEvent-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": { "type": "void" }, "examples": [], "summary": "

Fires a synthesized event to any registered listeners.

", "name": "fireEvent" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getAllowsSelection-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the allowsSelection property.

", "name": "getAllowsSelection" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getAllowsSelectionDuringEditing-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the allowsSelectionDuringEditing property.

", "name": "getAllowsSelectionDuringEditing" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getAnchorPoint-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Point" } ], "examples": [], "summary": "

Gets the value of the anchorPoint property.

", "name": "getAnchorPoint" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getAnimatedCenterPoint-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Point" } ], "examples": [], "summary": "

Gets the value of the animatedCenterPoint property.

", "name": "getAnimatedCenterPoint" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBackgroundColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundColor property.

", "name": "getBackgroundColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBackgroundDisabledColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundDisabledColor property.

", "name": "getBackgroundDisabledColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBackgroundDisabledImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundDisabledImage property.

", "name": "getBackgroundDisabledImage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBackgroundFocusedColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundFocusedColor property.

", "name": "getBackgroundFocusedColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBackgroundFocusedImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundFocusedImage property.

", "name": "getBackgroundFocusedImage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBackgroundGradient-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "Gradient" } ], "examples": [], "summary": "

Gets the value of the backgroundGradient property.

", "name": "getBackgroundGradient" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBackgroundImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundImage property.

", "name": "getBackgroundImage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBackgroundLeftCap-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the backgroundLeftCap property.

", "name": "getBackgroundLeftCap" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBackgroundRepeat-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Boolean" } ], "examples": [], "summary": "

Gets the value of the backgroundRepeat property.

", "name": "getBackgroundRepeat" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBackgroundSelectedColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundSelectedColor property.

", "name": "getBackgroundSelectedColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBackgroundSelectedImage-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the backgroundSelectedImage property.

", "name": "getBackgroundSelectedImage" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBackgroundTopCap-method", "platforms": [ { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the backgroundTopCap property.

", "name": "getBackgroundTopCap" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBorderColor-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "String" } ], "examples": [], "summary": "

Gets the value of the borderColor property.

", "name": "getBorderColor" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBorderRadius-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the borderRadius property.

", "name": "getBorderRadius" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBorderWidth-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "Number" } ], "examples": [], "summary": "

Gets the value of the borderWidth property.

", "name": "getBorderWidth" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getBottom-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "Number" }, { "type": "String" } ], "examples": [], "summary": "

Gets the value of the bottom property.

", "name": "getBottom" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getCenter-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "Point" } ], "examples": [], "summary": "

Gets the value of the center property.

", "name": "getCenter" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getChildren-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad" }, { "pretty_name": "Mobile Web", "since": "1.8", "name": "mobileweb" } ], "returns": [ { "type": "Array" } ], "examples": [], "summary": "

Gets the value of the children property.

", "name": "getChildren" }, { "description": null, "parameters": [], "deprecated": null, "filename": "Titanium.UI.TableView.getData-method", "platforms": [ { "pretty_name": "Android", "since": "0.8", "name": "android" }, { "pretty_name": "iPhone", "since": "0.8", "name": "iphone" }, { "pretty_name": "iPad", "since": "0.8", "name": "ipad"