![\"modal\"](\"http://img.skitch.com/20100406-bqb3f8pb6e4ger7wkcdcw5mbar.png\")
The top level Titanium module.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.include-method", "name": "include", "parameters": [ { "description": "filename to include", "name": "name", "type": "string" } ], "returntype": "void", "value": "one or more filenames to include as if the Javascript code was written in place. This is similar to a C #include function.
" }, { "filename": "Titanium.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": "Titanium provides a number of built-in objects in the Javascript that are not part of the Titanium namespace. Specifically, the following are available.
\nTitanium has a built-in JSON parser with two main functions: parse and stringify. JSON.parse will safely evaluate a string encoded as Javascript into a Javascript object. JSON.stringify will encode a Javascript object into a string.
\nTitanium has built-in support for one-shot and repeating timers with two main functions: setTimeout and setInterval. setTimeout takes 2 arguments: function and timeout in milliseconds after which the function should be executed and returns a timer handle that can be used to cancel a pending timer with clearTimeout. setInterval takes 2 arguments: function and timeout in milliseconds for how often the function should be executed until cancelled and returns a timer handle that can be used to cancel a timer with clearInterval.
\nTitanium has a built-in convenience function alert which can be used as a shortcut to Titanium.UI.createAlertDialog for creating a message box. Note that unlike a web browser-based version of alert, the method is asynchronous.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.userAgent-property", "name": "userAgent", "type": "string", "value": "the user-agent string used by Titanium
" }, { "filename": "Titanium.version-property", "name": "version", "type": "string", "value": "the version of Titanium that is executing
" } ], "returns": null, "since": "0.1", "subtype": null, "type": "module" }, "Titanium.API": { "deprecated": null, "description": "The top level API module. The API module is mainly used for logging.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.API.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.API.debug-method", "name": "debug", "parameters": [ { "description": "the message to log", "name": "message", "type": "string" } ], "returntype": "void", "value": "function for logging debug messages
" }, { "filename": "Titanium.API.error-method", "name": "error", "parameters": [ { "description": "the message to log", "name": "message", "type": "string" } ], "returntype": "void", "value": "function for logging error messages
" }, { "filename": "Titanium.API.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.API.info-method", "name": "info", "parameters": [ { "description": "the message to log", "name": "message", "type": "string" } ], "returntype": "void", "value": "function for logging informational messages
" }, { "filename": "Titanium.API.log-method", "name": "log", "parameters": [ { "description": "the log level", "name": "level", "type": "string" }, { "description": "the message to log", "name": "message", "type": "string" } ], "returntype": "void", "value": "function for logging custom severity messages
" }, { "filename": "Titanium.API.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.API.warn-method", "name": "warn", "parameters": [ { "description": "the message to log", "name": "message", "type": "string" } ], "returntype": "void", "value": "function for logging warning messages
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [], "returns": "object", "since": "0.1", "subtype": null, "type": "module" }, "Titanium.Accelerometer": { "deprecated": null, "description": "The top level Accelerometer module. The Accelerometer modules contains methods and properties for using the device accelerometer.
", "events": [ { "filename": "Titanium.Accelerometer.update-event", "name": "update", "properties": { "source": "the source object that fired the event", "timestamp": "reference timestamp since the previous change. this is not a valid timestamp and should simply be used to determine the time between events and not an exact timestamp.
", "type": "the name of the event fired", "x": "the x axis of the device
", "y": "the y axis of the device
", "z": "the z axis of the device
" }, "value": "fired when the accelerometer changes
" } ], "examples": [ { "code": "Adds an accelerometer update event listener which prints out the x, y and z axis as the device is moved. You should generally remove the event when not used to conserve device resources. If you do not have an active event listener, the accelerometer is turned off to conserve device resources.
\nTitanium.Accelerometer.addEventListener('update',function(e)\n{\n Ti.API.debug(\"accelerometer - x:\"+e.x+\",y:\"+e.y+\",z:\"+e.z);\n});\nYou'll want to be selective about turning on and off the device accelerometer. It's recommended you turn off the accelerometer when you're not using it.
\nYou can turn off the accelerometer by simply removing your event listener function. You can turn it back on by re-adding the same function with addEventListener.
\nTitanium.Accelerometer.removeEventListener('update',myFunction);\nThe top level Analytics module. 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.
", "events": [], "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.
\nTitanium.Analytics.featureEvent('app.feature.blah',{product:'killer'});\nsend a generic event for the application session
" }, { "filename": "Titanium.Analytics.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Analytics.featureEvent-method", "name": "featureEvent", "parameters": [ { "description": "the event name", "name": "name", "type": "string" }, { "description": "event data or null if not specified. the object must be serializable as JSON", "name": "data", "type": "object" } ], "returntype": "void", "value": "send an analytics feature event for the application session
" }, { "filename": "Titanium.Analytics.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Analytics.navEvent-method", "name": "navEvent", "parameters": [ { "description": "the from location in the nav event", "name": "from", "type": "string" }, { "description": "the to location in the nav event", "name": "to", "type": "string" }, { "description": "the event name", "name": "name", "type": "string" }, { "description": "event data or null if not specified. the object must be serializable as JSON", "name": "data", "type": "object" } ], "returntype": "void", "value": "send an analytics nav event for the application session
" }, { "filename": "Titanium.Analytics.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Analytics.settingsEvent-method", "name": "settingsEvent", "parameters": [ { "description": "the event name", "name": "name", "type": "string" }, { "description": "event data or null if not specified. the object must be serializable as JSON", "name": "data", "type": "object" } ], "returntype": "void", "value": "send a analytics settings event for the application session
" }, { "filename": "Titanium.Analytics.timedEvent-method", "name": "timedEvent", "parameters": [ { "description": "the event name", "name": "name", "type": "string" }, { "description": "the event start as a Date object", "name": "start", "type": "date" }, { "description": "the event end as a Date object", "name": "stop", "type": "date" }, { "description": "the event duration", "name": "duration", "type": "float" }, { "description": "event data or null if not specified. the object must be serializable as JSON", "name": "data", "type": "object" } ], "returntype": "void", "value": "send an analytics timed event for the application session
" }, { "filename": "Titanium.Analytics.userEvent-method", "name": "userEvent", "parameters": [ { "description": "the event name", "name": "name", "type": "string" }, { "description": "event data or null if not specified. the object must be serializable as JSON", "name": "data", "type": "object" } ], "returntype": "void", "value": "send an analytics user event for the application session
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [], "returns": "object", "since": "0.1", "subtype": null, "type": "module" }, "Titanium.App": { "deprecated": null, "description": "The top level App module. The App module is mainly used for accessing information about the application at runtime.
", "events": [ { "filename": "Titanium.App.proximity-event", "name": "proximity", "properties": { "source": "the source object that fired the event", "state": "the proximity state value
", "type": "the name of the event fired" }, "value": "fired when a proximity state changes
" } ], "examples": [], "methods": [ { "filename": "Titanium.App.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.App.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" }, { "description": "the event name", "name": "name", "type": "string" }, { "description": "optional data payload for the event. NOTE: you can only pass JSON serializable data since the data must be transportable between contexts.", "name": "data", "type": "object" } ], "returntype": "void", "value": "fire a cross-context application event. listeners in any Javascript context can receive these events if they have added themselves as a listener with the event name. NOTE: you can only pass JSON serializable data in the data payload of the event object since the data must be transportable between contexts.
" }, { "filename": "Titanium.App.getArguments-method", "name": "getArguments", "parameters": [], "returntype": "object", "value": "return the arguments passed to the application on startup as a dictionary
" }, { "filename": "Titanium.App.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.App.copyright-property", "name": "copyright", "type": "string", "value": "the application's copyright
" }, { "filename": "Titanium.App.description-property", "name": "description", "type": "string", "value": "the application's description
" }, { "filename": "Titanium.App.guid-property", "name": "guid", "type": "string", "value": "the application's globally unique id (this is system generated and consistent through all versions)
" }, { "filename": "Titanium.App.id-property", "name": "id", "type": "string", "value": "the application's app id as specified in Titanium Developer
" }, { "filename": "Titanium.App.idleTimerDisabled-property", "name": "idleTimerDisabled", "type": "boolean", "value": "property for controlling whether the phone screen will be locked on idle time. Can be set to true to disable the timer
" }, { "filename": "Titanium.App.name-property", "name": "name", "type": "string", "value": "the application's name
" }, { "filename": "Titanium.App.proximityDetection-property", "name": "proximityDetection", "type": "boolean", "value": "a boolean to indicate whether proximity detection is enabled
" }, { "filename": "Titanium.App.proximityState-property", "name": "proximityState", "type": "int", "value": "the state of the device's proximity detector
" }, { "filename": "Titanium.App.publisher-property", "name": "publisher", "type": "string", "value": "the application's publisher
" }, { "filename": "Titanium.App.url-property", "name": "url", "type": "string", "value": "the application url
" }, { "filename": "Titanium.App.version-property", "name": "version", "type": "string", "value": "the application's version
" } ], "returns": "object", "since": "0.1", "subtype": null, "type": "module" }, "Titanium.App.Properties": { "deprecated": null, "description": "The App Properties module is used for storing application related property/value pairs which persist beyond application sessions.
", "events": [], "examples": [ { "code": "In this example, we store a string property:
\nTitanium.App.Properties.setString(\"my_prop\",\"cool\");\nIn this example, we print out all the saved properties to the console:
\nvar props = Titanium.App.Properties.listProperties();\nfor (var c=0;creturn a boolean value
" }, { "filename": "Titanium.App.Properties.getDouble-method", "name": "getDouble", "parameters": [ { "description": "return a double value for property", "name": "property", "type": "string" }, { "description": "optional default value if property is not found", "name": "default", "type": "double" } ], "returntype": "double", "value": "return a double value
" }, { "filename": "Titanium.App.Properties.getInt-method", "name": "getInt", "parameters": [ { "description": "return a integer value for property", "name": "property", "type": "string" }, { "description": "optional default value if property is not found", "name": "default", "type": "int" } ], "returntype": "int", "value": "return an integer value
" }, { "filename": "Titanium.App.Properties.getList-method", "name": "getList", "parameters": [ { "description": "return an array value for property", "name": "property", "type": "string" }, { "description": "optional default value if property is not found", "name": "default", "type": "array" } ], "returntype": "array", "value": "return a value as an array
" }, { "filename": "Titanium.App.Properties.getString-method", "name": "getString", "parameters": [ { "description": "return a string value for property", "name": "property", "type": "string" }, { "description": "optional default value if property is not found", "name": "default", "type": "string" } ], "returntype": "string", "value": "return a string value
" }, { "filename": "Titanium.App.Properties.hasProperty-method", "name": "hasProperty", "parameters": [ { "description": "property name to check", "name": "property", "type": "string" } ], "returntype": "boolean", "value": "returns true if the property exists
" }, { "filename": "Titanium.App.Properties.listProperties-method", "name": "listProperties", "parameters": [], "returntype": "array", "value": "return an array of property propertys
" }, { "filename": "Titanium.App.Properties.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.App.Properties.removeProperty-method", "name": "removeProperty", "parameters": [ { "description": "property name to remove", "name": "property", "type": "string" } ], "returntype": "void", "value": "remove an existing property
" }, { "filename": "Titanium.App.Properties.setBool-method", "name": "setBool", "parameters": [ { "description": "property name", "name": "property", "type": "string" }, { "description": "value", "name": "value", "type": "boolean" } ], "returntype": "void", "value": "set a property as a boolean value
" }, { "filename": "Titanium.App.Properties.setDouble-method", "name": "setDouble", "parameters": [ { "description": "property name", "name": "property", "type": "string" }, { "description": "value", "name": "value", "type": "double" } ], "returntype": "void", "value": "set a property as a double value
" }, { "filename": "Titanium.App.Properties.setInt-method", "name": "setInt", "parameters": [ { "description": "property name", "name": "property", "type": "string" }, { "description": "value", "name": "value", "type": "int" }, { "description": "property name", "name": "property", "type": "string" }, { "description": "value", "name": "value", "type": "int" } ], "returntype": "void", "value": "set a property as an integer value
" }, { "filename": "Titanium.App.Properties.setList-method", "name": "setList", "parameters": [ { "description": "property name", "name": "property", "type": "string" }, { "description": "value", "name": "value", "type": "array" } ], "returntype": "void", "value": "set a property as an array value
" }, { "filename": "Titanium.App.Properties.setString-method", "name": "setString", "parameters": [ { "description": "property name", "name": "property", "type": "string" }, { "description": "value", "name": "value", "type": "string" } ], "returntype": "void", "value": "set a property as a string value
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "android", "ipad" ], "properties": [], "returns": "object", "since": "0.5", "subtype": null, "type": "module" }, "Titanium.Contacts": { "deprecated": null, "description": "The top level Contacts module. The Contacts module is used accessing the device Address Book.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Contacts.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Contacts.createGroup-method", "name": "createGroup", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.Contacts.Group", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Contacts.Group" }, { "filename": "Titanium.Contacts.createPerson-method", "name": "createPerson", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.Contacts.Person", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Contacts.Person" }, { "filename": "Titanium.Contacts.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Contacts.getAllGroups-method", "name": "getAllGroups", "parameters": [], "returntype": "void", "value": "Returns an of all Titanium.Contacts.Group objects in the contacts database
" }, { "filename": "Titanium.Contacts.getAllPeople-method", "name": "getAllPeople", "parameters": [], "returntype": "void", "value": "Returns an array of all Titanium.Contacts.Person objects in the contacts database
" }, { "filename": "Titanium.Contacts.getGroupByID-method", "name": "getGroupByID", "parameters": [ { "description": "The database ID of the group to retrieve", "name": "id", "type": "int" } ], "returntype": "object", "value": "Returns a Titanium.Contacts.Group object with the given ID
" }, { "filename": "Titanium.Contacts.getPeopleWithName-method", "name": "getPeopleWithName", "parameters": [ { "description": "The name to match in the database", "name": "name", "type": "string" } ], "returntype": "array", "value": "Returns an array of Titanium.Contacts.Person objects who have a name (first, last, middle, composite) which matches the given name
" }, { "filename": "Titanium.Contacts.getPersonByID-method", "name": "getPersonByID", "parameters": [ { "description": "The database ID of the person to retrieve", "name": "id", "type": "int" } ], "returntype": "object", "value": "Returns a Titanium.Contacts.Person object with the given ID
" }, { "filename": "Titanium.Contacts.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Contacts.removeGroup-method", "name": "removeGroup", "parameters": [ { "description": "The Titanium.Contacts.Group object to remove from the database.", "name": "group", "type": "object" } ], "returntype": "void", "value": "Removes a group from the contacts database
" }, { "filename": "Titanium.Contacts.removePerson-method", "name": "removePerson", "parameters": [ { "description": "The Titanium.Contacts.Person object to remove from the database.", "name": "person", "type": "object" } ], "returntype": "void", "value": "Removes a person from the contacts database
" }, { "filename": "Titanium.Contacts.revert-method", "name": "revert", "parameters": [], "returntype": "void", "value": "Reverts all changes made to the previous save of the database
" }, { "filename": "Titanium.Contacts.save-method", "name": "save", "parameters": [], "returntype": "void", "value": "Saves all changes to contacts to the database
" }, { "filename": "Titanium.Contacts.showContacts-method", "name": "showContacts", "parameters": [ { "description": "The function to call when selection is cancelled", "name": "cancel", "type": "function" }, { "description": "The function to call when a person is selected. Mutually exclusive with selectedProperty", "name": "selectedPerson", "type": "function" }, { "description": "The function to call when a property is selected. Mutally exclusive with selectedPerson", "name": "selectedProperty", "type": "function" }, { "description": "Whether or not to animate the show/hide of the contacts picker", "name": "animated", "type": "boolean" }, { "description": "A list of field names to show when selecting properties, default is to show all available", "name": "fields", "type": "array" } ], "returntype": "void", "value": "Displays the contact picker
" } ], "notes": "Titanium.Contacts.Person objects which have been removed from the database are invalidated after a save operation, whether from creating a new contact or explicitly calling Titanium.Contacts.save(). Using them may result in unpredictable beavhior, including crashes.
", "objects": [ "Titanium.Contacts.Group", "Titanium.Contacts.Person" ], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Contacts.CONTACTS_KIND_ORGANIZATION-property", "name": "CONTACTS_KIND_ORGANIZATION", "type": "int", "value": "constant for 'organization' kind property of Person object
" }, { "filename": "Titanium.Contacts.CONTACTS_KIND_PERSON-property", "name": "CONTACTS_KIND_PERSON", "type": "int", "value": "constant for 'person' kind property of Person object
" }, { "filename": "Titanium.Contacts.CONTACTS_SORT_FIRST_NAME-property", "name": "CONTACTS_SORT_FIRST_NAME", "type": "int", "value": "constant for sorting group members by first name
" }, { "filename": "Titanium.Contacts.CONTACTS_SORT_LAST_NAME-property", "name": "CONTACTS_SORT_LAST_NAME", "type": "int", "value": "constant for sorting group members by last name
" } ], "returns": "object", "since": "0.8", "subtype": null, "type": "module" }, "Titanium.Contacts.Group": { "deprecated": null, "description": "An object which represents a group in the contacts database.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Contacts.Group.add-method", "name": "add", "parameters": [ { "description": "Titanium.Contacts.Person object to remove from the group", "name": "person", "type": "object" } ], "returntype": "void", "value": "Adds a person to the group
" }, { "filename": "Titanium.Contacts.Group.members-method", "name": "members", "parameters": [], "returntype": "void", "value": "The complete list of members of the group
" }, { "filename": "Titanium.Contacts.Group.remove-method", "name": "remove", "parameters": [ { "description": "Titanium.Contacts.Person object to remove from the group", "name": "person", "type": "object" } ], "returntype": "void", "value": "Removes a person from the group
" }, { "filename": "Titanium.Contacts.Group.sortedMembers-method", "name": "sortedMembers", "parameters": [ { "description": "Method for sorting. Must be one of Titanium.Contacts.CONTACTS_SORT_FIRST_NAME or Titanium.Contacts.CONTACTS_SORT_LAST_NAME", "name": "sortBy", "type": "int" } ], "returntype": "void", "value": "A list of sorted members
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Contacts.Group.name-property", "name": "name", "type": "string", "value": "The name of the group
" } ], "returns": null, "since": "1.4.0", "subtype": null, "type": "object" }, "Titanium.Contacts.Person": { "deprecated": null, "description": "An object which represents a person in the contacts database.
", "events": [], "examples": [], "methods": [], "notes": "There are two kinds of properties: single value and multivalue. Single value properties are returned as a direct value, while mutlivalue properties are returned as dictionary objects with keys which represent labels of the property, with values that are arrays of all values in the property which correspond to that label (e.g. {\"home\" : [address1, address2]})
", "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Contacts.Person.URL-property", "name": "URL", "type": "object", "value": "URLs of webpages associated with the person. Multi-value, valid labels are: home, work, other, homepage. Values are strings.
" }, { "filename": "Titanium.Contacts.Person.address-property", "name": "address", "type": "object", "value": "The addresses for the person. Multi-value, valid labels are: home, work, other. Values are dictionaries.
" }, { "filename": "Titanium.Contacts.Person.birthday-property", "name": "birthday", "type": "string", "value": "The birthday of the person. Single value, format is \"yyyy-MM-dd'T'HH:mm:ss'.'SSS+0000\"
" }, { "filename": "Titanium.Contacts.Person.created-property", "name": "created", "type": "string", "value": "The date the person was created in the database. Single value, format is \"yyyy-MM-dd'T'HH:mm:ss'.'SSS+0000\", read-only
" }, { "filename": "Titanium.Contacts.Person.date-property", "name": "date", "type": "object", "value": "Dates associated with the person. Multi-value, valid labels are: anniversary. Values are strings of format \"yyyy-MM-dd'T'HH:mm:ss'.'SSS+0000\"
" }, { "filename": "Titanium.Contacts.Person.department-property", "name": "department", "type": "string", "value": "The department of the person. Single value
" }, { "filename": "Titanium.Contacts.Person.email-property", "name": "email", "type": "object", "value": "The email addresses for the person. Multi-value, valid labels are: home, work, other. Values are strings.
" }, { "filename": "Titanium.Contacts.Person.firstName-property", "name": "firstName", "type": "string", "value": "The first name of the person. Single value
" }, { "filename": "Titanium.Contacts.Person.firstPhonetic-property", "name": "firstPhonetic", "type": "string", "value": "The phonetic first name of the person. Single value
" }, { "filename": "Titanium.Contacts.Person.fullName-property", "name": "fullName", "type": "string", "value": "The localized full name of the person. Single value, read-only
" }, { "filename": "Titanium.Contacts.Person.image-property", "name": "image", "type": "object", "value": "A blob object representing the image for the person. Set to null to remove the image. Single value
" }, { "filename": "Titanium.Contacts.Person.instantMessage-property", "name": "instantMessage", "type": "object", "value": "The instant messenger names for the person. Multi-value, valid labels are: aim, icq, jabber, msn, yahoo. Values are dictionaries.
" }, { "filename": "Titanium.Contacts.Person.jobTitle-property", "name": "jobTitle", "type": "string", "value": "The job title of the person. Single value
" }, { "filename": "Titanium.Contacts.Person.kind-property", "name": "kind", "type": "int", "value": "The kind of person. Single value, one of Titanium.Contacts.CONTACTS_KIND_PERSON or Titanium.Contacts.CONTACTS_KIND_ORGANIZATION
" }, { "filename": "Titanium.Contacts.Person.lastName-property", "name": "lastName", "type": "string", "value": "The last name of the person. Single value
" }, { "filename": "Titanium.Contacts.Person.lastPhonetic-property", "name": "lastPhonetic", "type": "string", "value": "The phonetic last name of the person. Single value
" }, { "filename": "Titanium.Contacts.Person.middleName-property", "name": "middleName", "type": "string", "value": "The middle name of the person. Single value
" }, { "filename": "Titanium.Contacts.Person.middlePhonetic-property", "name": "middlePhonetic", "type": "string", "value": "The phonetic middle name of the person. Single value
" }, { "filename": "Titanium.Contacts.Person.modified-property", "name": "modified", "type": "string", "value": "The most recent date the person was modified. Single value, format is \"yyyy-MM-dd'T'HH:mm:ss'.'SSS+0000\", read-only
" }, { "filename": "Titanium.Contacts.Person.nickname-property", "name": "nickname", "type": "string", "value": "The nickname of the person. Single value
" }, { "filename": "Titanium.Contacts.Person.note-property", "name": "note", "type": "string", "value": "Notes for the person. Single value
" }, { "filename": "Titanium.Contacts.Person.organization-property", "name": "organization", "type": "string", "value": "The organization the person belongs to. Single value
" }, { "filename": "Titanium.Contacts.Person.phone-property", "name": "phone", "type": "object", "value": "The phone numbers for the person. Multi-value, valid labels are: home, work, other, mobile, pager, workFax, homeFax, main, iPhone. Values are strings.
" }, { "filename": "Titanium.Contacts.Person.prefix-property", "name": "prefix", "type": "string", "value": "The prefix for the person. Single value
" }, { "filename": "Titanium.Contacts.Person.relatedNames-property", "name": "relatedNames", "type": "object", "value": "The names of people the person is related to. Multi-value, valid labels are: mother, father, parent, sister, brother, child, friend, spouse, partner, manager, assistant. Values are strings.
" }, { "filename": "Titanium.Contacts.Person.suffix-property", "name": "suffix", "type": "string", "value": "The suffix for the person. Single value
" } ], "returns": null, "since": "0.8", "subtype": null, "type": "object" }, "Titanium.Database": { "deprecated": null, "description": "The top level Database module. The Database module is used for creating and accessing the in-application Database.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Database.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Database.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Database.install-method", "name": "install", "parameters": [ { "description": "the path (relative to the main application Resources folder at build time) to the db to install. this file must be in the SQLite 3 file format.", "name": "path", "type": "string" }, { "description": "the name of the database", "name": "name", "type": "string" } ], "returntype": "object", "value": "install a database from the application Resources folder (at build time) and return a reference to the opened database. it is safe to call this method multiple times since this method will only install once if it doesn't already exist on the device.
" }, { "filename": "Titanium.Database.open-method", "name": "open", "parameters": [ { "description": "the name of the database", "name": "name", "type": "string" } ], "returntype": "object", "value": "open a database. if it doesn't yet exist, create it.
" }, { "filename": "Titanium.Database.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [ "Titanium.Database.DB", "Titanium.Database.ResultSet" ], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [], "returns": "object", "since": "0.1", "subtype": null, "type": "module" }, "Titanium.Database.DB": { "deprecated": null, "description": "The Database instance returned by Titanium.Database.open or Titanium.Database.install.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Database.DB.close-method", "name": "close", "parameters": [], "returntype": "void", "value": "close the database and release resources from memory. once closed, this instance is no longer valid and must no longer be used.
" }, { "filename": "Titanium.Database.DB.execute-method", "name": "execute", "parameters": [ { "description": "the SQL to execute", "name": "sql", "type": "string" }, { "description": "one or more optional variable arguments passed to this function or an array of objects to be replaced in the query using ? substitution.", "name": "vararg", "type": "array,..." } ], "returntype": "object", "value": "execute a SQL statement against the database and returns a ResultSet
" }, { "filename": "Titanium.Database.DB.remove-method", "name": "remove", "parameters": [], "returntype": "void", "value": "remove the database files for this instance from disk. WARNING: this is a destructive operation and cannot be reversed. All data in the database will be lost upon calling this function. Use with caution.
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Database.DB.lastInsertRowId-property", "name": "lastInsertRowId", "type": "int", "value": "the last row identifier by the last INSERT query
" }, { "filename": "Titanium.Database.DB.name-property", "name": "name", "type": "string", "value": "the name of the database
" }, { "filename": "Titanium.Database.DB.rowsAffected-property", "name": "rowsAffected", "type": "int", "value": "the number of rows affected by the last query
" } ], "returns": null, "since": "0.1", "subtype": null, "type": "object" }, "Titanium.Database.ResultSet": { "deprecated": null, "description": "The ResultSet instance returned by invoking a database SQL execute.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Database.ResultSet.close-method", "name": "close", "parameters": [], "returntype": "void", "value": "close the result set and release resources. once closed, this result set must no longer be used
" }, { "filename": "Titanium.Database.ResultSet.field-method", "name": "field", "parameters": [ { "description": "column index (which is zero based)", "name": "index", "type": "int" } ], "returntype": "object", "value": "retrieve a row value by field index
" }, { "filename": "Titanium.Database.ResultSet.fieldByName-method", "name": "fieldByName", "parameters": [ { "description": "column name from SQL query", "name": "name", "type": "string" } ], "returntype": "object", "value": "retrieve a row value by field name
" }, { "filename": "Titanium.Database.ResultSet.fieldCount-method", "name": "fieldCount", "parameters": [], "returntype": "int", "value": "return the number of columns in the result set
" }, { "filename": "Titanium.Database.ResultSet.fieldName-method", "name": "fieldName", "parameters": [ { "description": "field name column index (which is zero based)", "name": "index", "type": "int" } ], "returntype": "string", "value": "return the field name for field index
" }, { "filename": "Titanium.Database.ResultSet.isValidRow-method", "name": "isValidRow", "parameters": [], "returntype": "boolean", "value": "return true if the row is a valid row
" }, { "filename": "Titanium.Database.ResultSet.next-method", "name": "next", "parameters": [], "returntype": "boolean", "value": "iterate to the next row in the result set. returns false if no more results are available
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Database.ResultSet.rowCount-property", "name": "rowCount", "type": "int", "value": "the number of rows in the result set
" }, { "filename": "Titanium.Database.ResultSet.validRow-property", "name": "validRow", "type": "boolean", "value": "returns true if the current row is still valid
" } ], "returns": null, "since": "0.1", "subtype": null, "type": "object" }, "Titanium.Facebook": { "deprecated": null, "description": "The top level Facebook module. The Facebook module is used for connecting your application with \nFacebook through Facebook Connect.
", "events": [ { "filename": "Titanium.Facebook.login-event", "name": "login", "properties": { "cancel": "true if the user cancelled the request by closing the dialog
", "error": "error message if success was false
", "source": "the source object that fired the event", "success": "true if the login was successful
", "type": "the name of the event fired" }, "value": "fired at session login
" }, { "filename": "Titanium.Facebook.logout-event", "name": "logout", "properties": { "cancel": "true if the user cancelled the request by closing the dialog
", "error": "error message if success was false
", "source": "the source object that fired the event", "success": "true if the logout was successful
", "type": "the name of the event fired" }, "value": "fired at session logout
" } ], "examples": [], "methods": [ { "filename": "Titanium.Facebook.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Facebook.createLoginButton-method", "name": "createLoginButton", "parameters": [ { "description": "the parameters for the request. the following keys are valid: apikey (the application API key), secret (the application API secret or null if using a session proxy), sessionProxy (the URL to the application session proxy), style (the button style - which is either normal or wide).", "name": "params", "type": "object" }, { "description": "(optional) a dictionary object properties defined in Titanium.Facebook.LoginButton", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Facebook.LoginButton" }, { "filename": "Titanium.Facebook.execute-method", "name": "execute", "parameters": [ { "description": "method to execute", "name": "method", "type": "string" }, { "description": "JSON serializable object or null (if no parameters) to send with the request", "name": "params", "type": "object" }, { "description": "the callback function to execute upon receiving a response. the result object will contain a success boolean to indicate the result. if success is false, the error property will give the error message. the data property will contain the result if successfully executed.", "name": "callback", "type": "function" }, { "description": "the data payload for the request. Must either null, a string or a Blob object.", "name": "data", "type": "object" } ], "returntype": "void", "value": "execute a FB API execute request
" }, { "filename": "Titanium.Facebook.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Facebook.hasPermission-method", "name": "hasPermission", "parameters": [ { "description": "the permission to check", "name": "permission", "type": "string" } ], "returntype": "boolean", "value": "checks the existing permission and returns true if the user has granted the requested permission
" }, { "filename": "Titanium.Facebook.isLoggedIn-method", "name": "isLoggedIn", "parameters": [], "returntype": "void", "value": "return true if the user has logged in
" }, { "filename": "Titanium.Facebook.publishStream-method", "name": "publishStream", "parameters": [ { "description": "the title of the stream post", "name": "title", "type": "string" }, { "description": "the data to include in the post. Must be JSON serializable or null.", "name": "data", "type": "object" }, { "description": "the target user id to publish the stream or null if the logged in users account", "name": "target", "type": "string" }, { "description": "the callback function to execute upon receiving a response. the result object will contain a success boolean to indicate the result. if success is false, the error property will give the error message. the data property will contain the result if successfully executed. the cancel property will be set to true if the user cancelled the dialog.", "name": "callback", "type": "function" } ], "returntype": "void", "value": "execute a stream request to FB
" }, { "filename": "Titanium.Facebook.query-method", "name": "query", "parameters": [ { "description": "the FQL query to execute", "name": "fql", "type": "string" }, { "description": "the callback to execute with results once the query is completed. the result object will contain a success boolean to indicate the result. if success is false, the error property will give the error message. the data property will contain the result if successfully executed.", "name": "callback", "type": "function" } ], "returntype": "void", "value": "execute a FQL query against the FB API
" }, { "filename": "Titanium.Facebook.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Facebook.requestPermission-method", "name": "requestPermission", "parameters": [ { "description": "name of the permission", "name": "permission", "type": "string" }, { "description": "the callback function to execute upon receiving a response. the result object will contain a success boolean to indicate the result. if success is false, the error property will give the error message. the data property will contain the result if successfully executed. the cancel property will be set to true if the user cancelled the dialog.", "name": "callback", "type": "function" } ], "returntype": "void", "value": "request a special permission from the user
" } ], "notes": null, "objects": [ "Titanium.Facebook.LoginButton" ], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Facebook.loggedIn-property", "name": "loggedIn", "type": "boolean", "value": "return true if the user has logged in
" }, { "filename": "Titanium.Facebook.permissions-property", "name": "permissions", "type": "object", "value": "return a dictionary of permissions with the keys being the name of the permission and the value being a boolean of true if granted, false if not granted
" }, { "filename": "Titanium.Facebook.session-property", "name": "session", "type": "object", "value": "return the special properties of the session
" }, { "filename": "Titanium.Facebook.userId-property", "name": "userId", "type": "long", "value": "the unique user id returned from Facebook. returns 0 if not logged in
" } ], "returns": "object", "since": "0.8", "subtype": null, "type": "module" }, "Titanium.Facebook.LoginButton": { "deprecated": null, "description": "The Login Button created by Titanium.Facebook.createLoginButton.
", "events": [ { "filename": "Titanium.Facebook.LoginButton.cancel-event", "name": "cancel", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the login is cancelled
" }, { "filename": "Titanium.Facebook.LoginButton.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.Facebook.LoginButton.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.Facebook.LoginButton.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.Facebook.LoginButton.login-event", "name": "login", "properties": { "cancel": "true if the user cancelled the request by closing the dialog
", "error": "error message if success was false
", "source": "the source object that fired the event", "success": "true if the login was successful
", "type": "the name of the event fired" }, "value": "fired at session login
" }, { "filename": "Titanium.Facebook.LoginButton.logout-event", "name": "logout", "properties": { "cancel": "true if the user cancelled the request by closing the dialog
", "error": "error message if success was false
", "source": "the source object that fired the event", "success": "true if the logout was successful
", "type": "the name of the event fired" }, "value": "fired at session logout
" }, { "filename": "Titanium.Facebook.LoginButton.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.Facebook.LoginButton.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.Facebook.LoginButton.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.Facebook.LoginButton.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.Facebook.LoginButton.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.Facebook.LoginButton.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.Facebook.LoginButton.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [], "methods": [ { "filename": "Titanium.Facebook.LoginButton.add-method", "name": "add", "parameters": [ { "description": "the view to add to this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "add a child to the view hierarchy" }, { "filename": "Titanium.Facebook.LoginButton.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Facebook.LoginButton.animate-method", "name": "animate", "parameters": [ { "description": "either a dictionary of animation properties or an Animation object", "name": "obj", "type": "object" }, { "description": "function to be invoked upon completion of the animation", "name": "callback", "type": "function" } ], "returntype": "void", "value": "animate the view" }, { "filename": "Titanium.Facebook.LoginButton.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Facebook.LoginButton.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.Facebook.LoginButton.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.Facebook.LoginButton.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Facebook.LoginButton.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.Facebook.LoginButton.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Facebook.LoginButton.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.Facebook.LoginButton.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.Facebook.LoginButton.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.Facebook.LoginButton.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.Facebook.LoginButton.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.Facebook.LoginButton.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.Facebook.LoginButton.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.Facebook.LoginButton.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.Facebook.LoginButton.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.Facebook.LoginButton.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.Facebook.LoginButton.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.Facebook.LoginButton.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.Facebook.LoginButton.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.Facebook.LoginButton.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.Facebook.LoginButton.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.Facebook.LoginButton.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.Facebook.LoginButton.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.Facebook.LoginButton.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.Facebook.LoginButton.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.Facebook.LoginButton.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.Facebook.LoginButton.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.Facebook.LoginButton.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.Facebook.LoginButton.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.Filesystem": { "deprecated": null, "description": "The top level Filesystem module. The Filesystem module is used for reading and saving files and \ndirectories on the device.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Filesystem.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Filesystem.createFile-method", "name": "createFile", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.Filesystem.File", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Filesystem.File" }, { "filename": "Titanium.Filesystem.createTempDirectory-method", "name": "createTempDirectory", "parameters": [], "returntype": "Titanium.Filesystem.File", "value": "create temp file and return a Titanium.Filesystem.File
" }, { "filename": "Titanium.Filesystem.createTempFile-method", "name": "createTempFile", "parameters": [], "returntype": "Titanium.Filesystem.File", "value": "create a temp file and return a Titanium.Filesystem.File
" }, { "filename": "Titanium.Filesystem.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Filesystem.getFile-method", "name": "getFile", "parameters": [ { "description": "one or more path arguments to form the full path joined together with the platform specific path separator. if a relative path is passed, the full path will be relative to the application resource folder.", "name": "path", "type": "string" } ], "returntype": "Titanium.Filesystem.File", "value": "return a fully formed file path as a Titanium.Filesystem.File object
" }, { "filename": "Titanium.Filesystem.isExteralStoragePresent-method", "name": "isExteralStoragePresent", "parameters": [], "returntype": "boolean", "value": "returns true if the device supports external storage such as an SD card
" }, { "filename": "Titanium.Filesystem.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [ "Titanium.Filesystem.File" ], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Filesystem.MODE_APPEND-property", "name": "MODE_APPEND", "type": "int", "value": "constant for append mode for file operations
" }, { "filename": "Titanium.Filesystem.MODE_READ-property", "name": "MODE_READ", "type": "int", "value": "constant for read mode for file operations
" }, { "filename": "Titanium.Filesystem.MODE_WRITE-property", "name": "MODE_WRITE", "type": "int", "value": "constant for write mode for file operations
" }, { "filename": "Titanium.Filesystem.applicationDataDirectory-property", "name": "applicationDataDirectory", "type": "string", "value": "readonly constant where your application data directory is located. this directory should be used to place applications-specific files. on iPhone, this directory is also backed up.
" }, { "filename": "Titanium.Filesystem.applicationDirectory-property", "name": "applicationDirectory", "type": "string", "value": "readonly constant where your application is located
" }, { "filename": "Titanium.Filesystem.lineEnding-property", "name": "lineEnding", "type": "string", "value": "readonly platform specific line ending constant
" }, { "filename": "Titanium.Filesystem.resourcesDirectory-property", "name": "resourcesDirectory", "type": "string", "value": "readonly constant where your application resources are located
" }, { "filename": "Titanium.Filesystem.separator-property", "name": "separator", "type": "string", "value": "readonly path separator constant
" }, { "filename": "Titanium.Filesystem.tempDirectory-property", "name": "tempDirectory", "type": "string", "value": "readonly constant where your application can place temporary files
" } ], "returns": "object", "since": "0.1", "subtype": null, "type": "module" }, "Titanium.Filesystem.File": { "deprecated": null, "description": "The File object which support various filesystem based operations.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Filesystem.File.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Filesystem.File.createDirectory-method", "name": "createDirectory", "parameters": [], "returntype": "boolean", "value": "create a directory at the path for the file object
" }, { "filename": "Titanium.Filesystem.File.createFile-method", "name": "createFile", "parameters": [], "returntype": "boolean", "value": "create a file path at the path for the file object
" }, { "filename": "Titanium.Filesystem.File.createTimestamp-method", "name": "createTimestamp", "parameters": [], "returntype": "long", "value": "return the created timestamp for the file
" }, { "filename": "Titanium.Filesystem.File.deleteDirectory-method", "name": "deleteDirectory", "parameters": [ { "description": "pass true to recursively delete any contents. defaults to false", "name": "recursive", "type": "boolean" } ], "returntype": "boolean", "value": "delete the file directory path
" }, { "filename": "Titanium.Filesystem.File.deleteFile-method", "name": "deleteFile", "parameters": [], "returntype": "boolean", "value": "delete the file
" }, { "filename": "Titanium.Filesystem.File.executable-method", "name": "executable", "parameters": [], "returntype": "boolean", "value": "returns true if the file is executable
" }, { "filename": "Titanium.Filesystem.File.exists-method", "name": "exists", "parameters": [], "returntype": "boolean", "value": "returns true if the file or directory exists on the device
" }, { "filename": "Titanium.Filesystem.File.extension-method", "name": "extension", "parameters": [], "returntype": "string", "value": "return the file extension
" }, { "filename": "Titanium.Filesystem.File.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Filesystem.File.getDirectoryListing-method", "name": "getDirectoryListing", "parameters": [], "returntype": "array", "value": "return an array of paths in the directory of the file object
" }, { "filename": "Titanium.Filesystem.File.getParent-method", "name": "getParent", "parameters": [], "returntype": "Titanium.Filesystem.File", "value": "return the file parent
" }, { "filename": "Titanium.Filesystem.File.hidden-method", "name": "hidden", "parameters": [], "returntype": "boolean", "value": "returns true if the file is hidden
" }, { "filename": "Titanium.Filesystem.File.modificationTimestamp-method", "name": "modificationTimestamp", "parameters": [], "returntype": "long", "value": "return the last modification timestamp for the file
" }, { "filename": "Titanium.Filesystem.File.move-method", "name": "move", "parameters": [ { "description": "new location", "name": "newpath", "type": "string|object" } ], "returntype": "boolean", "value": "move the file to another path
" }, { "filename": "Titanium.Filesystem.File.name-method", "name": "name", "parameters": [], "returntype": "string", "value": "the name of the file
" }, { "filename": "Titanium.Filesystem.File.nativePath-method", "name": "nativePath", "parameters": [], "returntype": "string", "value": "returns the fully resolved native path
" }, { "filename": "Titanium.Filesystem.File.read-method", "name": "read", "parameters": [], "returntype": "Titanium.Blob", "value": "return the contents of file as blob
" }, { "filename": "Titanium.Filesystem.File.readonly-method", "name": "readonly", "parameters": [], "returntype": "boolean", "value": "returns true if the file is readonly
" }, { "filename": "Titanium.Filesystem.File.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Filesystem.File.rename-method", "name": "rename", "parameters": [ { "description": "new name", "name": "newname", "type": "string" } ], "returntype": "boolean", "value": "rename the file
" }, { "filename": "Titanium.Filesystem.File.setExecutable-method", "name": "setExecutable", "parameters": [], "returntype": "void", "value": "make the file executable
" }, { "filename": "Titanium.Filesystem.File.setHidden-method", "name": "setHidden", "parameters": [], "returntype": "void", "value": "make the file hidden
" }, { "filename": "Titanium.Filesystem.File.setReadonly-method", "name": "setReadonly", "parameters": [], "returntype": "void", "value": "make the file readonly
" }, { "filename": "Titanium.Filesystem.File.spaceAvailable-method", "name": "spaceAvailable", "parameters": [], "returntype": "boolean", "value": "return boolean to indicate if the path has space available for storage
" }, { "filename": "Titanium.Filesystem.File.symbolicLink-method", "name": "symbolicLink", "parameters": [], "returntype": "boolean", "value": "returns true if the file points to a symbolic link
" }, { "filename": "Titanium.Filesystem.File.write-method", "name": "write", "parameters": [ { "description": "write the contents of string, blob or [[Titanium.Filesystem.File]] to file", "name": "contents", "type": "string|object" } ], "returntype": "boolean", "value": "write the contents to file
" }, { "filename": "Titanium.Filesystem.File.writeable-method", "name": "writeable", "parameters": [], "returntype": "boolean", "value": "returns true if the file is writeable
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [], "returns": null, "since": "0.1", "subtype": "proxy", "type": "object" }, "Titanium.Geolocation": { "deprecated": null, "description": "The top level Geolocation module. The Geolocation module is used for accessing device location based information.
", "events": [ { "filename": "Titanium.Geolocation.calibration-event", "name": "calibration", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired only on iPhone/iPad when the device detects interface and requires calibration. when this event is fired, the calibration UI is being displayed to the end user.
" }, { "filename": "Titanium.Geolocation.heading-event", "name": "heading", "properties": { "error": "if success is false, returns a string of the error description
", "heading": "heading results dictionary with the following sub-properties: magneticHeading, trueHeading, accuracy, x, y, z, timestamp.
", "source": "the source object that fired the event", "success": "boolean to indicate if the heading event was successfully received or an error occurred
", "type": "the name of the event fired" }, "value": "fired when a heading event is received
" }, { "filename": "Titanium.Geolocation.location-event", "name": "location", "properties": { "coords": "location coordinates dictionary with the following sub-properties: latitude, longitude, altitude, accuracy, altitudeAccuracy, heading, speed, timestamp.
", "error": "if success is false, returns a string of the error description
", "source": "the source object that fired the event", "success": "boolean to indicate if the location event was successfully received or an error occurred
", "type": "the name of the event fired" }, "value": "fired when a location event is received
" } ], "examples": [], "methods": [ { "filename": "Titanium.Geolocation.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Geolocation.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Geolocation.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Geolocation.setShowCalibration-method", "name": "setShowCalibration", "parameters": [], "returntype": "void", "value": "configure the calibration UI. set the false to disable the calibration display.
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Geolocation.ACCURACY_BEST-property", "name": "ACCURACY_BEST", "type": "int", "value": "accuracy constant
" }, { "filename": "Titanium.Geolocation.ACCURACY_HUNDRED_METERS-property", "name": "ACCURACY_HUNDRED_METERS", "type": "int", "value": "accuracy constant
" }, { "filename": "Titanium.Geolocation.ACCURACY_KILOMETER-property", "name": "ACCURACY_KILOMETER", "type": "int", "value": "accuracy constant
" }, { "filename": "Titanium.Geolocation.ACCURACY_NEAREST_TEN_METERS-property", "name": "ACCURACY_NEAREST_TEN_METERS", "type": "int", "value": "accuracy constant
" }, { "filename": "Titanium.Geolocation.ACCURACY_THREE_KILOMETERS-property", "name": "ACCURACY_THREE_KILOMETERS", "type": "int", "value": "accuracy constant
" }, { "filename": "Titanium.Geolocation.PROVIDER_GPS-property", "name": "PROVIDER_GPS", "type": "string", "value": "The GPS location provider
" }, { "filename": "Titanium.Geolocation.PROVIDER_NETWORK-property", "name": "PROVIDER_NETWORK", "type": "string", "value": "The Network location provider
" }, { "filename": "Titanium.Geolocation.locationServicesEnabled-property", "name": "locationServicesEnabled", "type": "boolean", "value": "returns true if the user has enabled or disable location services for the device (not the application).
" }, { "filename": "Titanium.Geolocation.preferredProvider-property", "name": "preferredProvider", "type": "string", "value": "allows setting of the preferred location provider. Returns undefined when the preferred provider is auto-detected
" }, { "filename": "Titanium.Geolocation.purpose-property", "name": "purpose", "type": "string", "value": "(iOS only). This property informs the end-user why location services are being requested by the application. This string will be display in the permission dialog. This property is REQUIRED starting in 4.0.
" }, { "filename": "Titanium.Geolocation.showCalibration-property", "name": "showCalibration", "type": "boolean", "value": "returns true if the calibration UI can show
" } ], "returns": "object", "since": "0.1", "subtype": null, "type": "module" }, "Titanium.Gesture": { "deprecated": null, "description": "The top level Gestures module. The Gesture module is responsible for high level device gestures that are device-wide.
", "events": [ { "filename": "Titanium.Gesture.orientationchange-event", "name": "orientationchange", "properties": { "orientation": "the orientation constant
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the device orientation changes
" }, { "filename": "Titanium.Gesture.shake-event", "name": "shake", "properties": { "source": "the source object that fired the event", "timestamp": "timestamp reference since previous shake
", "type": "the name of the event fired" }, "value": "fired when the device is shaken
" } ], "examples": [], "methods": [ { "filename": "Titanium.Gesture.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Gesture.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Gesture.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [], "returns": "object", "since": "0.8", "subtype": null, "type": "module" }, "Titanium.Map": { "deprecated": null, "description": "The top level Map module. The Map module is used for creating in-application native maps.
", "events": [], "examples": [ { "code": "This is a basic map example that uses a custom annotation on the map.
\nvar 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);\nThe head of the pin is green. Green pins indicate starting points on the map.
" }, { "filename": "Titanium.Map.ANNOTATION_PURPLE-property", "name": "ANNOTATION_PURPLE", "type": "int", "value": "The head of the pin is purple. Purple pins indicate user-specified points on the map.
" }, { "filename": "Titanium.Map.ANNOTATION_RED-property", "name": "ANNOTATION_RED", "type": "int", "value": "The head of the pin is red. Red pins indicate destination points on the map.
" }, { "filename": "Titanium.Map.HYBRID_TYPE-property", "name": "HYBRID_TYPE", "type": "int", "value": "Displays a satellite image of the area with road and road name information layered on top.
" }, { "filename": "Titanium.Map.SATELLITE_TYPE-property", "name": "SATELLITE_TYPE", "type": "int", "value": "Displays satellite imagery of the area.
" }, { "filename": "Titanium.Map.STANDARD_TYPE-property", "name": "STANDARD_TYPE", "type": "int", "value": "Displays a street map that shows the position of all roads and some road names.
" } ], "returns": "object", "since": "0.8", "subtype": null, "type": "module" }, "Titanium.Map.Annotation": { "deprecated": null, "description": "An Annotation object that is created by the method Titanium.Map.createAnnotation. This object gives you low level control over annotations that can be added to a Map View.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Map.Annotation.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Map.Annotation.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Map.Annotation.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Map.Annotation.animate-property", "name": "animate", "type": "boolean", "value": "boolean to indicate whether the pin should animate when dropped
" }, { "filename": "Titanium.Map.Annotation.image-property", "name": "image", "type": "string", "value": "image view for the pin instead of default image. currently only supported in iphone
" }, { "filename": "Titanium.Map.Annotation.leftButton-property", "name": "leftButton", "type": "int,string", "value": "the left button image on the annotation. must either be a button type constant or url
" }, { "filename": "Titanium.Map.Annotation.leftView-property", "name": "leftView", "type": "object", "value": "a left view that is displayed on the annotation
" }, { "filename": "Titanium.Map.Annotation.pincolor-property", "name": "pincolor", "type": "int", "value": "the pin color as one of Titanium.Map.ANNOTATION_RED, Titanium.Map.ANNOTATION_GREEN or Titanium.Map.ANNOTATION_PURPLE.
" }, { "filename": "Titanium.Map.Annotation.rightButton-property", "name": "rightButton", "type": "int,string", "value": "the right button image on the annotation. must either be a button type constant or url
" }, { "filename": "Titanium.Map.Annotation.rightView-property", "name": "rightView", "type": "object", "value": "a right view that is displayed on the annotation
" }, { "filename": "Titanium.Map.Annotation.subtitle-property", "name": "subtitle", "type": "string", "value": "the secondary title of the annotation view
" }, { "filename": "Titanium.Map.Annotation.title-property", "name": "title", "type": "string", "value": "the primary title of the annotation view
" } ], "returns": null, "since": "0.9", "subtype": "proxy", "type": "object" }, "Titanium.Map.MapView": { "deprecated": null, "description": "The MapView is an object created by Titanium.Map.createView and is used for embedding native mapping capabilities as a view in your application. With native maps, you can control the mapping location, the type of map, the zoom level and you can add custom annotations directly to the map.
", "events": [ { "filename": "Titanium.Map.MapView.click-event", "name": "click", "properties": { "annotation": "the announce source object
", "clicksource": "the source of either annotation, leftButton or rightButton to indicate to location of the click
", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "index": "the annotation index
", "map": "the map view instance
", "source": "the source object that fired the event", "title": "the annotation title
", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a map view or annotation is touched
" }, { "filename": "Titanium.Map.MapView.complete-event", "name": "complete", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the map completes loading
" }, { "filename": "Titanium.Map.MapView.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.Map.MapView.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.Map.MapView.error-event", "name": "error", "properties": { "message": "the error message
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the map receives a mapping error
" }, { "filename": "Titanium.Map.MapView.loading-event", "name": "loading", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the map begins loading
" }, { "filename": "Titanium.Map.MapView.regionChanged-event", "name": "regionChanged", "properties": { "latitude": "the new latitude
", "latitudeDelta": "the new latitude delta
", "longitude": "the new longitude
", "longitudeDelta": "the new longitude delta
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the mapping region changes
" }, { "filename": "Titanium.Map.MapView.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.Map.MapView.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.Map.MapView.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.Map.MapView.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.Map.MapView.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.Map.MapView.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.Map.MapView.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [], "methods": [ { "filename": "Titanium.Map.MapView.add-method", "name": "add", "parameters": [ { "description": "the view to add to this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "add a child to the view hierarchy" }, { "filename": "Titanium.Map.MapView.addAnnotation-method", "name": "addAnnotation", "parameters": [ { "description": "either a dictionary of properties for the annotation or a [Titanium.Map.Annotation](Titanium.Map.Annotation) instance.", "name": "annotation", "type": "object" } ], "returntype": "void", "value": "add a new annotation to the map
" }, { "filename": "Titanium.Map.MapView.addAnnotations-method", "name": "addAnnotations", "parameters": [ { "description": "an array of either a dictionary of properties for the annotation or a [Titanium.Map.Annotation](Titanium.Map.Annotation) instance.", "name": "annotations", "type": "array" } ], "returntype": "void", "value": "add one or more new annotation to the map
" }, { "filename": "Titanium.Map.MapView.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Map.MapView.addRoute-method", "name": "addRoute", "parameters": [ { "description": "dictionary with the properties: name route name, points dictionary of values with longitude and latitude keys, color for the line color and width for the line width.", "name": "route", "type": "object" } ], "returntype": "void", "value": "add a route. currently only supported on iphone
" }, { "filename": "Titanium.Map.MapView.animate-method", "name": "animate", "parameters": [ { "description": "either a dictionary of animation properties or an Animation object", "name": "obj", "type": "object" }, { "description": "function to be invoked upon completion of the animation", "name": "callback", "type": "function" } ], "returntype": "void", "value": "animate the view" }, { "filename": "Titanium.Map.MapView.deselectAnnotation-method", "name": "deselectAnnotation", "parameters": [ { "description": "either a string of the annotation title or a [Titanium.Map.Annotation](Titanium.Map.Annotation) reference.", "name": "annotation", "type": "string,object" } ], "returntype": "void", "value": "cause the annotation to be deselected (hidden).
" }, { "filename": "Titanium.Map.MapView.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Map.MapView.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.Map.MapView.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.Map.MapView.removeAllAnnotations-method", "name": "removeAllAnnotations", "parameters": [], "returntype": "void", "value": "removes all annotations added to the map
" }, { "filename": "Titanium.Map.MapView.removeAnnotation-method", "name": "removeAnnotation", "parameters": [ { "description": "either a string of the annotation title or a [Titanium.Map.Annotation](Titanium.Map.Annotation) reference.", "name": "annotation", "type": "string,object" } ], "returntype": "void", "value": "remove an existing annotation from the map
" }, { "filename": "Titanium.Map.MapView.removeAnnotations-method", "name": "removeAnnotations", "parameters": [ { "description": "an array of either a string of the annotation title or a [Titanium.Map.Annotation](Titanium.Map.Annotation) reference.", "name": "annotation", "type": "array" } ], "returntype": "void", "value": "remove one or more existing annotations from the map
" }, { "filename": "Titanium.Map.MapView.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Map.MapView.removeRoute-method", "name": "removeRoute", "parameters": [ { "description": "same route object used during addRoute", "name": "route", "type": "object" } ], "returntype": "void", "value": "remove a previously added route. currently only supported on iphone
" }, { "filename": "Titanium.Map.MapView.selectAnnotation-method", "name": "selectAnnotation", "parameters": [ { "description": "either a string of the annotation title or a [Titanium.Map.Annotation](Titanium.Map.Annotation) reference.", "name": "annotation", "type": "string,object" } ], "returntype": "void", "value": "cause the annotation to be selected (shown).
" }, { "filename": "Titanium.Map.MapView.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.Map.MapView.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" }, { "filename": "Titanium.Map.MapView.zoom-method", "name": "zoom", "parameters": [ { "description": "zoom level (can be positive or negative)", "name": "level", "type": "double" } ], "returntype": "void", "value": "zoom in or out of the map
" } ], "notes": "For Android, you will need to obtain a map key from Google to use maps in your application. On iPhone, you cannot call any methods on a map view until it has been added to a view.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Map.MapView.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.Map.MapView.animate-property", "name": "animate", "type": "boolean", "value": "boolean is mapping actions should be animated
" }, { "filename": "Titanium.Map.MapView.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.Map.MapView.annotations-property", "name": "annotations", "type": "array", "value": "an array of annotations to add to the map
" }, { "filename": "Titanium.Map.MapView.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.Map.MapView.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.Map.MapView.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.Map.MapView.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.Map.MapView.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.Map.MapView.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.Map.MapView.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.Map.MapView.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.Map.MapView.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.Map.MapView.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.Map.MapView.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.Map.MapView.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.Map.MapView.location-property", "name": "location", "type": "object", "value": "a dictionary that specifies the following properties specifying the region location to set the map: latitudeDelta, longitudeDelta, latitude, longitude.
" }, { "filename": "Titanium.Map.MapView.mapType-property", "name": "mapType", "type": "int", "value": "the map type constant of either Titanium.Map.STANDARD_TYPE, Titanium.Map.SATELLITE_TYPE or Titanium.Map.HYBRID_TYPE.
" }, { "filename": "Titanium.Map.MapView.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.Map.MapView.region-property", "name": "region", "type": "object", "value": "a dictionary that specifies the following properties specifying the region location to set the map: latitudeDelta, longitudeDelta, latitude, longitude.
" }, { "filename": "Titanium.Map.MapView.regionFit-property", "name": "regionFit", "type": "boolean", "value": "boolean to indicate if the map should attempt to fit the map view into the region in the visible view
" }, { "filename": "Titanium.Map.MapView.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.Map.MapView.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.Map.MapView.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.Map.MapView.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.Map.MapView.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.Map.MapView.userLocation-property", "name": "userLocation", "type": "boolean", "value": "boolean to indicate if the map should show the user's current device location as a pin on the map
" }, { "filename": "Titanium.Map.MapView.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.Map.MapView.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.Map.MapView.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.Media": { "deprecated": null, "description": "The top level Media module. The Media module is used accessing the device's media related functionality such as playing audio or recording video.
", "events": [ { "filename": "Titanium.Media.linechange-event", "name": "linechange", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when a audio line type change is detected
" }, { "filename": "Titanium.Media.recordinginput-event", "name": "recordinginput", "properties": { "available": "bool indicating availability of recording device
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when availablity of recording input changes
" }, { "filename": "Titanium.Media.volume-event", "name": "volume", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "volume": "float of the new volume in dB
" }, "value": "fired when the volume output changes
" } ], "examples": [], "methods": [ { "filename": "Titanium.Media.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Media.beep-method", "name": "beep", "parameters": [], "returntype": "void", "value": "play a device beep notification
" }, { "filename": "Titanium.Media.createAudioPlayer-method", "name": "createAudioPlayer", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.Media.AudioPlayer", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Media.AudioPlayer" }, { "filename": "Titanium.Media.createAudioRecorder-method", "name": "createAudioRecorder", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.Media.AudioRecorder", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Media.AudioRecorder" }, { "filename": "Titanium.Media.createItem-method", "name": "createItem", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.Media.Item", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Media.Item" }, { "filename": "Titanium.Media.createMusicPlayer-method", "name": "createMusicPlayer", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.Media.MusicPlayer", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Media.MusicPlayer" }, { "filename": "Titanium.Media.createSound-method", "name": "createSound", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.Media.Sound", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Media.Sound" }, { "filename": "Titanium.Media.createVideoPlayer-method", "name": "createVideoPlayer", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.Media.VideoPlayer", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Media.VideoPlayer" }, { "filename": "Titanium.Media.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Media.hideCamera-method", "name": "hideCamera", "parameters": [], "returntype": "void", "value": "hide the device camera UI. this must be called after calling showCamera and only when autohide is set to false. this method will cause the media capture device be hidden.
" }, { "filename": "Titanium.Media.hideMusicLibrary-method", "name": "hideMusicLibrary", "parameters": [], "returntype": "void", "value": "hide the music library. This must be called after calling showMusicLibrary and only when autohide is set to false. iPhone and iPad only.
" }, { "filename": "Titanium.Media.isMediaTypeSupported-method", "name": "isMediaTypeSupported", "parameters": [ { "description": "media type as a string of either camera, photo or photogallery.", "name": "media", "type": "string" }, { "description": "the type of media to check", "name": "type", "type": "string" } ], "returntype": "boolean", "value": "return boolean to indicate if the media type is supported
" }, { "filename": "Titanium.Media.openPhotoGallery-method", "name": "openPhotoGallery", "parameters": [ { "description": "pass a dictionary with the following supported keys: success a function that will be called when the camera is completed, error a function that will be called upon receiving an error, cancel a function that will be called if the user presses the cancel button, autohide boolean if the camera should auto hide after the media capture is completed (defaults to true), animated boolean if the dialog should be animated (defaults to true) upon showing and hiding, saveToPhotoGallery boolean if the media should be saved to the photo gallery upon successful capture, allowEditing boolean if the media should be editable after capture in the UI interface, mediaTypes an array of media type constants supported by the capture device UI, showControls boolean to indicate if the built-in UI controls should be displayed, overlay view which is added as an overlay to the UI (on top), transform an transformation matrix that applies to the UI transform. For iPad, popoverView can be provided to position the photo gallery popover a specific view and arrowDirection can be provided to control the type of arrow and position of the gallery.", "name": "options", "type": "object" } ], "returntype": "void", "value": "open the photo gallery picker
" }, { "filename": "Titanium.Media.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Media.saveToPhotoGallery-method", "name": "saveToPhotoGallery", "parameters": [ { "description": "save the media passed to the cameras photo roll/media gallery. must be one of Blob object or File object or an error will be generated.", "name": "media", "type": "object" } ], "returntype": "void", "value": "save media to photo gallery / camera roll
" }, { "filename": "Titanium.Media.showCamera-method", "name": "showCamera", "parameters": [ { "description": "pass a dictionary with the following supported keys: success a function that will be called when the camera is completed, error a function that will be called upon receiving an error, cancel a function that will be called if the user presses the cancel button, autohide boolean if the camera should auto hide after the media capture is completed (defaults to true), animated boolean if the dialog should be animated (defaults to true) upon showing and hiding, saveToPhotoGallery boolean if the media should be saved to the photo gallery upon successful capture, allowEditing boolean if the media should be editable after capture in the UI interface, mediaTypes an array of media type constants supported by the capture device UI, videoMaximumDuration float duration on how long in milliseconds to allow capture before completing, videoQuality constant to indicate the video quality during capture, showControls boolean to indicate if the built-in UI controls should be displayed, overlay view which is added as an overlay to the camera UI (on top), transform an transformation matrix that applies to the camera UI transform.", "name": "options", "type": "object" } ], "returntype": "void", "value": "show the camera
" }, { "filename": "Titanium.Media.showMusicLibrary-method", "name": "showMusicLibrary", "parameters": [ { "description": "pass a dictionary with the following supported keys: success a function that will be called when the camera is completed, error a function that will be called upon receiving an error, cancel a function that will be called if the user presses the cancel button, autohide boolean if the library listing should auto hide after selection is completed (defaults to true), animated boolean if the dialog should be animated (defaults to true) upon showing and hiding, mediaTypes an array of media type constants defining selectable media (see MUSIC_MEDIA_TYPE_* properties below) as either an array or a bitwise-or single value, allowMultipleSelections boolean whether or not more than one media selection is allowed", "name": "options", "type": "object" } ], "returntype": "void", "value": "show the music library. iPhone and iPad only.
" }, { "filename": "Titanium.Media.startMicrophoneMonitor-method", "name": "startMicrophoneMonitor", "parameters": [], "returntype": "void", "value": "start the monitoring of microphone sound level
" }, { "filename": "Titanium.Media.stopMicrophoneMonitor-method", "name": "stopMicrophoneMonitor", "parameters": [], "returntype": "void", "value": "stop the monitoring of microphone sound level
" }, { "filename": "Titanium.Media.takePicture-method", "name": "takePicture", "parameters": [], "returntype": "void", "value": "use the device camera to capture a photo. this must be called after calling showCamera and only when autohide is set to false. this method will cause the media capture device to capture a photo and call the success callback.
" }, { "filename": "Titanium.Media.takeScreenshot-method", "name": "takeScreenshot", "parameters": [ { "description": "function that will be called upon capture. the event property media will contain an image Blob object of the screenshot", "name": "callback", "type": "function" } ], "returntype": "void", "value": "take a screen shot of the visible UI on the device
" }, { "filename": "Titanium.Media.vibrate-method", "name": "vibrate", "parameters": [], "returntype": "void", "value": "play a device vibration
" } ], "notes": null, "objects": [ "Titanium.Media.AudioPlayer", "Titanium.Media.AudioRecorder", "Titanium.Media.Item", "Titanium.Media.MusicPlayer", "Titanium.Media.Sound", "Titanium.Media.VideoPlayer" ], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Media.AUDIO_FILEFORMAT_3GP2-property", "name": "AUDIO_FILEFORMAT_3GP2", "type": "int", "value": "audio file format 3GPP-2
" }, { "filename": "Titanium.Media.AUDIO_FILEFORMAT_3GPP-property", "name": "AUDIO_FILEFORMAT_3GPP", "type": "int", "value": "audio file format 3GPP
" }, { "filename": "Titanium.Media.AUDIO_FILEFORMAT_AIFF-property", "name": "AUDIO_FILEFORMAT_AIFF", "type": "int", "value": "audio file format AIFF
" }, { "filename": "Titanium.Media.AUDIO_FILEFORMAT_AMR-property", "name": "AUDIO_FILEFORMAT_AMR", "type": "int", "value": "audio file format AMR
" }, { "filename": "Titanium.Media.AUDIO_FILEFORMAT_CAF-property", "name": "AUDIO_FILEFORMAT_CAF", "type": "int", "value": "audio file format Apple Compressed Audio Format (CAF)
" }, { "filename": "Titanium.Media.AUDIO_FILEFORMAT_MP3-property", "name": "AUDIO_FILEFORMAT_MP3", "type": "int", "value": "audio file format MP3
" }, { "filename": "Titanium.Media.AUDIO_FILEFORMAT_MP4-property", "name": "AUDIO_FILEFORMAT_MP4", "type": "int", "value": "audio file format MP4
" }, { "filename": "Titanium.Media.AUDIO_FILEFORMAT_MP4A-property", "name": "AUDIO_FILEFORMAT_MP4A", "type": "int", "value": "audio file format MP4A
" }, { "filename": "Titanium.Media.AUDIO_FILEFORMAT_WAVE-property", "name": "AUDIO_FILEFORMAT_WAVE", "type": "int", "value": "audio file format WAVE
" }, { "filename": "Titanium.Media.AUDIO_FORMAT_AAC-property", "name": "AUDIO_FORMAT_AAC", "type": "int", "value": "audio format MPEG4 AAC encoding
" }, { "filename": "Titanium.Media.AUDIO_FORMAT_ALAW-property", "name": "AUDIO_FORMAT_ALAW", "type": "int", "value": "audio format 8-bit aLaw encoding
" }, { "filename": "Titanium.Media.AUDIO_FORMAT_APPLE_LOSSLESS-property", "name": "AUDIO_FORMAT_APPLE_LOSSLESS", "type": "int", "value": "audio format apple lossless encoding
" }, { "filename": "Titanium.Media.AUDIO_FORMAT_ILBC-property", "name": "AUDIO_FORMAT_ILBC", "type": "int", "value": "audio format iLBC encoding
" }, { "filename": "Titanium.Media.AUDIO_FORMAT_IMA4-property", "name": "AUDIO_FORMAT_IMA4", "type": "int", "value": "audio format Apple IMA4 encoding
" }, { "filename": "Titanium.Media.AUDIO_FORMAT_LINEAR_PCM-property", "name": "AUDIO_FORMAT_LINEAR_PCM", "type": "int", "value": "audio format Linear 16-bit, PCM encoding
" }, { "filename": "Titanium.Media.AUDIO_FORMAT_ULAW-property", "name": "AUDIO_FORMAT_ULAW", "type": "int", "value": "audio format 8-bit muLaw encoding
" }, { "filename": "Titanium.Media.AUDIO_HEADPHONES-property", "name": "AUDIO_HEADPHONES", "type": "int", "value": "constant for line type headphones
" }, { "filename": "Titanium.Media.AUDIO_HEADPHONES_AND_MIC-property", "name": "AUDIO_HEADPHONES_AND_MIC", "type": "int", "value": "constant line type headphones and microphone
" }, { "filename": "Titanium.Media.AUDIO_HEADSET_INOUT-property", "name": "AUDIO_HEADSET_INOUT", "type": "int", "value": "constant line type headset in/out
" }, { "filename": "Titanium.Media.AUDIO_LINEOUT-property", "name": "AUDIO_LINEOUT", "type": "int", "value": "constant line type line out
" }, { "filename": "Titanium.Media.AUDIO_MICROPHONE-property", "name": "AUDIO_MICROPHONE", "type": "int", "value": "constant line type microphone
" }, { "filename": "Titanium.Media.AUDIO_MUTED-property", "name": "AUDIO_MUTED", "type": "int", "value": "constant line type muted switch is on
" }, { "filename": "Titanium.Media.AUDIO_RECEIVER_AND_MIC-property", "name": "AUDIO_RECEIVER_AND_MIC", "type": "int", "value": "constant line type receiver and microphone
" }, { "filename": "Titanium.Media.AUDIO_SESSION_MODE_AMBIENT-property", "name": "AUDIO_SESSION_MODE_AMBIENT", "type": "int", "value": "For long-duration sounds such as rain, car engine noise, and so on. It is also for 'play along' style applications, such a virtual piano that a user plays over iPod audio.
" }, { "filename": "Titanium.Media.AUDIO_SESSION_MODE_PLAYBACK-property", "name": "AUDIO_SESSION_MODE_PLAYBACK", "type": "int", "value": "For playing recorded music or other sounds that are central to the successful use of your application. When using this mode, your application audio continues with the Ring/Silent switch set to silent or when the screen locks. This property normally disallows iPod audio to mix with application audio
" }, { "filename": "Titanium.Media.AUDIO_SESSION_MODE_PLAY_AND_RECORD-property", "name": "AUDIO_SESSION_MODE_PLAY_AND_RECORD", "type": "int", "value": "Allows recording (input) and playback (output) of audio, such as for a VOIP (voice over IP) application. This category is appropriate for simultaneous recording and playback, and also for applications that record and play back but not simultaneously. If you want to ensure that sounds such as Messages alerts do not play while your application is recording, use Titanium.Media.AUDIO_SESSION_MODE_RECORD instead. This category normally disallows iPod audio to mix with application audio.
" }, { "filename": "Titanium.Media.AUDIO_SESSION_MODE_RECORD-property", "name": "AUDIO_SESSION_MODE_RECORD", "type": "int", "value": "For recording audio; it silences playback audio.
" }, { "filename": "Titanium.Media.AUDIO_SESSION_MODE_SOLO_AMBIENT-property", "name": "AUDIO_SESSION_MODE_SOLO_AMBIENT", "type": "int", "value": "The solo ambient sound category is for long-duration sounds such as rain, car engine noise, and so on. When you use this category, audio from built-in applications, such as the iPod, is silenced. Your audio is silenced when the Ring/Silent switch is set to silent or when the screen locks.
" }, { "filename": "Titanium.Media.AUDIO_SPEAKER-property", "name": "AUDIO_SPEAKER", "type": "int", "value": "constant line type speaker
" }, { "filename": "Titanium.Media.AUDIO_UNAVAILABLE-property", "name": "AUDIO_UNAVAILABLE", "type": "int", "value": "constant line type unavailable
" }, { "filename": "Titanium.Media.AUDIO_UNKNOWN-property", "name": "AUDIO_UNKNOWN", "type": "int", "value": "constant line type unknown or not determined
" }, { "filename": "Titanium.Media.DEVICE_BUSY-property", "name": "DEVICE_BUSY", "type": "int", "value": "constant for media device busy error
" }, { "filename": "Titanium.Media.MEDIA_TYPE_PHOTO-property", "name": "MEDIA_TYPE_PHOTO", "type": "int", "value": "media type constant to signify photo
" }, { "filename": "Titanium.Media.MEDIA_TYPE_VIDEO-property", "name": "MEDIA_TYPE_VIDEO", "type": "int", "value": "media type constant to signify video
" }, { "filename": "Titanium.Media.MUSIC_MEDIA_TYPE_ALL-property", "name": "MUSIC_MEDIA_TYPE_ALL", "type": "int", "value": "media containing any content
" }, { "filename": "Titanium.Media.MUSIC_MEDIA_TYPE_ANY_AUDIO-property", "name": "MUSIC_MEDIA_TYPE_ANY_AUDIO", "type": "int", "value": "media containing any audio content
" }, { "filename": "Titanium.Media.MUSIC_MEDIA_TYPE_AUDIOBOOK-property", "name": "MUSIC_MEDIA_TYPE_AUDIOBOOK", "type": "int", "value": "media containing audiobook content
" }, { "filename": "Titanium.Media.MUSIC_MEDIA_TYPE_MUSIC-property", "name": "MUSIC_MEDIA_TYPE_MUSIC", "type": "int", "value": "media containing music content
" }, { "filename": "Titanium.Media.MUSIC_MEDIA_TYPE_PODCAST-property", "name": "MUSIC_MEDIA_TYPE_PODCAST", "type": "int", "value": "media containing podcast content
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_REPEAT_ALL-property", "name": "MUSIC_PLAYER_REPEAT_ALL", "type": "int", "value": "constant for repeating all setting
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_REPEAT_DEFAULT-property", "name": "MUSIC_PLAYER_REPEAT_DEFAULT", "type": "int", "value": "constant for user default repeat setting
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_REPEAT_NONE-property", "name": "MUSIC_PLAYER_REPEAT_NONE", "type": "int", "value": "constant for no repeat setting
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_REPEAT_ONE-property", "name": "MUSIC_PLAYER_REPEAT_ONE", "type": "int", "value": "constant for repeating one item setting
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_SHUFFLE_ALBUMS-property", "name": "MUSIC_PLAYER_SHUFFLE_ALBUMS", "type": "int", "value": "constant for shuffling complete albums setting
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_SHUFFLE_DEFAULT-property", "name": "MUSIC_PLAYER_SHUFFLE_DEFAULT", "type": "int", "value": "constant for user default shuffle setting
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_SHUFFLE_NONE-property", "name": "MUSIC_PLAYER_SHUFFLE_NONE", "type": "int", "value": "constant for no shuffle setting
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_SHUFFLE_SONGS-property", "name": "MUSIC_PLAYER_SHUFFLE_SONGS", "type": "int", "value": "constant for shuffling songs setting
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_STATE_INTERRUPTED-property", "name": "MUSIC_PLAYER_STATE_INTERRUPTED", "type": "int", "value": "constant for interrupted state
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_STATE_PAUSED-property", "name": "MUSIC_PLAYER_STATE_PAUSED", "type": "int", "value": "constant for paused state
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_STATE_PLAYING-property", "name": "MUSIC_PLAYER_STATE_PLAYING", "type": "int", "value": "constant for playing state
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_STATE_SEEK_BACKWARD-property", "name": "MUSIC_PLAYER_STATE_SEEK_BACKWARD", "type": "int", "value": "constant for backward seek state
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_STATE_SKEEK_FORWARD-property", "name": "MUSIC_PLAYER_STATE_SKEEK_FORWARD", "type": "int", "value": "constant for forward seek state
" }, { "filename": "Titanium.Media.MUSIC_PLAYER_STATE_STOPPED-property", "name": "MUSIC_PLAYER_STATE_STOPPED", "type": "int", "value": "constant for stopped state
" }, { "filename": "Titanium.Media.NO_CAMERA-property", "name": "NO_CAMERA", "type": "int", "value": "constant for media no camera error
" }, { "filename": "Titanium.Media.NO_VIDEO-property", "name": "NO_VIDEO", "type": "int", "value": "constant for media no video error
" }, { "filename": "Titanium.Media.QUALITY_HIGH-property", "name": "QUALITY_HIGH", "type": "int", "value": "media type constant to use high-quality video recording. Recorded files are suitable for on-device playback and for wired transfer to the Desktop using Image Capture; they are likely to be too large for transfer using Wi-Fi.
" }, { "filename": "Titanium.Media.QUALITY_LOW-property", "name": "QUALITY_LOW", "type": "int", "value": "media type constant to use use low-quality video recording. Recorded files can usually be transferred over the cellular network.
" }, { "filename": "Titanium.Media.QUALITY_MEDIUM-property", "name": "QUALITY_MEDIUM", "type": "int", "value": "media type constant to use medium-quality video recording. Recorded files can usually be transferred using Wi-Fi. This is the default video quality setting.
" }, { "filename": "Titanium.Media.UNKNOWN_ERROR-property", "name": "UNKNOWN_ERROR", "type": "int", "value": "constant for unknown media error
" }, { "filename": "Titanium.Media.VIDEO_CONTROL_DEFAULT-property", "name": "VIDEO_CONTROL_DEFAULT", "type": "int", "value": "constant for video controls default
" }, { "filename": "Titanium.Media.VIDEO_CONTROL_EMBEDDED-property", "name": "VIDEO_CONTROL_EMBEDDED", "type": "int", "value": "Controls for an embedded view. Used in conjunction with movieControlStyle property of Titanium.Media.VideoPlayer in iPhone 3.2+
" }, { "filename": "Titanium.Media.VIDEO_CONTROL_FULLSCREEN-property", "name": "VIDEO_CONTROL_FULLSCREEN", "type": "int", "value": "Controls for fullscreen. Used in conjunction with movieControlStyle property of Titanium.Media.VideoPlayer in iPhone 3.2+
" }, { "filename": "Titanium.Media.VIDEO_CONTROL_HIDDEN-property", "name": "VIDEO_CONTROL_HIDDEN", "type": "int", "value": "constant for video controls hidden
" }, { "filename": "Titanium.Media.VIDEO_CONTROL_NONE-property", "name": "VIDEO_CONTROL_NONE", "type": "int", "value": "No controls. Used in conjunction with movieControlStyle property of Titanium.Media.VideoPlayer in iPhone 3.2+
" }, { "filename": "Titanium.Media.VIDEO_CONTROL_VOLUME_ONLY-property", "name": "VIDEO_CONTROL_VOLUME_ONLY", "type": "int", "value": "constant for video controls volume only
" }, { "filename": "Titanium.Media.VIDEO_FINISH_REASON_PLAYBACK_ENDED-property", "name": "VIDEO_FINISH_REASON_PLAYBACK_ENDED", "type": "int", "value": "the video playback ended normally
" }, { "filename": "Titanium.Media.VIDEO_FINISH_REASON_PLAYBACK_ERROR-property", "name": "VIDEO_FINISH_REASON_PLAYBACK_ERROR", "type": "int", "value": "the video playback ended abnormally
" }, { "filename": "Titanium.Media.VIDEO_FINISH_REASON_USER_EXITED-property", "name": "VIDEO_FINISH_REASON_USER_EXITED", "type": "int", "value": "the video playback ended by user action (such as clicking the Done button)
" }, { "filename": "Titanium.Media.VIDEO_LOAD_STATE_PLAYABLE-property", "name": "VIDEO_LOAD_STATE_PLAYABLE", "type": "int", "value": "the current media is playable
" }, { "filename": "Titanium.Media.VIDEO_LOAD_STATE_PLAYTHROUGH_OK-property", "name": "VIDEO_LOAD_STATE_PLAYTHROUGH_OK", "type": "int", "value": "playback will be automatically started in this state when autoplay is true
" }, { "filename": "Titanium.Media.VIDEO_LOAD_STATE_STALLED-property", "name": "VIDEO_LOAD_STATE_STALLED", "type": "int", "value": "playback will be automatically paused in this state, if started
" }, { "filename": "Titanium.Media.VIDEO_LOAD_STATE_UNKNOWN-property", "name": "VIDEO_LOAD_STATE_UNKNOWN", "type": "int", "value": "the current load state is not known
" }, { "filename": "Titanium.Media.VIDEO_MEDIA_TYPE_AUDIO-property", "name": "VIDEO_MEDIA_TYPE_AUDIO", "type": "int", "value": "A audio type of media in the movie returned by Titanium.Media.VideoPlayer mediaTypes property
" }, { "filename": "Titanium.Media.VIDEO_MEDIA_TYPE_NONE-property", "name": "VIDEO_MEDIA_TYPE_NONE", "type": "int", "value": "An unknown type of media in the movie returned by Titanium.Media.VideoPlayer mediaTypes property.
" }, { "filename": "Titanium.Media.VIDEO_MEDIA_TYPE_VIDEO-property", "name": "VIDEO_MEDIA_TYPE_VIDEO", "type": "int", "value": "A video type of media in the movie returned by Titanium.Media.VideoPlayer mediaTypes property
" }, { "filename": "Titanium.Media.VIDEO_PLAYBACK_STATE_INTERRUPTED-property", "name": "VIDEO_PLAYBACK_STATE_INTERRUPTED", "type": "int", "value": "playback has been interrupted
" }, { "filename": "Titanium.Media.VIDEO_PLAYBACK_STATE_PAUSED-property", "name": "VIDEO_PLAYBACK_STATE_PAUSED", "type": "int", "value": "playback is paused
" }, { "filename": "Titanium.Media.VIDEO_PLAYBACK_STATE_PLAYING-property", "name": "VIDEO_PLAYBACK_STATE_PLAYING", "type": "int", "value": "playback is playing
" }, { "filename": "Titanium.Media.VIDEO_PLAYBACK_STATE_SEEKING_BACKWARD-property", "name": "VIDEO_PLAYBACK_STATE_SEEKING_BACKWARD", "type": "int", "value": "playback is rewinding
" }, { "filename": "Titanium.Media.VIDEO_PLAYBACK_STATE_SEEKING_FORWARD-property", "name": "VIDEO_PLAYBACK_STATE_SEEKING_FORWARD", "type": "int", "value": "playback is seeking forward
" }, { "filename": "Titanium.Media.VIDEO_PLAYBACK_STATE_STOPPED-property", "name": "VIDEO_PLAYBACK_STATE_STOPPED", "type": "int", "value": "playback has stopped
" }, { "filename": "Titanium.Media.VIDEO_REPEAT_MODE_NONE-property", "name": "VIDEO_REPEAT_MODE_NONE", "type": "int", "value": "the video will not repeat
" }, { "filename": "Titanium.Media.VIDEO_REPEAT_MODE_ONE-property", "name": "VIDEO_REPEAT_MODE_ONE", "type": "int", "value": "the video will repeat once
" }, { "filename": "Titanium.Media.VIDEO_SCALING_ASPECT_FILL-property", "name": "VIDEO_SCALING_ASPECT_FILL", "type": "int", "value": "constant for video aspect where the movie will be scaled until the movie fills the entire screen. Content at the edges of the larger of the two dimensions is clipped so that the other dimension fits the screen exactly. The aspect ratio of the movie is preserved.
" }, { "filename": "Titanium.Media.VIDEO_SCALING_ASPECT_FIT-property", "name": "VIDEO_SCALING_ASPECT_FIT", "type": "int", "value": "constant for video aspect fit where the movie will be scaled until one dimension fits on the screen exactly. In the other dimension, the region between the edge of the movie and the edge of the screen is filled with a black bar. The aspect ratio of the movie is preserved.
" }, { "filename": "Titanium.Media.VIDEO_SCALING_MODE_FILL-property", "name": "VIDEO_SCALING_MODE_FILL", "type": "int", "value": "constant for video aspect where the movie will be scaled until both dimensions fit the screen exactly. The aspect ratio of the movie is not preserved.
" }, { "filename": "Titanium.Media.VIDEO_SCALING_NONE-property", "name": "VIDEO_SCALING_NONE", "type": "int", "value": "constant for video scaling where the scaling is turn off. The movie will not be scaled.
" }, { "filename": "Titanium.Media.VIDEO_SOURCE_TYPE_FILE-property", "name": "VIDEO_SOURCE_TYPE_FILE", "type": "int", "value": "the video source type is a file. Related to the sourceType property of Titanium.Media.VideoPlayer
" }, { "filename": "Titanium.Media.VIDEO_SOURCE_TYPE_STREAMING-property", "name": "VIDEO_SOURCE_TYPE_STREAMING", "type": "int", "value": "the video source type is a remote stream. Related to the sourceType property of Titanium.Media.VideoPlayer
" }, { "filename": "Titanium.Media.VIDEO_SOURCE_TYPE_UNKNOWN-property", "name": "VIDEO_SOURCE_TYPE_UNKNOWN", "type": "int", "value": "the video source type is unknown. Related to the sourceType property of Titanium.Media.VideoPlayer
" }, { "filename": "Titanium.Media.VIDEO_TIME_OPTION_EXACT-property", "name": "VIDEO_TIME_OPTION_EXACT", "type": "int", "value": "use the exact time
" }, { "filename": "Titanium.Media.VIDEO_TIME_OPTION_NEAREST_KEYFRAME-property", "name": "VIDEO_TIME_OPTION_NEAREST_KEYFRAME", "type": "int", "value": "use the closest keyframe in the time
" }, { "filename": "Titanium.Media.appMusicPlayer-property", "name": "appMusicPlayer", "type": "object", "value": "an instance of Titanium.Media.MusicPlayer representing the app-specific music player. iPhone/iPad only
" }, { "filename": "Titanium.Media.audioLineType-property", "name": "audioLineType", "type": "int", "value": "returns the line type constant for the current line type
" }, { "filename": "Titanium.Media.audioPlaying-property", "name": "audioPlaying", "type": "boolean", "value": "returns true if the device is playing audio
" }, { "filename": "Titanium.Media.availableCameraMediaTypes-property", "name": "availableCameraMediaTypes", "type": "array", "value": "return an array of media type constants supported for the camera
" }, { "filename": "Titanium.Media.availablePhotoGalleryMediaTypes-property", "name": "availablePhotoGalleryMediaTypes", "type": "array", "value": "return an array of media type constants supported for saving to the photo gallery
" }, { "filename": "Titanium.Media.availablePhotoMediaTypes-property", "name": "availablePhotoMediaTypes", "type": "array", "value": "return an array of media type constants supported for the photo
" }, { "filename": "Titanium.Media.averageMicrophonePower-property", "name": "averageMicrophonePower", "type": "float", "value": "return the current average microphone level in dB or -1 if microphone monitoring is disabled
" }, { "filename": "Titanium.Media.canRecord-property", "name": "canRecord", "type": "boolean", "value": "returns true if the device has recording input device available
" }, { "filename": "Titanium.Media.defaultAudioSessionMode-property", "name": "defaultAudioSessionMode", "type": "int", "value": "a constant for the default audio session mode to be used. One of Titanium.Media.AUDIO_SESSION_MODE_AMBIENT, Titanium.Media.AUDIO_SESSION_MODE_SOLO_AMBIENT Titanium.Media.AUDIO_SESSION_MODE_PLAYBACK Titanium.Media.AUDIO_SESSION_MODE_RECORD, Titanium.Media.AUDIO_SESSION_MODE_PLAY_AND_RECORD.
" }, { "filename": "Titanium.Media.isCameraSupported-property", "name": "isCameraSupported", "type": "boolean", "value": "returns true if the device has camera support
" }, { "filename": "Titanium.Media.peakMicrophonePower-property", "name": "peakMicrophonePower", "type": "float", "value": "return the current microphone level peak power in dB or -1 if microphone monitoring is disabled
" }, { "filename": "Titanium.Media.systemMusicPlayer-property", "name": "systemMusicPlayer", "type": "object", "value": "an instance of Titanium.Media.MusicPlayer representing the system-wide music player. iPhone/iPad only
" }, { "filename": "Titanium.Media.volume-property", "name": "volume", "type": "float", "value": "the current volume of the playback device
" } ], "returns": "object", "since": "0.1", "subtype": null, "type": "module" }, "Titanium.Media.AudioPlayer": { "deprecated": null, "description": "The AudioPlayer object is returned by Titanium.Media.createAudioPlayer and is used for streaming audio to the device and low-level control of the audio playback.
", "events": [ { "filename": "Titanium.Media.AudioPlayer.change-event", "name": "change", "properties": { "description": "textual description of the state of playback
", "source": "the source object that fired the event", "state": "current state of playback
", "type": "the name of the event fired" }, "value": "fired when the state of the playback changes
" }, { "filename": "Titanium.Media.AudioPlayer.progress-event", "name": "progress", "properties": { "progress": "current progress value
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired once per second with the current progress during playback
" } ], "examples": [], "methods": [ { "filename": "Titanium.Media.AudioPlayer.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Media.AudioPlayer.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Media.AudioPlayer.pause-method", "name": "pause", "parameters": [], "returntype": "void", "value": "pause playback
" }, { "filename": "Titanium.Media.AudioPlayer.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Media.AudioPlayer.setPaused-method", "name": "setPaused", "parameters": [ { "description": "pass true to pause the current playback temporarily, false to unpause it", "name": "paused", "type": "boolean" } ], "returntype": "void", "value": "control the playback of the audio
" }, { "filename": "Titanium.Media.AudioPlayer.setUrl-method", "name": "setUrl", "parameters": [ { "description": "the new url", "name": "url", "type": "string" } ], "returntype": "void", "value": "change the url of the audio playback
" }, { "filename": "Titanium.Media.AudioPlayer.start-method", "name": "start", "parameters": [], "returntype": "void", "value": "start playback
" }, { "filename": "Titanium.Media.AudioPlayer.stateDescription-method", "name": "stateDescription", "parameters": [], "returntype": "string", "value": "convert a state into a textual description suitable for display
" }, { "filename": "Titanium.Media.AudioPlayer.stop-method", "name": "stop", "parameters": [], "returntype": "void", "value": "stop playback
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Media.AudioPlayer.STATE_BUFFERING-property", "name": "STATE_BUFFERING", "type": "int", "value": "current playback is in the buffering from the network state
" }, { "filename": "Titanium.Media.AudioPlayer.STATE_INITIALIZED-property", "name": "STATE_INITIALIZED", "type": "int", "value": "current playback is in the initialization state
" }, { "filename": "Titanium.Media.AudioPlayer.STATE_PAUSED-property", "name": "STATE_PAUSED", "type": "int", "value": "current playback is in the paused state
" }, { "filename": "Titanium.Media.AudioPlayer.STATE_PLAYING-property", "name": "STATE_PLAYING", "type": "int", "value": "current playback is in the playing state
" }, { "filename": "Titanium.Media.AudioPlayer.STATE_STARTING-property", "name": "STATE_STARTING", "type": "int", "value": "current playback is in the starting playback state
" }, { "filename": "Titanium.Media.AudioPlayer.STATE_STOPPED-property", "name": "STATE_STOPPED", "type": "int", "value": "current playback is in the stopped state
" }, { "filename": "Titanium.Media.AudioPlayer.STATE_STOPPING-property", "name": "STATE_STOPPING", "type": "int", "value": "current playback is in the stopping state
" }, { "filename": "Titanium.Media.AudioPlayer.STATE_WAITING_FOR_DATA-property", "name": "STATE_WAITING_FOR_DATA", "type": "int", "value": "current playback is in the waiting for audio data from the network state
" }, { "filename": "Titanium.Media.AudioPlayer.STATE_WAITING_FOR_QUEUE-property", "name": "STATE_WAITING_FOR_QUEUE", "type": "int", "value": "current playback is in the waiting for audio data to fill the queue state
" }, { "filename": "Titanium.Media.AudioPlayer.allowBackground-property", "name": "allowBackground", "type": "boolean", "value": "boolean to indicate if audio should continue playing even if Activity is paused (Android only as of 1.3.0)
" }, { "filename": "Titanium.Media.AudioPlayer.audioSessionMode-property", "name": "audioSessionMode", "type": "int", "value": "the default audio session mode to be used for this player. One of Titanium.Media.AUDIO_SESSION_MODE_AMBIENT, Titanium.Media.AUDIO_SESSION_MODE_SOLO_AMBIENT Titanium.Media.AUDIO_SESSION_MODE_PLAYBACK Titanium.Media.AUDIO_SESSION_MODE_RECORD, Titanium.Media.AUDIO_SESSION_MODE_PLAY_AND_RECORD.
" }, { "filename": "Titanium.Media.AudioPlayer.bitRate-property", "name": "bitRate", "type": "double", "value": "bit rate of the current playback stream
" }, { "filename": "Titanium.Media.AudioPlayer.idle-property", "name": "idle", "type": "boolean", "value": "returns boolean indicating if the playback is idle
" }, { "filename": "Titanium.Media.AudioPlayer.paused-property", "name": "paused", "type": "boolean", "value": "returns boolean indicating if the playback is paused
" }, { "filename": "Titanium.Media.AudioPlayer.playing-property", "name": "playing", "type": "boolean", "value": "returns boolean indicating if the playback is streaming audio
" }, { "filename": "Titanium.Media.AudioPlayer.progress-property", "name": "progress", "type": "double", "value": "returns the current playback progress. Will return zero if sampleRate has not yet been detected
" }, { "filename": "Titanium.Media.AudioPlayer.state-property", "name": "state", "type": "int", "value": "returns int for the current state of playback
" }, { "filename": "Titanium.Media.AudioPlayer.url-property", "name": "url", "type": "string", "value": "returns the url for the current playback
" }, { "filename": "Titanium.Media.AudioPlayer.waiting-property", "name": "waiting", "type": "boolean", "value": "returns boolean indicating if the playback is waiting for audio data from the network
" } ], "returns": null, "since": "0.9", "subtype": "proxy", "type": "object" }, "Titanium.Media.AudioRecorder": { "deprecated": null, "description": "The AudioRecorder object is returned by Titanium.Media.createAudioRecorder and is used for recording audio from the device microphone.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Media.AudioRecorder.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Media.AudioRecorder.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Media.AudioRecorder.pause-method", "name": "pause", "parameters": [], "returntype": "void", "value": "called to temporarily pause recording
" }, { "filename": "Titanium.Media.AudioRecorder.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Media.AudioRecorder.resume-method", "name": "resume", "parameters": [], "returntype": "void", "value": "called to resume audio recording
" }, { "filename": "Titanium.Media.AudioRecorder.start-method", "name": "start", "parameters": [], "returntype": "void", "value": "called to start recording audio
" }, { "filename": "Titanium.Media.AudioRecorder.stop-method", "name": "stop", "parameters": [], "returntype": "void", "value": "called to stop recording audio
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Media.AudioRecorder.audioSessionMode-property", "name": "audioSessionMode", "type": "int", "value": "the default audio session mode to be used for this recorder. One of Titanium.Media.AUDIO_SESSION_MODE_AMBIENT, Titanium.Media.AUDIO_SESSION_MODE_SOLO_AMBIENT Titanium.Media.AUDIO_SESSION_MODE_PLAYBACK Titanium.Media.AUDIO_SESSION_MODE_RECORD, Titanium.Media.AUDIO_SESSION_MODE_PLAY_AND_RECORD.
" }, { "filename": "Titanium.Media.AudioRecorder.compression-property", "name": "compression", "type": "int", "value": "audio compression constant to be used for the recording
" }, { "filename": "Titanium.Media.AudioRecorder.format-property", "name": "format", "type": "int", "value": "audio format constant for used for the recording
" }, { "filename": "Titanium.Media.AudioRecorder.paused-property", "name": "paused", "type": "boolean", "value": "readonly property to indicate if paused
" }, { "filename": "Titanium.Media.AudioRecorder.recording-property", "name": "recording", "type": "boolean", "value": "readonly property to indicate if recording
" }, { "filename": "Titanium.Media.AudioRecorder.stopped-property", "name": "stopped", "type": "boolean", "value": "readonly property to indicate if stopped
" } ], "returns": null, "since": "0.9", "subtype": "proxy", "type": "object" }, "Titanium.Media.Item": { "deprecated": null, "description": "A representation of a media item returned by the music picker as part of the items array in the dictionary passed to its success function.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Media.Item.albumArtist-property", "name": "albumArtist", "type": "string", "value": "the artist for the album of the item
" }, { "filename": "Titanium.Media.Item.albumTitle-property", "name": "albumTitle", "type": "string", "value": "the album title of the item
" }, { "filename": "Titanium.Media.Item.albumTrackCount-property", "name": "albumTrackCount", "type": "int", "value": "the number of tracks for the album of the item
" }, { "filename": "Titanium.Media.Item.albumTrackNumber-property", "name": "albumTrackNumber", "type": "int", "value": "the track number of the item
" }, { "filename": "Titanium.Media.Item.artist-property", "name": "artist", "type": "string", "value": "the artist of the item
" }, { "filename": "Titanium.Media.Item.artwork-property", "name": "artwork", "type": "object", "value": "a blob object containing the image for the item's artwork, or null if none
" }, { "filename": "Titanium.Media.Item.composer-property", "name": "composer", "type": "string", "value": "the composer of the item
" }, { "filename": "Titanium.Media.Item.discCount-property", "name": "discCount", "type": "int", "value": "the total number of discs of the item
" }, { "filename": "Titanium.Media.Item.discNumber-property", "name": "discNumber", "type": "int", "value": "the disc number of the item
" }, { "filename": "Titanium.Media.Item.genre-property", "name": "genre", "type": "string", "value": "the genre of the item
" }, { "filename": "Titanium.Media.Item.isCompilation-property", "name": "isCompilation", "type": "boolean", "value": "true if the item is part of a compilation album
" }, { "filename": "Titanium.Media.Item.lyrics-property", "name": "lyrics", "type": "string", "value": "the lyrics of the item
" }, { "filename": "Titanium.Media.Item.mediaType-property", "name": "mediaType", "type": "int", "value": "the type of the item
" }, { "filename": "Titanium.Media.Item.playCount-property", "name": "playCount", "type": "int", "value": "the number of times the item has been played
" }, { "filename": "Titanium.Media.Item.playbackDuration-property", "name": "playbackDuration", "type": "double", "value": "the length (in seconds) of the item
" }, { "filename": "Titanium.Media.Item.podcastTitle-property", "name": "podcastTitle", "type": "string", "value": "the title of a podcast item. Only for media types of Titanium.Media.MUSIC_MEDIA_TYPE_PODCAST.
" }, { "filename": "Titanium.Media.Item.rating-property", "name": "rating", "type": "int", "value": "the rating of the item
" }, { "filename": "Titanium.Media.Item.skipCount-property", "name": "skipCount", "type": "int", "value": "the number of times the item has been skipped
" }, { "filename": "Titanium.Media.Item.title-property", "name": "title", "type": "string", "value": "the title of the item
" } ], "returns": null, "since": "1.4.0", "subtype": null, "type": "object" }, "Titanium.Media.MusicPlayer": { "deprecated": null, "description": "The MusicPlayer instance returned from Titanium.Media.createMusicPlayer. This object represents a music controller.
", "events": [ { "filename": "Titanium.Media.MusicPlayer.playingChange-event", "name": "playingChange", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "the currently playing media changed
" }, { "filename": "Titanium.Media.MusicPlayer.stateChange-event", "name": "stateChange", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "the playback state changed
" }, { "filename": "Titanium.Media.MusicPlayer.volumeChange-event", "name": "volumeChange", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "the volume changed
" } ], "examples": [], "methods": [ { "filename": "Titanium.Media.MusicPlayer.pause-method", "name": "pause", "parameters": [], "returntype": "void", "value": "pause playback
" }, { "filename": "Titanium.Media.MusicPlayer.play-method", "name": "play", "parameters": [], "returntype": "void", "value": "begin playback
" }, { "filename": "Titanium.Media.MusicPlayer.seekBackward-method", "name": "seekBackward", "parameters": [], "returntype": "void", "value": "seek backward in the currently playing media
" }, { "filename": "Titanium.Media.MusicPlayer.seekForward-method", "name": "seekForward", "parameters": [], "returntype": "void", "value": "seek forward in the currently playing media
" }, { "filename": "Titanium.Media.MusicPlayer.setQueue-method", "name": "setQueue", "parameters": [ { "description": "a queue representation to set the player queue to. Can be any of: A dictionary with an items key that is an array of Titanium.Media.Item objects, an array of Titanium.Media.Item objects, or a single Titanium.Media.Item object.", "name": "queue", "type": "object" } ], "returntype": "void", "value": "set the media queue
" }, { "filename": "Titanium.Media.MusicPlayer.skipToBeginning-method", "name": "skipToBeginning", "parameters": [], "returntype": "void", "value": "skip to the beginning of the currently playing media
" }, { "filename": "Titanium.Media.MusicPlayer.skipToNext-method", "name": "skipToNext", "parameters": [], "returntype": "void", "value": "skip to the next media in the queue
" }, { "filename": "Titanium.Media.MusicPlayer.skipToPrevious-method", "name": "skipToPrevious", "parameters": [], "returntype": "void", "value": "skip to the previous media in the queue
" }, { "filename": "Titanium.Media.MusicPlayer.stop-method", "name": "stop", "parameters": [], "returntype": "void", "value": "stop playback
" }, { "filename": "Titanium.Media.MusicPlayer.stopSeeking-method", "name": "stopSeeking", "parameters": [], "returntype": "void", "value": "end a seek operation
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Media.MusicPlayer.currentPlaybackTime-property", "name": "currentPlaybackTime", "type": "double", "value": "the current point in song playback
" }, { "filename": "Titanium.Media.MusicPlayer.nowPlaying-property", "name": "nowPlaying", "type": "object", "value": "an Item object which indicates the currently playing media
" }, { "filename": "Titanium.Media.MusicPlayer.playbackState-property", "name": "playbackState", "type": "int", "value": "the playback state; one of Titanium.Media.MUSIC_PLAYER_STATE_STOPPED, Titanium.Media.MUSIC_PLAYER_STATE_PLAYING, Titanium.Media.MUSIC_PLAYER_STATE_PAUSED, Titanium.Media.MUSIC_PLAYER_STATE_INTERRUPTED, Titanium.Media.MUSIC_PLAYER_STATE_SKEEK_FORWARD, Titanium.Media.MUSIC_PLAYER_STATE_SEEK_BACKWARD
" }, { "filename": "Titanium.Media.MusicPlayer.repeatMode-property", "name": "repeatMode", "type": "int", "value": "the repeat setting; one of Titanium.Media.MUSIC_PLAYER_REPEAT_DEFAULT, Titanium.Media.MUSIC_PLAYER_REPEAT_NONE, Titanium.Media.MUSIC_PLAYER_REPEAT_ONE, Titanium.Media.MUSIC_PLAYER_REPEAT_ALL
" }, { "filename": "Titanium.Media.MusicPlayer.shuffleMode-property", "name": "shuffleMode", "type": "int", "value": "the shuffle setting; one of Titanium.Media.MUSIC_PLAYER_SHUFFLE_DEFAULT, Titanium.Media.MUSIC_PLAYER_SHUFFLE_NONE, Titanium.Media.MUSIC_PLAYER_SHUFFLE_SONGS, Titanium.Media.MUSIC_PLAYER_SHUFFLE_ALBUMS
" }, { "filename": "Titanium.Media.MusicPlayer.volume-property", "name": "volume", "type": "float", "value": "a value between 0.0 and 1.0 indicating the volume level for the music player
" } ], "returns": null, "since": "1.4.0", "subtype": null, "type": "object" }, "Titanium.Media.Sound": { "deprecated": null, "description": "The Sound object is returned by Titanium.Media.createSound and is useful for playing basic sounds. The Sound object loads the entire media resource in memory before playing. If you need to support streaming, use the Titanium.Media.createAudioPlayer API.
", "events": [ { "filename": "Titanium.Media.Sound.complete-event", "name": "complete", "properties": { "source": "the source object that fired the event", "success": "boolean to indicate if the sound was successfully played
", "type": "the name of the event fired" }, "value": "fired when the audio has completed
" }, { "filename": "Titanium.Media.Sound.error-event", "name": "error", "properties": { "message": "error message
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "called when an error is received playing the audio.
" }, { "filename": "Titanium.Media.Sound.interrupted-event", "name": "interrupted", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "called when the audio is interrupted by the device. this is typically called during an interruption due to an incoming phone call.
" }, { "filename": "Titanium.Media.Sound.resume-event", "name": "resume", "properties": { "interruption": "boolean to indicate if the resume was from an interruption
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "called when the audio is resumed after an interruption.
" } ], "examples": [ { "code": "Simple example of playing a WAVE file from the Resources directory.
\nvar player = Ti.UI.createSound({url:\"sound.wav\"});\nplayer.play();\nreturn the current time position of the audio
" }, { "filename": "Titanium.Media.Sound.getVolume-method", "name": "getVolume", "parameters": [], "returntype": "float", "value": "return the value of the audio
" }, { "filename": "Titanium.Media.Sound.isLooping-method", "name": "isLooping", "parameters": [], "returntype": "boolean", "value": "returns true if the audio will loop
" }, { "filename": "Titanium.Media.Sound.isPaused-method", "name": "isPaused", "parameters": [], "returntype": "boolean", "value": "returns true if the audio is paused
" }, { "filename": "Titanium.Media.Sound.isPlaying-method", "name": "isPlaying", "parameters": [], "returntype": "boolean", "value": "returns true if the audio is playing
" }, { "filename": "Titanium.Media.Sound.pause-method", "name": "pause", "parameters": [], "returntype": "void", "value": "temporarily pause the audio. to resume, invoke play.
" }, { "filename": "Titanium.Media.Sound.play-method", "name": "play", "parameters": [], "returntype": "void", "value": "starting playing the source. if paused, will resume.
" }, { "filename": "Titanium.Media.Sound.release-method", "name": "release", "parameters": [], "returntype": "void", "value": "release all internal resources. this is typically unnecessary but can be useful if you load a large audio file in app.js and play it only once and you would like to release all releases after your final play to reduce memory.
" }, { "filename": "Titanium.Media.Sound.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Media.Sound.reset-method", "name": "reset", "parameters": [], "returntype": "void", "value": "reset the audio to the beginning.
" }, { "filename": "Titanium.Media.Sound.setLooping-method", "name": "setLooping", "parameters": [], "returntype": "void", "value": "control whether the audio should loop
" }, { "filename": "Titanium.Media.Sound.setPaused-method", "name": "setPaused", "parameters": [], "returntype": "void", "value": "control whether the audio is paused
" }, { "filename": "Titanium.Media.Sound.setTime-method", "name": "setTime", "parameters": [], "returntype": "void", "value": "set the time position of the audio
" }, { "filename": "Titanium.Media.Sound.setVolume-method", "name": "setVolume", "parameters": [], "returntype": "void", "value": "set the volume of the audio
" }, { "filename": "Titanium.Media.Sound.stop-method", "name": "stop", "parameters": [], "returntype": "void", "value": "stop playing the audio and reset it to the beginning.
" } ], "notes": "You can pass the property preload in the constructor as an object property to cause the audio to be preloaded before play is invoked. For larger audio files, this is recommended if you want the audio to begin immediately when invoking play.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Media.Sound.allowBackground-property", "name": "allowBackground", "type": "boolean", "value": "boolean to indicate if audio should continue playing even if Activity is paused (Android only as of 1.3.0)
" }, { "filename": "Titanium.Media.Sound.audioSessionMode-property", "name": "audioSessionMode", "type": "int", "value": "the default audio session mode to be used for this player. One of Titanium.Media.AUDIO_SESSION_MODE_AMBIENT, Titanium.Media.AUDIO_SESSION_MODE_SOLO_AMBIENT Titanium.Media.AUDIO_SESSION_MODE_PLAYBACK Titanium.Media.AUDIO_SESSION_MODE_RECORD, Titanium.Media.AUDIO_SESSION_MODE_PLAY_AND_RECORD.
" }, { "filename": "Titanium.Media.Sound.duration-property", "name": "duration", "type": "float", "value": "the duration of the audio.
" }, { "filename": "Titanium.Media.Sound.looping-property", "name": "looping", "type": "boolean", "value": "boolean to indicate if the audio should loop upon completion
" }, { "filename": "Titanium.Media.Sound.paused-property", "name": "paused", "type": "boolean", "value": "boolean to indicate if the audio is paused
" }, { "filename": "Titanium.Media.Sound.playing-property", "name": "playing", "type": "boolean", "value": "boolean to indicate if the audio is playing
" }, { "filename": "Titanium.Media.Sound.time-property", "name": "time", "type": "float", "value": "the time position of the audio.
" }, { "filename": "Titanium.Media.Sound.url-property", "name": "url", "type": "string", "value": "url to the audio
" }, { "filename": "Titanium.Media.Sound.volume-property", "name": "volume", "type": "float", "value": "the volume of the audio. this volume only affects the media, not the device audio.
" } ], "returns": null, "since": "0.8", "subtype": "proxy", "type": "object" }, "Titanium.Media.VideoPlayer": { "deprecated": null, "description": "The VideoPlayer object is returned by Titanium.Media.createVideoPlayer and is useful for playing videos.
", "events": [ { "filename": "Titanium.Media.VideoPlayer.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.Media.VideoPlayer.complete-event", "name": "complete", "properties": { "reason": "the completion reason. One of Titanium.Media.VIDEO_FINISH_REASON_PLAYBACK_ENDED, Titanium.Media.VIDEO_FINISH_REASON_PLAYBACK_ERROR or Titanium.Media.VIDEO_FINISH_REASON_USER_EXITED.
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when movie playback ends or a user exits playback
" }, { "filename": "Titanium.Media.VideoPlayer.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.Media.VideoPlayer.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.Media.VideoPlayer.durationAvailable-event", "name": "durationAvailable", "properties": { "duration": "duration
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the duration is available
" }, { "filename": "Titanium.Media.VideoPlayer.error-event", "name": "error", "properties": { "message": "reason for error as string
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when movie playback encounters an error
" }, { "filename": "Titanium.Media.VideoPlayer.fullscreen-event", "name": "fullscreen", "properties": { "entering": "true to indicate entering fullscreen, false to indicate leaving fullscreen
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when a movie changes from fullscreen view
" }, { "filename": "Titanium.Media.VideoPlayer.load-event", "name": "load", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the movie play loads
" }, { "filename": "Titanium.Media.VideoPlayer.loadstate-event", "name": "loadstate", "properties": { "loadState": "loadState
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the network loadState changes
" }, { "filename": "Titanium.Media.VideoPlayer.mediaTypesAvailable-event", "name": "mediaTypesAvailable", "properties": { "mediaTypes": "media types
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the media types is available
" }, { "filename": "Titanium.Media.VideoPlayer.naturalSizeAvailable-event", "name": "naturalSizeAvailable", "properties": { "naturalSize": "natural size as a dictionary. see naturalSize property.
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the natural size is available
" }, { "filename": "Titanium.Media.VideoPlayer.playbackState-event", "name": "playbackState", "properties": { "playbackState": "playbackState
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the playbackState changes
" }, { "filename": "Titanium.Media.VideoPlayer.playing-event", "name": "playing", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "url": "url of the media
" }, "value": "fired when the currently playing movie changes
" }, { "filename": "Titanium.Media.VideoPlayer.preload-event", "name": "preload", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the movie has preloaded and is ready to play
" }, { "filename": "Titanium.Media.VideoPlayer.resize-event", "name": "resize", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the movie player is resized
" }, { "filename": "Titanium.Media.VideoPlayer.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.Media.VideoPlayer.sourceChange-event", "name": "sourceChange", "properties": { "source": "the source object that fired the event", "sourceChange": "the new sourceType
", "type": "the name of the event fired" }, "value": "fired when the movieSourceType is Titanium.Media.VIDEO_SOURCE_TYPE_UNKNOWN when preparing for playback.
" }, { "filename": "Titanium.Media.VideoPlayer.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.Media.VideoPlayer.thumbnail-event", "name": "thumbnail", "properties": { "error": "if success is false, error message as string for reason
", "image": "blob of the thumbnail image
", "source": "the source object that fired the event", "success": "boolean to indicate success or failure
", "time": "time
", "type": "the name of the event fired" }, "value": "fired when a movie thumbnail is available from requestThumbnailImagesAtTimes
" }, { "filename": "Titanium.Media.VideoPlayer.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.Media.VideoPlayer.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.Media.VideoPlayer.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.Media.VideoPlayer.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.Media.VideoPlayer.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [], "methods": [ { "filename": "Titanium.Media.VideoPlayer.add-method", "name": "add", "parameters": [ { "description": "the view to add to this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "add a child to the view hierarchy" }, { "filename": "Titanium.Media.VideoPlayer.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Media.VideoPlayer.animate-method", "name": "animate", "parameters": [ { "description": "either a dictionary of animation properties or an Animation object", "name": "obj", "type": "object" }, { "description": "function to be invoked upon completion of the animation", "name": "callback", "type": "function" } ], "returntype": "void", "value": "animate the view" }, { "filename": "Titanium.Media.VideoPlayer.cancelAllThumbnailImageRequests-method", "name": "cancelAllThumbnailImageRequests", "parameters": [], "returntype": "void", "value": "Cancels all pending asynchronous thumbnail requests.
" }, { "filename": "Titanium.Media.VideoPlayer.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Media.VideoPlayer.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.Media.VideoPlayer.play-method", "name": "play", "parameters": [], "returntype": "void", "value": "start playing the video
" }, { "filename": "Titanium.Media.VideoPlayer.release-method", "name": "release", "parameters": [], "returntype": "void", "value": "release the internal video resources immediately. this is not usually necessary but can help if you no longer need to use the player after it is used to help converse memory.
" }, { "filename": "Titanium.Media.VideoPlayer.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.Media.VideoPlayer.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Media.VideoPlayer.requestThumbnailImagesAtTimes-method", "name": "requestThumbnailImagesAtTimes", "parameters": [ { "description": "array of doubles for each time to request", "name": "times", "type": "array" }, { "description": "either [[Titanium.Media.VIDEO_TIME_OPTION_NEAREST_KEYFRAME]] or [[Titanium.Media.VIDEO_TIME_OPTION_EXACT]].", "name": "option", "type": "int" } ], "returntype": "void", "value": "Asynchronously request thumbnails for one or more times, provided as an array of numbers (double). Fires a thumbnail event on completion. Optionally invokes the callback function passed in the method.
" }, { "filename": "Titanium.Media.VideoPlayer.setBackgroundView-method", "name": "setBackgroundView", "parameters": [ { "description": "view to set", "name": "view", "type": "object" } ], "returntype": "void", "value": "A view for customization which is always displayed behind movie content.
" }, { "filename": "Titanium.Media.VideoPlayer.setMedia-method", "name": "setMedia", "parameters": [ { "description": "media to play", "name": "media", "type": "object" } ], "returntype": "void", "value": "the a non-url based media to play, either a File or Blob.
" }, { "filename": "Titanium.Media.VideoPlayer.setUrl-method", "name": "setUrl", "parameters": [ { "description": "the url to play", "name": "url", "type": "string" } ], "returntype": "void", "value": "the url to play
" }, { "filename": "Titanium.Media.VideoPlayer.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.Media.VideoPlayer.stop-method", "name": "stop", "parameters": [], "returntype": "void", "value": "stop playing the video
" }, { "filename": "Titanium.Media.VideoPlayer.thumbnailImageAtTime-method", "name": "thumbnailImageAtTime", "parameters": [ { "description": "playback time", "name": "time", "type": "double" }, { "description": "either [[Titanium.Media.VIDEO_TIME_OPTION_NEAREST_KEYFRAME]] or [[Titanium.Media.VIDEO_TIME_OPTION_EXACT]]", "name": "option", "type": "int" } ], "returntype": "object", "value": "Returns a thumbnail at the given time as a blob.
" }, { "filename": "Titanium.Media.VideoPlayer.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "Starting in iPhone 3.2 SDK, the video player can be embedded in any normal view. However, if you create multiple video players at one time, only the last one to have its URL set will display video content or behave as if it is a view for a video player. Prior to 3.2, only fullscreen views were available on iPhone.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Media.VideoPlayer.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.Media.VideoPlayer.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.Media.VideoPlayer.autoplay-property", "name": "autoplay", "type": "boolean", "value": "indicates if a movie should automatically start playback when it is likely to finish uninterrupted based on e.g. network conditions. Defaults to true.
" }, { "filename": "Titanium.Media.VideoPlayer.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "background color for the view. deprecated, set the background color on the view.
" }, { "filename": "Titanium.Media.VideoPlayer.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.Media.VideoPlayer.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.Media.VideoPlayer.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.Media.VideoPlayer.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.Media.VideoPlayer.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.Media.VideoPlayer.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.Media.VideoPlayer.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.Media.VideoPlayer.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.Media.VideoPlayer.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.Media.VideoPlayer.contentURL-property", "name": "contentURL", "type": "string", "value": "deprecated. use url property instead.
" }, { "filename": "Titanium.Media.VideoPlayer.duration-property", "name": "duration", "type": "double", "value": "The duration of the movie, or 0.0 if not known.
" }, { "filename": "Titanium.Media.VideoPlayer.endPlaybackTime-property", "name": "endPlaybackTime", "type": "double", "value": "The end time of movie playback. Defaults to NaN, which indicates natural end time of the movie.
" }, { "filename": "Titanium.Media.VideoPlayer.fullscreen-property", "name": "fullscreen", "type": "boolean", "value": "Determines if the movie is presented in the entire screen (obscuring all other application content). Default is false. Setting this property to true before the movie player's view is visible will have no effect.
" }, { "filename": "Titanium.Media.VideoPlayer.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.Media.VideoPlayer.initialPlaybackTime-property", "name": "initialPlaybackTime", "type": "double", "value": "The start time of movie playback. Defaults to NaN, indicating the natural start time of the movie.
" }, { "filename": "Titanium.Media.VideoPlayer.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.Media.VideoPlayer.loadState-property", "name": "loadState", "type": "int", "value": "Returns the network load state of the movie player.
" }, { "filename": "Titanium.Media.VideoPlayer.media-property", "name": "media", "type": "object", "value": "the media object, either a File or Blob.
" }, { "filename": "Titanium.Media.VideoPlayer.mediaControlStyle-property", "name": "mediaControlStyle", "type": "int", "value": "The style of the playback controls. Defaults to Titanium.Media.VIDEO_CONTROL_DEFAULT
" }, { "filename": "Titanium.Media.VideoPlayer.mediaTypes-property", "name": "mediaTypes", "type": "int", "value": "The types of media in the movie, or Titanium.Media.VIDEO_MEDIA_TYPE_NONE if not known.
" }, { "filename": "Titanium.Media.VideoPlayer.movieControlMode-property", "name": "movieControlMode", "type": "int", "value": "deprecated in 3.2+ of the iPhone SDK - use mediaControlStyle. Provides the ability to set the control mode of the movie player. Defaults to Titanium.Media.VIDEO_CONTROL_DEFAULT.
" }, { "filename": "Titanium.Media.VideoPlayer.naturalSize-property", "name": "naturalSize", "type": "object", "value": "returns a dictionary with properties width and height. Returns the natural size of the movie or 0 for both properties if not known or applicable.
" }, { "filename": "Titanium.Media.VideoPlayer.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.Media.VideoPlayer.playableDuration-property", "name": "playableDuration", "type": "double", "value": "The currently playable duration of the movie, for progressively downloaded network content.
" }, { "filename": "Titanium.Media.VideoPlayer.playbackState-property", "name": "playbackState", "type": "int", "value": "Returns the current playback state of the music player
" }, { "filename": "Titanium.Media.VideoPlayer.playing-property", "name": "playing", "type": "boolean", "value": "Boolean to indicate if the player has started playing.
" }, { "filename": "Titanium.Media.VideoPlayer.repeatMode-property", "name": "repeatMode", "type": "int", "value": "Determines how the movie player repeats when reaching the end of playback. Defaults to Titanium.Media.VIDEO_REPEAT_MODE_NONE.
" }, { "filename": "Titanium.Media.VideoPlayer.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.Media.VideoPlayer.scalingMode-property", "name": "scalingMode", "type": "int", "value": "Determines how the content scales to fit the view. Defaults to Titanium.Media.VIDEO_SCALING_ASPECT_FIT.
" }, { "filename": "Titanium.Media.VideoPlayer.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.Media.VideoPlayer.sourceType-property", "name": "sourceType", "type": "int", "value": "The playback type of the movie. Defaults to Titanium.Media.VIDEO_SOURCE_TYPE_UNKNOWN. Specifying a playback type before playing the movie can result in faster load times.
" }, { "filename": "Titanium.Media.VideoPlayer.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.Media.VideoPlayer.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.Media.VideoPlayer.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.Media.VideoPlayer.url-property", "name": "url", "type": "string", "value": "url of the media.
" }, { "filename": "Titanium.Media.VideoPlayer.useApplicationAudioSession-property", "name": "useApplicationAudioSession", "type": "boolean", "value": "Indicates if the movie player should inherit the application's audio session instead of creating a new session (which would interrupt the application's session). Defaults to true. Setting this property during playback will not take effect until playback is stopped and started again.
" }, { "filename": "Titanium.Media.VideoPlayer.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.Media.VideoPlayer.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.Media.VideoPlayer.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.9", "subtype": "view", "type": "object" }, "Titanium.Network": { "deprecated": null, "description": "The top level Network module. The Network module is used accessing Networking related functionality.
", "events": [ { "filename": "Titanium.Network.change-event", "name": "change", "properties": { "networkType": "the new network type
", "networkTypeName": "the new network type as a string
", "online": "boolean to indicate if the network is online
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired upon a network connectivity change
" } ], "examples": [], "methods": [ { "filename": "Titanium.Network.addConnectivityListener-method", "name": "addConnectivityListener", "parameters": [ { "description": "callback function to invoke upon network connectivity changes", "name": "callback", "type": "function" } ], "returntype": "void", "value": "adds a connectivity listener to listen for network changes. This method has been deprecated in favor of listening for a change event.
" }, { "filename": "Titanium.Network.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Network.createBonjourBrowser-method", "name": "createBonjourBrowser", "parameters": [ { "description": "service to search for, must include the protocol type suffix (._tcp)", "name": "serviceType", "type": "string" }, { "description": "the Bonjour service domain to conduct the search in. Default value is 'local.'", "name": "domain", "type": "string" }, { "description": "(optional) a dictionary object properties defined in Titanium.Network.BonjourBrowser", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Network.BonjourBrowser" }, { "filename": "Titanium.Network.createBonjourService-method", "name": "createBonjourService", "parameters": [ { "description": "the name of the service. Must be a unique identifier for this service type and domain.", "name": "name", "type": "string" }, { "description": "the type of service. Must include the protocol identifier (._tcp)", "name": "type", "type": "string" }, { "description": "the domain to publish the service in. Default value is 'local.'", "name": "domain", "type": "string" }, { "description": "(optional) a dictionary object properties defined in Titanium.Network.BonjourService", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Network.BonjourService" }, { "filename": "Titanium.Network.createHTTPClient-method", "name": "createHTTPClient", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.Network.HTTPClient", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Network.HTTPClient" }, { "filename": "Titanium.Network.createTCPSocket-method", "name": "createTCPSocket", "parameters": [ { "description": "the host name to connect to/listen on", "name": "hostName", "type": "string" }, { "description": "the port for the socket", "name": "port", "type": "int" }, { "description": "the socket's mode; one of Titanium.Network.READ_MODE, Titanium.Network.WRITE_MODE, Titanium.Network.READ_WRITE_MODE", "name": "mode", "type": "int" }, { "description": "(optional) a dictionary object properties defined in Titanium.Network.TCPSocket", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.Network.TCPSocket" }, { "filename": "Titanium.Network.decodeURIComponent-method", "name": "decodeURIComponent", "parameters": [ { "description": "input value to be decoded", "name": "value", "type": "string" } ], "returntype": "string", "value": "decode a URI component part using URI encoding
" }, { "filename": "Titanium.Network.encodeURIComponent-method", "name": "encodeURIComponent", "parameters": [ { "description": "input value to be encoded", "name": "value", "type": "string" } ], "returntype": "string", "value": "encode a URI component part using URI encoding
" }, { "filename": "Titanium.Network.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Network.registerForPushNotifications-method", "name": "registerForPushNotifications", "parameters": [ { "description": "dictionary of the following: types is an array of type constants that the application would like to receive, success is a callback function that is called when the push registration is successfully completed, error is a callback function that is called when an error is received during registration and callback is a callback function that is invoked upon receiving a new push notification. This method should be called at application startup.", "name": "config", "type": "object" } ], "returntype": "void", "value": "register for push notifications with the Apple Push Notification Service. Only available on iPhone.
" }, { "filename": "Titanium.Network.removeConnectivityListener-method", "name": "removeConnectivityListener", "parameters": [ { "description": "callback function to remove", "name": "callback", "type": "function" } ], "returntype": "void", "value": "removes a connectivity listener. This method has been deprecated in favor of listening for a change event.
" }, { "filename": "Titanium.Network.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [ "Titanium.Network.BonjourBrowser", "Titanium.Network.BonjourService", "Titanium.Network.HTTPClient", "Titanium.Network.TCPSocket" ], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Network.INADDR_ANY-property", "name": "INADDR_ANY", "type": "string", "value": "constant value representing the ability for sockets to listen on any locally available network device
" }, { "filename": "Titanium.Network.NETWORK_LAN-property", "name": "NETWORK_LAN", "type": "int", "value": "constant value to indicate that the network is LAN
" }, { "filename": "Titanium.Network.NETWORK_MOBILE-property", "name": "NETWORK_MOBILE", "type": "int", "value": "constant value to indicate that the network is MOBILE
" }, { "filename": "Titanium.Network.NETWORK_NONE-property", "name": "NETWORK_NONE", "type": "int", "value": "constant value to indicate that the network is not available
" }, { "filename": "Titanium.Network.NETWORK_UNKNOWN-property", "name": "NETWORK_UNKNOWN", "type": "int", "value": "constant value to indicate that the network is not known
" }, { "filename": "Titanium.Network.NETWORK_WIFI-property", "name": "NETWORK_WIFI", "type": "int", "value": "constant value to indicate that the network is WIFI
" }, { "filename": "Titanium.Network.NOTIFICATION_TYPE_ALERT-property", "name": "NOTIFICATION_TYPE_ALERT", "type": "int", "value": "constant value for the push notification alert type
" }, { "filename": "Titanium.Network.NOTIFICATION_TYPE_BADGE-property", "name": "NOTIFICATION_TYPE_BADGE", "type": "int", "value": "constant value for the push notification badge type
" }, { "filename": "Titanium.Network.NOTIFICATION_TYPE_SOUND-property", "name": "NOTIFICATION_TYPE_SOUND", "type": "int", "value": "constant value for the push notification sound type
" }, { "filename": "Titanium.Network.READ_MODE-property", "name": "READ_MODE", "type": "int", "value": "constant value specifying read-only mode for sockets
" }, { "filename": "Titanium.Network.READ_WRITE_MODE-property", "name": "READ_WRITE_MODE", "type": "int", "value": "constant value specifying read-write mode for sockets
" }, { "filename": "Titanium.Network.WRITE_MODE-property", "name": "WRITE_MODE", "type": "int", "value": "constant value specifying write-only mode for sockets
" }, { "filename": "Titanium.Network.networkType-property", "name": "networkType", "type": "int", "value": "the network type value as a constant.
" }, { "filename": "Titanium.Network.networkTypeName-property", "name": "networkTypeName", "type": "string", "value": "the network type name constant. Returns one of NONE, WIFI, LAN or MOBILE.
" }, { "filename": "Titanium.Network.online-property", "name": "online", "type": "boolean", "value": "readonly boolean value that indicates if the network is reachable to the Internet either via WIFI or Carrier network
" }, { "filename": "Titanium.Network.remoteDeviceUUID-property", "name": "remoteDeviceUUID", "type": "string", "value": "the remote device UUID if the device was registered with the Apple Push Notification Service or null if not set. Only available on iPhone.
" }, { "filename": "Titanium.Network.remoteNotificationTypes-property", "name": "remoteNotificationTypes", "type": "array", "value": "returns an array of network type constants enabled for the application. Only available on iPhone.
" }, { "filename": "Titanium.Network.remoteNotificationsEnabled-property", "name": "remoteNotificationsEnabled", "type": "boolean", "value": "returns true if remote notifications have been enabled. Only available on iPhone.
" } ], "returns": null, "since": "0.1", "subtype": null, "type": "module" }, "Titanium.Network.BonjourBrowser": { "deprecated": null, "description": "The BonjourBrowser instance returned from Titanium.Network.createBonjourBrowser. This object is a browser for the discovery and retrieval of Bonjour services available on the network.
\n
updatedServices
" }, { "filename": "Titanium.Network.BonjourBrowser.services-event", "name": "services", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "An array of BonjourService objects corresponding to currently available services. If you cache this value, including using it as table data, be aware that it could become out of date at any time due to the asynchronous nature of Bonjour service discovery.
" }, { "filename": "Titanium.Network.BonjourBrowser.updatedServices-event", "name": "updatedServices", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "Fired when the discovered services list is updated
" } ], "examples": [], "methods": [ { "filename": "Titanium.Network.BonjourBrowser.search-method", "name": "search", "parameters": [], "returntype": "void", "value": "Conduct a search for Bonjour services matching the type and domain specified during creation
" }, { "filename": "Titanium.Network.BonjourBrowser.stopSearch-method", "name": "stopSearch", "parameters": [], "returntype": "void", "value": "Halt an ongoing search
" } ], "notes": "If your application publishes Bonjour services itself, that service will be discovered by the browser if necessary; be prepared to perform a check if you do not want to list local services as available. Bonjour service browsing is an asynchronous operation, meaning that you should be extremely careful when caching values from the 'services' property returned by the updatedServices event. In particular, if you maintain a local copy of available services and a user tries to connect to one, you should be prepared to handle failures gracefully; the next updatedServices event should provide the new services list, but you should not rely on it being delivered before user input. When a window which uses Bonjour browsing is closed, if you do not want to continue searching, you must call the stop() method.
", "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Network.BonjourBrowser.domain-property", "name": "domain", "type": "string", "value": "The domain the browser is searching in
" }, { "filename": "Titanium.Network.BonjourBrowser.isSearching-property", "name": "isSearching", "type": "boolean", "value": "Whether or not the browser is currently searching
" }, { "filename": "Titanium.Network.BonjourBrowser.serviceType-property", "name": "serviceType", "type": "string", "value": "The type of the service the browser searches for
" } ], "returns": null, "since": "1.2.0", "subtype": null, "type": "object" }, "Titanium.Network.BonjourService": { "deprecated": null, "description": "The BonjourService instance returned either from Titanium.Network.createBonjourService or via the service list from a BonjourBrowser updatedServices event. This object describes a service on the network which is published by Bonjour.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Network.BonjourService.publish-method", "name": "publish", "parameters": [ { "description": "a TCPSocket object to associate with the Bonjour service.", "name": "socket", "type": "object" } ], "returntype": "void", "value": "Publish a Bonjour service to the network. Only works if isLocal is TRUE
" }, { "filename": "Titanium.Network.BonjourService.resolve-method", "name": "resolve", "parameters": [ { "description": "the timeout for service resolution, in seconds. Optional, default is 120s.", "name": "timeout", "type": "double" } ], "returntype": "void", "value": "Resolve a Bonjour service from the network. Must be done before attempting to access the service's socket information, if a remote service. You cannot resolve a locally published service.
" }, { "filename": "Titanium.Network.BonjourService.stop-method", "name": "stop", "parameters": [], "returntype": "void", "value": "Halts publication of a service.
" } ], "notes": "You can only publish Bonjour services attached to a socket which is currently listening; you cannot publish a service for a remotely connected socket. If you stop the Bonjour service and wish to close the socket it uses, it is strongly recommended that you stop the service first. When a window which publishes a Bonjour service is closed, you must stop the service if the associated socket is also to be closed, or if it is no longer necessary to publish. Unlike other network operations, Bonjour service resolution and publishing is synchronous, so be aware that your code may block while resolution is going on. In particular, you may wish to display UI elements indicating background activity before beginning resolution.
", "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Network.BonjourService.domain-property", "name": "domain", "type": "string", "value": "the domain of the service
" }, { "filename": "Titanium.Network.BonjourService.isLocal-property", "name": "isLocal", "type": "boolean", "value": "whether or not the service is local to the device
" }, { "filename": "Titanium.Network.BonjourService.name-property", "name": "name", "type": "string", "value": "the name of the service
" }, { "filename": "Titanium.Network.BonjourService.socket-property", "name": "socket", "type": "object", "value": "the TCPSocket object that is used to connect to the service
" }, { "filename": "Titanium.Network.BonjourService.type-property", "name": "type", "type": "string", "value": "the type of the service
" } ], "returns": null, "since": "1.2.0", "subtype": null, "type": "object" }, "Titanium.Network.HTTPClient": { "deprecated": null, "description": "The HttpClient instance returned from Titanium.Network.createHTTPClient. This object (mostly) implements the XMLHttpRequest specification.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Network.HTTPClient.abort-method", "name": "abort", "parameters": [], "returntype": "void", "value": "abort a pending request
" }, { "filename": "Titanium.Network.HTTPClient.getResponseHeader-method", "name": "getResponseHeader", "parameters": [ { "description": "the header name", "name": "name", "type": "string" } ], "returntype": "string", "value": "return the response header.
" }, { "filename": "Titanium.Network.HTTPClient.open-method", "name": "open", "parameters": [ { "description": "the HTTP method", "name": "method", "type": "string" }, { "description": "the URL for the request", "name": "url", "type": "string" }, { "description": "optional property to indicate if asynchronous (default) or not", "name": "async", "type": "boolean" } ], "returntype": "void", "value": "open the request and ready the connection
" }, { "filename": "Titanium.Network.HTTPClient.send-method", "name": "send", "parameters": [ { "description": "the data to send in the request. can either be null, dictionary, string, File object or Blob.", "name": "data", "type": "object" } ], "returntype": "void", "value": "send the request
" }, { "filename": "Titanium.Network.HTTPClient.setRequestHeader-method", "name": "setRequestHeader", "parameters": [ { "description": "name of the header", "name": "name", "type": "string" }, { "description": "value of the header. May be null to clearing out a property, such as X-Requested-With", "name": "value", "type": "string" } ], "returntype": "void", "value": "set the request header. Must be called after open but before send.
" }, { "filename": "Titanium.Network.HTTPClient.setTimeout-method", "name": "setTimeout", "parameters": [ { "description": "the timeout in milliseconds", "name": "timeout", "type": "double" } ], "returntype": "void", "value": "set the request timeout
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Network.HTTPClient.DONE-property", "name": "DONE", "type": "int", "value": "the DONE readyState constant
" }, { "filename": "Titanium.Network.HTTPClient.HEADERS_RECEIVED-property", "name": "HEADERS_RECEIVED", "type": "int", "value": "the HEADERS_RECEIVED readyState constant
" }, { "filename": "Titanium.Network.HTTPClient.LOADING-property", "name": "LOADING", "type": "int", "value": "the LOADING readyState constant
" }, { "filename": "Titanium.Network.HTTPClient.OPENED-property", "name": "OPENED", "type": "int", "value": "the OPENED readyState constant
" }, { "filename": "Titanium.Network.HTTPClient.UNSENT-property", "name": "UNSENT", "type": "int", "value": "the UNSET readyState constant
" }, { "filename": "Titanium.Network.HTTPClient.connected-property", "name": "connected", "type": "boolean", "value": "boolean to indicate that the response was successful
" }, { "filename": "Titanium.Network.HTTPClient.connectionType-property", "name": "connectionType", "type": "string", "value": "the connection type, normally either GET or POST.
" }, { "filename": "Titanium.Network.HTTPClient.location-property", "name": "location", "type": "string", "value": "the absolute URL of the request
" }, { "filename": "Titanium.Network.HTTPClient.ondatastream-property", "name": "ondatastream", "type": "function", "value": "set this to a function before calling open to cause the function to be called at regular intervals as the request data is being received. the progress property of the event will contain a value from 0.0-1.0 with the progress.
" }, { "filename": "Titanium.Network.HTTPClient.onerror-property", "name": "onerror", "type": "function", "value": "set this to a function before calling open to cause the function to be called upon a error response
" }, { "filename": "Titanium.Network.HTTPClient.onload-property", "name": "onload", "type": "function", "value": "set this to a function before calling open to cause the function to be called upon a successful response
" }, { "filename": "Titanium.Network.HTTPClient.onreadystatechange-property", "name": "onreadystatechange", "type": "function", "value": "set this to a function before calling open to cause the function to be called for each readyState change
" }, { "filename": "Titanium.Network.HTTPClient.onsendstream-property", "name": "onsendstream", "type": "function", "value": "set this to a function before calling open to cause the function to be called at regular intervals as the request data is being transmitted. the progress property of the event will contain a value from 0.0-1.0 with the progress.
" }, { "filename": "Titanium.Network.HTTPClient.readyState-property", "name": "readyState", "type": "int", "value": "the readyState value
" }, { "filename": "Titanium.Network.HTTPClient.responseData-property", "name": "responseData", "type": "object", "value": "the response data as a Blob object.
" }, { "filename": "Titanium.Network.HTTPClient.responseText-property", "name": "responseText", "type": "string", "value": "the response as text or null if an error was received or no data was returned
" }, { "filename": "Titanium.Network.HTTPClient.responseXML-property", "name": "responseXML", "type": "object", "value": "the response object as an XML DOMDocument object. returns null if the content type returned by the server was not XML or the content could not be parsed
" }, { "filename": "Titanium.Network.HTTPClient.status-property", "name": "status", "type": "int", "value": "the response HTTP status code
" }, { "filename": "Titanium.Network.HTTPClient.timeout-property", "name": "timeout", "type": "int", "value": "timeout is milliseconds when the connection should be aborted
" }, { "filename": "Titanium.Network.HTTPClient.validatesSecureCertificate-property", "name": "validatesSecureCertificate", "type": "boolean", "value": "set this to control how SSL certification validation is performed on connection. defaults to false if in simulator or device testing and true if release for distribution mode.
" } ], "returns": null, "since": "0.1", "subtype": null, "type": "object" }, "Titanium.Network.TCPSocket": { "deprecated": null, "description": "The TCPSocket instance returned from Titanium.Network.createTCPSocket. This object represents a socket which either listens locally on the device for connections, or connects to a remote machine.
", "events": [ { "filename": "Titanium.Network.TCPSocket.read-event", "name": "read", "properties": { "data[object]": "a blob representing the data read, can be interpreted via toString
", "from[int]": "the reference for the socket that data was retrieved from
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "new data was read off the socket
" }, { "filename": "Titanium.Network.TCPSocket.readError-event", "name": "readError", "properties": { "code[int]": "the BSD socket error code
", "error[string]": "a description of the error
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "an error occured when reading
" }, { "filename": "Titanium.Network.TCPSocket.writeError-event", "name": "writeError", "properties": { "code[int]": "the BSD socket error code
", "error[string]": "a description of the error
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "an error occured when writing
" } ], "examples": [], "methods": [ { "filename": "Titanium.Network.TCPSocket.close-method", "name": "close", "parameters": [], "returntype": "void", "value": "close the socket
" }, { "filename": "Titanium.Network.TCPSocket.connect-method", "name": "connect", "parameters": [], "returntype": "void", "value": "connect the scocket to a TCP server
" }, { "filename": "Titanium.Network.TCPSocket.listen-method", "name": "listen", "parameters": [], "returntype": "void", "value": "set up the socket to receive connections
" }, { "filename": "Titanium.Network.TCPSocket.write-method", "name": "write", "parameters": [ { "description": "either a string or blob object representing the data to be transferred", "name": "data", "type": "object,string" }, { "description": "the socket reference to send the data to. Default is to send to all connected sockets", "name": "sendTo", "type": "int" } ], "returntype": "void", "value": "write data to the socket, if the mode is WRITE_MODE or READ_WRITE_MODE
" } ], "notes": "Sockets are nontrivial; it is recommended that anyone using them be familiar with the basics of BSD sockets. All sockets use TCP connections, and are asynchronous for read operations, so your program should be ready to receive 'read' events at any point. Socket references cannot be transferred to socket objects, and vice-versa - socket references are an internal mechanism which is used only to determine which sockets to send data to and read data from. For listening sockets, it is highly recommended that you use the Titanium.Network.INADDR_ANY constant as the host name. If a window containing a socket is closed, the socket MUST be closed also unless you intend to continue to receive data, otherwise the socket will consume resources (and potentially cause conflicts with opening the window again, if a listener) until the program is restarted. Be aware of the differences between the listen() and connect() functions; attempting to use one when you mean the other may result in errors, unpredictable behavior, or both.
", "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Network.TCPSocket.hostName-property", "name": "hostName", "type": "string", "value": "the host name to connect to. Must be INADDR_ANY or an identifier for the local device in order to listen
" }, { "filename": "Titanium.Network.TCPSocket.isValid-property", "name": "isValid", "type": "boolean", "value": "whether or not the socket is valid
" }, { "filename": "Titanium.Network.TCPSocket.mode-property", "name": "mode", "type": "int", "value": "the socket's mode
" }, { "filename": "Titanium.Network.TCPSocket.port-property", "name": "port", "type": "int", "value": "the port to connect/listen on
" } ], "returns": null, "since": "1.2.0", "subtype": null, "type": "object" }, "Titanium.Platform": { "deprecated": null, "description": "The top level Platform module. The Platform module is used accessing the device's platform\nrelated functionality.
", "events": [ { "filename": "Titanium.Platform.battery-event", "name": "battery", "properties": { "level": "the new battery level
", "source": "the source object that fired the event", "state": "the new battery state
", "type": "the name of the event fired" }, "value": "fired when the battery state changes. the battery state changes are only tracked on iPhone/iPad at 5% increments.
" } ], "examples": [], "methods": [ { "filename": "Titanium.Platform.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Platform.createUUID-method", "name": "createUUID", "parameters": [], "returntype": "string", "value": "create a globally unique identifier
" }, { "filename": "Titanium.Platform.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Platform.openURL-method", "name": "openURL", "parameters": [ { "description": "the url to open", "name": "url", "type": "string" } ], "returntype": "void", "value": "open a URL in the system default manner
" }, { "filename": "Titanium.Platform.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [ "Titanium.Platform.DisplayCaps" ], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Platform.BATTERY_STATE_CHARGING-property", "name": "BATTERY_STATE_CHARGING", "type": "int", "value": "the device is plugged in and currently being charged
" }, { "filename": "Titanium.Platform.BATTERY_STATE_FULL-property", "name": "BATTERY_STATE_FULL", "type": "int", "value": "the battery is fully charged
" }, { "filename": "Titanium.Platform.BATTERY_STATE_UNKNOWN-property", "name": "BATTERY_STATE_UNKNOWN", "type": "int", "value": "the battery state is unknown or not monitoring is not enabled
" }, { "filename": "Titanium.Platform.BATTERY_STATE_UNPLUGGED-property", "name": "BATTERY_STATE_UNPLUGGED", "type": "int", "value": "the device is unplugged
" }, { "filename": "Titanium.Platform.address-property", "name": "address", "type": "string", "value": "the ip address that the device reports (only applicable on WIFI network)
" }, { "filename": "Titanium.Platform.architecture-property", "name": "architecture", "type": "string", "value": "the processor architecture that the device reports
" }, { "filename": "Titanium.Platform.availableMemory-property", "name": "availableMemory", "type": "double", "value": "return the amount of memory available on the device in bytes
" }, { "filename": "Titanium.Platform.batteryLevel-property", "name": "batteryLevel", "type": "float", "value": "the current device battery level. this property is only accessible if batteryMonitoring is enabled. on iPhone, this level only changes at 5% intervals.
" }, { "filename": "Titanium.Platform.batteryMonitoring-property", "name": "batteryMonitoring", "type": "boolean", "value": "boolean to indicate if battery monitoring is enabled
" }, { "filename": "Titanium.Platform.batteryState-property", "name": "batteryState", "type": "int", "value": "constant that represents the state of the battery. this property is only accessible if batteryMonitoring is enabled
" }, { "filename": "Titanium.Platform.displayCaps-property", "name": "displayCaps", "type": "object", "value": "return the DisplayCaps object for platform
" }, { "filename": "Titanium.Platform.id-property", "name": "id", "type": "string", "value": "the unique id of the device
" }, { "filename": "Titanium.Platform.locale-property", "name": "locale", "type": "string", "value": "the primary language of the device that the user has enabled
" }, { "filename": "Titanium.Platform.macaddress-property", "name": "macaddress", "type": "string", "value": "this property will return a unique identifier for the device
" }, { "filename": "Titanium.Platform.model-property", "name": "model", "type": "string", "value": "the model of the phone that the device reports
" }, { "filename": "Titanium.Platform.name-property", "name": "name", "type": "string", "value": "the name of the platform returned by the device
" }, { "filename": "Titanium.Platform.netmask-property", "name": "netmask", "type": "string", "value": "the network mask that the device reports (only applicable on WIFI network)
" }, { "filename": "Titanium.Platform.osname-property", "name": "osname", "type": "string", "value": "the shortname of the operating system. for example, on an iPhone, will return iphone, iPad will return ipad and Android will return android.
" }, { "filename": "Titanium.Platform.ostype-property", "name": "ostype", "type": "string", "value": "the OS architecture, such as 32 bit
" }, { "filename": "Titanium.Platform.processorCount-property", "name": "processorCount", "type": "int", "value": "the number of processors the device reports
" }, { "filename": "Titanium.Platform.username-property", "name": "username", "type": "string", "value": "the username of the device, if set
" }, { "filename": "Titanium.Platform.version-property", "name": "version", "type": "string", "value": "the version of the platform returned by the device
" } ], "returns": null, "since": "0.1", "subtype": null, "type": "module" }, "Titanium.Platform.DisplayCaps": { "deprecated": null, "description": "The Display Caps object returned by the Titanium.Platform.displayCaps property.
", "events": [], "examples": [], "methods": [], "notes": "On iPhone, the density property will return low and the dpi property will return 160. For iPad, the density property will return high and the dpi property will return 130. For Android, these values are device specific.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.Platform.DisplayCaps.density-property", "name": "density", "type": "string", "value": "returns the density property of the display device.
" }, { "filename": "Titanium.Platform.DisplayCaps.dpi-property", "name": "dpi", "type": "int", "value": "the DPI of the display device.
" }, { "filename": "Titanium.Platform.DisplayCaps.platformHeight-property", "name": "platformHeight", "type": "float", "value": "the height of the device screen
" }, { "filename": "Titanium.Platform.DisplayCaps.platformWidth-property", "name": "platformWidth", "type": "float", "value": "the width of the device screen
" } ], "returns": null, "since": "0.8", "subtype": null, "type": "object" }, "Titanium.UI": { "deprecated": null, "description": "The main Titanium.UI module. The UI module is responsible for native user-interface components and interaction inside Titanium. The goal of the UI module is to provide a native experience along with native performance by compiling Javascript code into their native counterparts as part of the build process.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.UI.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.create2DMatrix-method", "name": "create2DMatrix", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.2DMatrix", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.2DMatrix" }, { "filename": "Titanium.UI.create3DMatrix-method", "name": "create3DMatrix", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.3DMatrix", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.3DMatrix" }, { "filename": "Titanium.UI.createActivityIndicator-method", "name": "createActivityIndicator", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.ActivityIndicator", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.ActivityIndicator" }, { "filename": "Titanium.UI.createAlertDialog-method", "name": "createAlertDialog", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.AlertDialog", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.AlertDialog" }, { "filename": "Titanium.UI.createAnimation-method", "name": "createAnimation", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.Animation", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.Animation" }, { "filename": "Titanium.UI.createButton-method", "name": "createButton", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.Button", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.Button" }, { "filename": "Titanium.UI.createButtonBar-method", "name": "createButtonBar", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.ButtonBar", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.ButtonBar" }, { "filename": "Titanium.UI.createCoverFlowView-method", "name": "createCoverFlowView", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.CoverFlowView", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.CoverFlowView" }, { "filename": "Titanium.UI.createDashboardItem-method", "name": "createDashboardItem", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.DashboardItem", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.DashboardItem" }, { "filename": "Titanium.UI.createDashboardView-method", "name": "createDashboardView", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.DashboardView", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.DashboardView" }, { "filename": "Titanium.UI.createEmailDialog-method", "name": "createEmailDialog", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.EmailDialog", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.EmailDialog" }, { "filename": "Titanium.UI.createImageView-method", "name": "createImageView", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.ImageView", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.ImageView" }, { "filename": "Titanium.UI.createLabel-method", "name": "createLabel", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.Label", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.Label" }, { "filename": "Titanium.UI.createOptionDialog-method", "name": "createOptionDialog", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.OptionDialog", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.OptionDialog" }, { "filename": "Titanium.UI.createPicker-method", "name": "createPicker", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.Picker", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.Picker" }, { "filename": "Titanium.UI.createPickerColumn-method", "name": "createPickerColumn", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.PickerColumn", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.PickerColumn" }, { "filename": "Titanium.UI.createPickerRow-method", "name": "createPickerRow", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.PickerRow", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.PickerRow" }, { "filename": "Titanium.UI.createProgressBar-method", "name": "createProgressBar", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.ProgressBar", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.ProgressBar" }, { "filename": "Titanium.UI.createScrollView-method", "name": "createScrollView", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.ScrollView", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.ScrollView" }, { "filename": "Titanium.UI.createScrollableView-method", "name": "createScrollableView", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.ScrollableView", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.ScrollableView" }, { "filename": "Titanium.UI.createSearchBar-method", "name": "createSearchBar", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.SearchBar", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.SearchBar" }, { "filename": "Titanium.UI.createSlider-method", "name": "createSlider", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.Slider", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.Slider" }, { "filename": "Titanium.UI.createSwitch-method", "name": "createSwitch", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.Switch", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.Switch" }, { "filename": "Titanium.UI.createTab-method", "name": "createTab", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.Tab", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.Tab" }, { "filename": "Titanium.UI.createTabGroup-method", "name": "createTabGroup", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.TabGroup", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.TabGroup" }, { "filename": "Titanium.UI.createTabbedBar-method", "name": "createTabbedBar", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.TabbedBar", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.TabbedBar" }, { "filename": "Titanium.UI.createTableView-method", "name": "createTableView", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.TableView", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.TableView" }, { "filename": "Titanium.UI.createTableViewRow-method", "name": "createTableViewRow", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.TableViewRow", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.TableViewRow" }, { "filename": "Titanium.UI.createTableViewSection-method", "name": "createTableViewSection", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.TableViewSection", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.TableViewSection" }, { "filename": "Titanium.UI.createTextArea-method", "name": "createTextArea", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.TextArea", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.TextArea" }, { "filename": "Titanium.UI.createTextField-method", "name": "createTextField", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.TextField", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.TextField" }, { "filename": "Titanium.UI.createToolbar-method", "name": "createToolbar", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.Toolbar", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.Toolbar" }, { "filename": "Titanium.UI.createView-method", "name": "createView", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.View", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.View" }, { "filename": "Titanium.UI.createWebView-method", "name": "createWebView", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.WebView", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.WebView" }, { "filename": "Titanium.UI.createWindow-method", "name": "createWindow", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.Window", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.Window" }, { "filename": "Titanium.UI.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": "The UI module is broken down into 3 major area:
\nTitanium uses the Factory Pattern for constructing objects and a general naming pattern for APIs. For example, to construct a Alert Dialog, you call the method Titanium.UI.createAlertDialog. To create a TextArea, you call the method Titanium.UI.createTextArea. Once an object is created, it will be available until it goes out of scope.
\nUI objects are optimized by Titanium to not be realized into the drawing context and placed into the device UI surface until needed. That means that you can create UI objects, set their properties and add them to their hierarchy without much worry about memory or performance. When the native drawing surface needs to render a specific view or control, Titanium will automatically create the view as needed. Additionally, Titanium is optimized to also release memory once the view is no longer needed, on screen or in low memory situations. However, it's a good idea to help Titanium along in certain cases where you are no longer using objects. For example, you should call close on a Window instance when you are no longer using it. You can safely call open on the Window again to re-open it.
\n
Be careful with the objects that are created in app.js but only used once. Since the app.js context is global and generally is not garbage collected until the application exits, you should think about the design of your application as it relates to this fact. Window objects that are opened up with the url property to another Javascript file contain a nice way to decompose your application into smaller units. The other benefit is that when a Window is closed, its resources can be immediately cleaned up, saving resources such as memory and CPU. Additionally, Window objects run in a separate Javascript context and Thread. While all UI processing is done on the main UI thread, other processing inside a Window or the app.js that does not have UI interaction will run in its own thread.
\nTitanium components are designed to be portable across as many platforms as it supports. However, there are cases where a device either does not support a specific feature or capability or where it support additional functionality. For cases where the device OS supports capabilities that other platforms do not, we attempt to place those capabilities in a separate namespace, such as Titanium.UI.iPhone. However, in cases where the control is in a common namespace and support additional features, we continue to place that functionality directly on the object.
", "objects": [ "Titanium.UI.2DMatrix", "Titanium.UI.3DMatrix", "Titanium.UI.ActivityIndicator", "Titanium.UI.AlertDialog", "Titanium.UI.Animation", "Titanium.UI.Button", "Titanium.UI.ButtonBar", "Titanium.UI.CoverFlowView", "Titanium.UI.DashboardItem", "Titanium.UI.DashboardView", "Titanium.UI.EmailDialog", "Titanium.UI.ImageView", "Titanium.UI.Label", "Titanium.UI.OptionDialog", "Titanium.UI.Picker", "Titanium.UI.PickerColumn", "Titanium.UI.PickerRow", "Titanium.UI.ProgressBar", "Titanium.UI.ScrollView", "Titanium.UI.ScrollableView", "Titanium.UI.SearchBar", "Titanium.UI.Slider", "Titanium.UI.Switch", "Titanium.UI.Tab", "Titanium.UI.TabGroup", "Titanium.UI.TabbedBar", "Titanium.UI.TableView", "Titanium.UI.TableViewRow", "Titanium.UI.TableViewSection", "Titanium.UI.TextArea", "Titanium.UI.TextField", "Titanium.UI.Toolbar", "Titanium.UI.View", "Titanium.UI.WebView", "Titanium.UI.Window" ], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.ANIMATION_CURVE_EASE_IN-property", "name": "ANIMATION_CURVE_EASE_IN", "type": "int", "value": "animation curve constant
" }, { "filename": "Titanium.UI.ANIMATION_CURVE_EASE_IN_OUT-property", "name": "ANIMATION_CURVE_EASE_IN_OUT", "type": "int", "value": "animation curve constant
" }, { "filename": "Titanium.UI.ANIMATION_CURVE_EASE_OUT-property", "name": "ANIMATION_CURVE_EASE_OUT", "type": "int", "value": "animation curve constant
" }, { "filename": "Titanium.UI.ANIMATION_CURVE_LINEAR-property", "name": "ANIMATION_CURVE_LINEAR", "type": "int", "value": "animation curve constant
" }, { "filename": "Titanium.UI.BLEND_MODE_CLEAR-property", "name": "BLEND_MODE_CLEAR", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_COLOR-property", "name": "BLEND_MODE_COLOR", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_COLOR_BURN-property", "name": "BLEND_MODE_COLOR_BURN", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_COLOR_DODGE-property", "name": "BLEND_MODE_COLOR_DODGE", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_COPY-property", "name": "BLEND_MODE_COPY", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_DARKEN-property", "name": "BLEND_MODE_DARKEN", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_DESTINATION_ATOP-property", "name": "BLEND_MODE_DESTINATION_ATOP", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_DESTINATION_IN-property", "name": "BLEND_MODE_DESTINATION_IN", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_DESTINATION_OUT-property", "name": "BLEND_MODE_DESTINATION_OUT", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_DESTINATION_OVER-property", "name": "BLEND_MODE_DESTINATION_OVER", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_DIFFERENCE-property", "name": "BLEND_MODE_DIFFERENCE", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_EXCLUSION-property", "name": "BLEND_MODE_EXCLUSION", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_HARD_LIGHT-property", "name": "BLEND_MODE_HARD_LIGHT", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_HUE-property", "name": "BLEND_MODE_HUE", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_LIGHTEN-property", "name": "BLEND_MODE_LIGHTEN", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_LUMINOSITY-property", "name": "BLEND_MODE_LUMINOSITY", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_MULTIPLY-property", "name": "BLEND_MODE_MULTIPLY", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_NORMAL-property", "name": "BLEND_MODE_NORMAL", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_OVERLAY-property", "name": "BLEND_MODE_OVERLAY", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_PLUS_DARKER-property", "name": "BLEND_MODE_PLUS_DARKER", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_PLUS_LIGHTER-property", "name": "BLEND_MODE_PLUS_LIGHTER", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_SATURATION-property", "name": "BLEND_MODE_SATURATION", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_SCREEN-property", "name": "BLEND_MODE_SCREEN", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_SOFT_LIGHT-property", "name": "BLEND_MODE_SOFT_LIGHT", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_SOURCE_ATOP-property", "name": "BLEND_MODE_SOURCE_ATOP", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_SOURCE_IN-property", "name": "BLEND_MODE_SOURCE_IN", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_SOURCE_OUT-property", "name": "BLEND_MODE_SOURCE_OUT", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.BLEND_MODE_XOR-property", "name": "BLEND_MODE_XOR", "type": "int", "value": "image mode constant
" }, { "filename": "Titanium.UI.FACE_DOWN-property", "name": "FACE_DOWN", "type": "int", "value": "orientation constant
" }, { "filename": "Titanium.UI.FACE_UP-property", "name": "FACE_UP", "type": "int", "value": "orientation constant
" }, { "filename": "Titanium.UI.INPUT_BORDERSTYLE_BEZEL-property", "name": "INPUT_BORDERSTYLE_BEZEL", "type": "int", "value": "input border style constant
" }, { "filename": "Titanium.UI.INPUT_BORDERSTYLE_LINE-property", "name": "INPUT_BORDERSTYLE_LINE", "type": "int", "value": "input border style constant
" }, { "filename": "Titanium.UI.INPUT_BORDERSTYLE_NONE-property", "name": "INPUT_BORDERSTYLE_NONE", "type": "int", "value": "input border style constant
" }, { "filename": "Titanium.UI.INPUT_BORDERSTYLE_ROUNDED-property", "name": "INPUT_BORDERSTYLE_ROUNDED", "type": "int", "value": "input border style constant
" }, { "filename": "Titanium.UI.INPUT_BUTTONMODE_ALWAYS-property", "name": "INPUT_BUTTONMODE_ALWAYS", "type": "int", "value": "input button mode constant
" }, { "filename": "Titanium.UI.INPUT_BUTTONMODE_NEVER-property", "name": "INPUT_BUTTONMODE_NEVER", "type": "int", "value": "input button mode constant
" }, { "filename": "Titanium.UI.INPUT_BUTTONMODE_ONBLUR-property", "name": "INPUT_BUTTONMODE_ONBLUR", "type": "int", "value": "input button mode constant
" }, { "filename": "Titanium.UI.INPUT_BUTTONMODE_ONFOCUS-property", "name": "INPUT_BUTTONMODE_ONFOCUS", "type": "int", "value": "input button mode constant
" }, { "filename": "Titanium.UI.KEYBOARD_APPEARANCE_ALERT-property", "name": "KEYBOARD_APPEARANCE_ALERT", "type": "int", "value": "textfield keyboard appearance constant
" }, { "filename": "Titanium.UI.KEYBOARD_APPEARANCE_DEFAULT-property", "name": "KEYBOARD_APPEARANCE_DEFAULT", "type": "int", "value": "textfield keyboard appearance constant
" }, { "filename": "Titanium.UI.KEYBOARD_ASCII-property", "name": "KEYBOARD_ASCII", "type": "int", "value": "textfield keyboard constant
" }, { "filename": "Titanium.UI.KEYBOARD_DEFAULT-property", "name": "KEYBOARD_DEFAULT", "type": "int", "value": "textfield keyboard constant
" }, { "filename": "Titanium.UI.KEYBOARD_EMAIL-property", "name": "KEYBOARD_EMAIL", "type": "int", "value": "textfield keyboard constant
" }, { "filename": "Titanium.UI.KEYBOARD_NAMEPHONE_PAD-property", "name": "KEYBOARD_NAMEPHONE_PAD", "type": "int", "value": "textfield keyboard constant
" }, { "filename": "Titanium.UI.KEYBOARD_NUMBERS_PUNCTUATION-property", "name": "KEYBOARD_NUMBERS_PUNCTUATION", "type": "int", "value": "textfield keyboard constant
" }, { "filename": "Titanium.UI.KEYBOARD_NUMBER_PAD-property", "name": "KEYBOARD_NUMBER_PAD", "type": "int", "value": "textfield keyboard constant
" }, { "filename": "Titanium.UI.KEYBOARD_PHONE_PAD-property", "name": "KEYBOARD_PHONE_PAD", "type": "int", "value": "textfield keyboard constant
" }, { "filename": "Titanium.UI.KEYBOARD_URL-property", "name": "KEYBOARD_URL", "type": "int", "value": "textfield keyboard constant
" }, { "filename": "Titanium.UI.LANDSCAPE_LEFT-property", "name": "LANDSCAPE_LEFT", "type": "int", "value": "orientation (home button on left) constant
" }, { "filename": "Titanium.UI.LANDSCAPE_RIGHT-property", "name": "LANDSCAPE_RIGHT", "type": "int", "value": "orientation (home button on right) constant
" }, { "filename": "Titanium.UI.NOTIFICATION_DURATION_LONG-property", "name": "NOTIFICATION_DURATION_LONG", "type": "int", "value": "Duration of the notification
" }, { "filename": "Titanium.UI.NOTIFICATION_DURATION_SHORT-property", "name": "NOTIFICATION_DURATION_SHORT", "type": "int", "value": "Duration of the notification
" }, { "filename": "Titanium.UI.PICKER_TYPE_COUNT_DOWN_TIMER-property", "name": "PICKER_TYPE_COUNT_DOWN_TIMER", "type": "int", "value": "picker type constant
" }, { "filename": "Titanium.UI.PICKER_TYPE_DATE-property", "name": "PICKER_TYPE_DATE", "type": "int", "value": "picker type constant
" }, { "filename": "Titanium.UI.PICKER_TYPE_DATE_AND_TIME-property", "name": "PICKER_TYPE_DATE_AND_TIME", "type": "int", "value": "picker type constant
" }, { "filename": "Titanium.UI.PICKER_TYPE_PLAIN-property", "name": "PICKER_TYPE_PLAIN", "type": "int", "value": "picker type constant
" }, { "filename": "Titanium.UI.PICKER_TYPE_TIME-property", "name": "PICKER_TYPE_TIME", "type": "int", "value": "picker type constant
" }, { "filename": "Titanium.UI.PORTRAIT-property", "name": "PORTRAIT", "type": "int", "value": "orientation (home button on bottom) constant
" }, { "filename": "Titanium.UI.RETURNKEY_DEFAULT-property", "name": "RETURNKEY_DEFAULT", "type": "int", "value": "textfield return key constant
" }, { "filename": "Titanium.UI.RETURNKEY_DONE-property", "name": "RETURNKEY_DONE", "type": "int", "value": "textfield return key constant
" }, { "filename": "Titanium.UI.RETURNKEY_EMERGENCY_CALL-property", "name": "RETURNKEY_EMERGENCY_CALL", "type": "int", "value": "textfield return key constant
" }, { "filename": "Titanium.UI.RETURNKEY_GO-property", "name": "RETURNKEY_GO", "type": "int", "value": "textfield return key constant
" }, { "filename": "Titanium.UI.RETURNKEY_GOOGLE-property", "name": "RETURNKEY_GOOGLE", "type": "int", "value": "textfield return key constant
" }, { "filename": "Titanium.UI.RETURNKEY_JOIN-property", "name": "RETURNKEY_JOIN", "type": "int", "value": "textfield return key constant
" }, { "filename": "Titanium.UI.RETURNKEY_NEXT-property", "name": "RETURNKEY_NEXT", "type": "int", "value": "textfield return key constant
" }, { "filename": "Titanium.UI.RETURNKEY_ROUTE-property", "name": "RETURNKEY_ROUTE", "type": "int", "value": "textfield return key constant
" }, { "filename": "Titanium.UI.RETURNKEY_SEARCH-property", "name": "RETURNKEY_SEARCH", "type": "int", "value": "textfield return key constant
" }, { "filename": "Titanium.UI.RETURNKEY_SEND-property", "name": "RETURNKEY_SEND", "type": "int", "value": "textfield return key constant
" }, { "filename": "Titanium.UI.RETURNKEY_YAHOO-property", "name": "RETURNKEY_YAHOO", "type": "int", "value": "textfield return key constant
" }, { "filename": "Titanium.UI.TEXT_ALIGNMENT_CENTER-property", "name": "TEXT_ALIGNMENT_CENTER", "type": "int", "value": "text align constant
" }, { "filename": "Titanium.UI.TEXT_ALIGNMENT_LEFT-property", "name": "TEXT_ALIGNMENT_LEFT", "type": "int", "value": "text align constant
" }, { "filename": "Titanium.UI.TEXT_ALIGNMENT_RIGHT-property", "name": "TEXT_ALIGNMENT_RIGHT", "type": "int", "value": "text align constant
" }, { "filename": "Titanium.UI.TEXT_AUTOCAPITALIZATION_ALL-property", "name": "TEXT_AUTOCAPITALIZATION_ALL", "type": "int", "value": "text capitalization constant
" }, { "filename": "Titanium.UI.TEXT_AUTOCAPITALIZATION_NONE-property", "name": "TEXT_AUTOCAPITALIZATION_NONE", "type": "int", "value": "text capitalization constant
" }, { "filename": "Titanium.UI.TEXT_AUTOCAPITALIZATION_SENTENCES-property", "name": "TEXT_AUTOCAPITALIZATION_SENTENCES", "type": "int", "value": "text capitalization constant
" }, { "filename": "Titanium.UI.TEXT_AUTOCAPITALIZATION_WORDS-property", "name": "TEXT_AUTOCAPITALIZATION_WORDS", "type": "int", "value": "text capitalization constant
" }, { "filename": "Titanium.UI.TEXT_VERTICAL_ALIGNMENT_BOTTOM-property", "name": "TEXT_VERTICAL_ALIGNMENT_BOTTOM", "type": "int", "value": "text vertical align constant
" }, { "filename": "Titanium.UI.TEXT_VERTICAL_ALIGNMENT_CENTER-property", "name": "TEXT_VERTICAL_ALIGNMENT_CENTER", "type": "int", "value": "text vertical align constant
" }, { "filename": "Titanium.UI.TEXT_VERTICAL_ALIGNMENT_TOP-property", "name": "TEXT_VERTICAL_ALIGNMENT_TOP", "type": "int", "value": "text vertical align constant
" }, { "filename": "Titanium.UI.UNKNOWN-property", "name": "UNKNOWN", "type": "int", "value": "orientation constant
" }, { "filename": "Titanium.UI.UPSIDE_PORTRAIT-property", "name": "UPSIDE_PORTRAIT", "type": "int", "value": "orientation (home button on top) constant
" } ], "returns": null, "since": "0.4", "subtype": null, "type": "module" }, "Titanium.UI.2DMatrix": { "deprecated": null, "description": "The 2DMatrix is created by Titanium.UI.create2DMatrix. The 2D Matrix is an object for holding values for an affine transformation matrix. A 2D matrix is used to rotate, scale, translate, or skew the objects in a two-dimensional space. A 2D matrix is represented by a 3 by 3 matrix. Because the third column is always (0,0,1), the data structure contains values for only the first two columns.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.UI.2DMatrix.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.2DMatrix.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.2DMatrix.invert-method", "name": "invert", "parameters": [], "returntype": "void", "value": "Returns a matrix constructed by inverting an existing matrix
" }, { "filename": "Titanium.UI.2DMatrix.multiply-method", "name": "multiply", "parameters": [ { "description": "The second matrix. This matrix is concatenated to the matrix instance against which the function is invoked. The result of this function is the first matrix multiplied by the second matrix. You might perform several multiplications in order to create a single matrix that contains the cumulative effects of several transformations. Note that matrix operations are not commutative - the order in which you concatenate matrices is important. That is, the result of multiplying matrix t1 by matrix t2 does not necessarily equal the result of multiplying matrix t2 by matrix t1.", "name": "t2", "type": "object" } ], "returntype": "object", "value": "Returns a matrix constructed by combining two existing matrix.
" }, { "filename": "Titanium.UI.2DMatrix.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.2DMatrix.rotate-method", "name": "rotate", "parameters": [ { "description": "The angle, in degrees, by which to rotate the matrix. A positive value specifies counterclockwise rotation and a negative value specifies clockwise rotation.", "name": "angle", "type": "float" } ], "returntype": "object", "value": "Returns a matrix constructed by rotating an existing matrix
" }, { "filename": "Titanium.UI.2DMatrix.scale-method", "name": "scale", "parameters": [ { "description": "The value by which to scale x values of the matrix", "name": "sx", "type": "float" }, { "description": "The value by which to scale y values of the matrix", "name": "sy", "type": "float" } ], "returntype": "object", "value": "Returns a matrix constructed by scaling an existing matrix
" }, { "filename": "Titanium.UI.2DMatrix.translate-method", "name": "translate", "parameters": [ { "description": "The value by which to move x values with the matrix", "name": "tx", "type": "float" }, { "description": "The value by which to move y values with the matrix", "name": "ty", "type": "float" } ], "returntype": "object", "value": "Returns a matrix constructed by translating an existing matrix
" } ], "notes": "You create an identity matrix by creating a 2D Matrix with an empty constructor.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.2DMatrix.a-property", "name": "a", "type": "float", "value": "The entry at position [1,1] in the matrix.
" }, { "filename": "Titanium.UI.2DMatrix.b-property", "name": "b", "type": "float", "value": "The entry at position [1,2] in the matrix.
" }, { "filename": "Titanium.UI.2DMatrix.c-property", "name": "c", "type": "float", "value": "The entry at position [2,1] in the matrix.
" }, { "filename": "Titanium.UI.2DMatrix.d-property", "name": "d", "type": "float", "value": "The entry at position [2,2] in the matrix.
" }, { "filename": "Titanium.UI.2DMatrix.tx-property", "name": "tx", "type": "float", "value": "The entry at position [3,1] in the matrix.
" }, { "filename": "Titanium.UI.2DMatrix.ty-property", "name": "ty", "type": "float", "value": "The entry at position [3,2] in the matrix.
" } ], "returns": null, "since": "0.9", "subtype": "proxy", "type": "object" }, "Titanium.UI.3DMatrix": { "deprecated": null, "description": "The 2DMatrix is created by Titanium.UI.create2DMatrix. The 2D Matrix is an object for holding values for an affine transformation matrix. A 2D matrix is used to rotate, scale, translate, or skew the objects in a three-dimensional space. A 3D matrix is represented by a 4 by 4 matrix. Because the forth column is always (0,0,1), the data structure contains values for only the first three columns.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.UI.3DMatrix.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.3DMatrix.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.3DMatrix.invert-method", "name": "invert", "parameters": [], "returntype": "void", "value": "Returns a matrix constructed by inverting an existing matrix
" }, { "filename": "Titanium.UI.3DMatrix.multiply-method", "name": "multiply", "parameters": [ { "description": "The second matrix. This matrix is concatenated to the matrix instance against which the function is invoked. The result of this function is the first matrix multiplied by the second matrix. You might perform several multiplications in order to create a single matrix that contains the cumulative effects of several transformations. Note that matrix operations are not commutative - the order in which you concatenate matrices is important. That is, the result of multiplying matrix t1 by matrix t2 does not necessarily equal the result of multiplying matrix t2 by matrix t1.", "name": "t2", "type": "object" } ], "returntype": "object", "value": "Returns a matrix constructed by combining two existing matrix.
" }, { "filename": "Titanium.UI.3DMatrix.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.3DMatrix.rotate-method", "name": "rotate", "parameters": [ { "description": "The angle, in degrees, by which to rotate the matrix. A positive value specifies counterclockwise rotation and a negative value specifies clockwise rotation.", "name": "angle", "type": "float" }, { "description": "The x part of the vector about which to rotate", "name": "x", "type": "float" }, { "description": "The y part of the vector about which to rotate", "name": "y", "type": "float" }, { "description": "The z part of the vector about which to rotate", "name": "z", "type": "float" } ], "returntype": "object", "value": "Returns a matrix constructed by rotating an existing matrix
" }, { "filename": "Titanium.UI.3DMatrix.scale-method", "name": "scale", "parameters": [ { "description": "The value by which to scale x values of the matrix", "name": "sx", "type": "float" }, { "description": "The value by which to scale y values of the matrix", "name": "sy", "type": "float" }, { "description": "The value by which to scale z values of the matrix", "name": "sz", "type": "float" } ], "returntype": "object", "value": "Returns a matrix constructed by scaling an existing matrix
" }, { "filename": "Titanium.UI.3DMatrix.translate-method", "name": "translate", "parameters": [ { "description": "The value by which to move x values with the matrix", "name": "tx", "type": "float" }, { "description": "The value by which to move y values with the matrix", "name": "ty", "type": "float" }, { "description": "The value by which to move z values with the matrix", "name": "tz", "type": "float" } ], "returntype": "object", "value": "Returns a matrix constructed by translating an existing matrix
" } ], "notes": "You create an identity matrix by creating a 3D Matrix with an empty constructor.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.3DMatrix.m11-property", "name": "m11", "type": "float", "value": "The entry at position [1,1] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m12-property", "name": "m12", "type": "float", "value": "The entry at position [1,2] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m13-property", "name": "m13", "type": "float", "value": "The entry at position [1,3] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m14-property", "name": "m14", "type": "float", "value": "The entry at position [1,4] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m21-property", "name": "m21", "type": "float", "value": "The entry at position [2,1] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m22-property", "name": "m22", "type": "float", "value": "The entry at position [2,2] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m23-property", "name": "m23", "type": "float", "value": "The entry at position [2,3] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m24-property", "name": "m24", "type": "float", "value": "The entry at position [2,4] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m31-property", "name": "m31", "type": "float", "value": "The entry at position [3,1] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m32-property", "name": "m32", "type": "float", "value": "The entry at position [3,2] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m33-property", "name": "m33", "type": "float", "value": "The entry at position [3,3] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m34-property", "name": "m34", "type": "float", "value": "The entry at position [3,4] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m41-property", "name": "m41", "type": "float", "value": "The entry at position [4,1] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m42-property", "name": "m42", "type": "float", "value": "The entry at position [4,2] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m43-property", "name": "m43", "type": "float", "value": "The entry at position [4,3] in the matrix.
" }, { "filename": "Titanium.UI.3DMatrix.m44-property", "name": "m44", "type": "float", "value": "The entry at position [4,4] in the matrix.
" } ], "returns": null, "since": "0.9", "subtype": "proxy", "type": "object" }, "Titanium.UI.ActivityIndicator": { "deprecated": null, "description": "An Activity Indicator is created by the method Titanium.UI.createActivityIndicator. An activity indicator can be used to show the progress of an operation in the UI to let the user know some action is taking place.
", "events": [], "examples": [ { "code": "In this example, we create a basic activity indicator and start it.
\nvar actInd = Titanium.UI.createActivityIndicator({\n height:50,\n width:10\n});\nactInd.show();\ncall hide to make the activity indicator hidden and stop spinning
" }, { "filename": "Titanium.UI.ActivityIndicator.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "call show to make the activity indicator visible and start spinning
" } ], "notes": "For iPhone, the style can be set from the constants Titanium.UI.iPhone.ActivityIndicatorStyle.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.ActivityIndicator.color-property", "name": "color", "type": "string", "value": "the color of the message label
" }, { "filename": "Titanium.UI.ActivityIndicator.font-property", "name": "font", "type": "object", "value": "the font object for the activity message label
" }, { "filename": "Titanium.UI.ActivityIndicator.message-property", "name": "message", "type": "string", "value": "the activity message label text
" }, { "filename": "Titanium.UI.ActivityIndicator.style-property", "name": "style", "type": "int", "value": "the style constant of the activity indicator
" } ], "returns": null, "since": "0.8", "subtype": null, "type": "object" }, "Titanium.UI.AlertDialog": { "deprecated": null, "description": "The Alert Dialog is created by Titanium.UI.createAlertDialog and allows you to show a modal application dialog.
", "events": [ { "filename": "Titanium.UI.AlertDialog.click-event", "name": "click", "properties": { "cancel": "boolean to indicate if the cancel button was pressed
", "index": "the button index that was pressed
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when a button in the dialog is clicked
" } ], "examples": [ { "code": "In this example, we show a simple alert dialog.
\nvar alertDialog = Titanium.UI.createAlertDialog({\n title: 'Hello',\n message: 'You got mail',\n buttonNames: ['OK','Doh!']\n});\nalertDialog.show();\ncause the dialog to become hidden
" }, { "filename": "Titanium.UI.AlertDialog.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.AlertDialog.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "cause the dialog to become visible
" } ], "notes": "the global method alert is aliased to this object and can be invoked with a single message. For example:
\nalert(\"this is a message\");\nNote: you should be careful not to call alert more than once while a pending alert is visible.
\nOn iOS 4, alert dialogs will automatically be cancelled upon application suspend.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.AlertDialog.buttonNames-property", "name": "buttonNames", "type": "array", "value": "array of button names as strings
" }, { "filename": "Titanium.UI.AlertDialog.cancel-property", "name": "cancel", "type": "int", "value": "an index to indicate which button should be the cancel button.
" }, { "filename": "Titanium.UI.AlertDialog.message-property", "name": "message", "type": "string", "value": "the message of the dialog
" }, { "filename": "Titanium.UI.AlertDialog.title-property", "name": "title", "type": "string", "value": "the title of the dialog
" } ], "returns": null, "since": "0.8", "subtype": "proxy", "type": "object" }, "Titanium.UI.Android": { "deprecated": null, "description": "The Android specific UI capabilities. All properties, methods and events in this namespace will only work on Android related devices.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.UI.Android.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.Android.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.Android.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android" ], "properties": [], "returns": "object", "since": "1.0", "subtype": null, "type": "module" }, "Titanium.UI.Android.OptionMenu": { "deprecated": null, "description": "The menu that appears at the lower portion of the display when the device's Menu button is pressed.
", "events": [], "examples": [ { "code": "var menu = Titanium.UI.Android.OptionMenu.createMenu();\n\nvar item1 = Titanium.UI.Android.OptionMenu.createMenuItem({\n title : 'Item 1',\n icon : '/images/item1.png'\n});\n\nitem1.addEventListener('click', function(){\n Ti.UI.createAlertDialog({ title : 'You clicked Item 1'}).show();\n});\n\nvar item2 = Titanium.UI.Android.OptionMenu.createMenuItem({\n title : 'Refresh',\n icon : '/images/refresh.png'\n});\nitem2.addEventListener('click', function(){\n Ti.UI.createAlertDialog({ title : 'You clicked Refresh'}).show();\n});\n\nmenu.add(item1);\nmenu.add(item2);\n\n// Set the menu on the current heavyweight window. A heavyweight window maps to an Android\n// Activity. To create a heavyweight window, specify one or more of [**fullscreen**,**navBarHidden**,**modal**] to createWindow.\n\nTitanium.UI.Android.OptionMenu.setMenu(menu);\nThe Titanium.UI.Android.OptionMenu.Menu for this context.
" } ], "returns": "object", "since": "1.1", "subtype": null, "type": "module" }, "Titanium.UI.Android.OptionMenu.Menu": { "deprecated": null, "description": "A Menu allows you to provide a selection of options that appear when the menu button is pressed on device. The Menu is created by the method Titanium.UI.Android.OptionMenu.createMenu
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.UI.Android.OptionMenu.Menu.add-method", "name": "add", "parameters": [ { "description": "the menu item to add. Must be a Titanium.UI.Android.OptionMenu.MenuItem.", "name": "menuitem", "type": "object" } ], "returntype": "void", "value": "add a menu item. Items will be displayed in the menu based on insertion order.
" }, { "filename": "Titanium.UI.Android.OptionMenu.Menu.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.Android.OptionMenu.Menu.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.Android.OptionMenu.Menu.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android" ], "properties": [], "returns": null, "since": "1.1", "subtype": "proxy", "type": "object" }, "Titanium.UI.Android.OptionMenu.MenuItem": { "deprecated": null, "description": "A MenuItem allows you provide a selectable option with a graphic and titel. The Menu Item is created by the method Titanium.UI.Android.OptionMenu.createMenuItem
", "events": [ { "filename": "Titanium.UI.Android.OptionMenu.MenuItem.click-event", "name": "click", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the menu option is selected
" } ], "examples": [], "methods": [ { "filename": "Titanium.UI.Android.OptionMenu.MenuItem.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.Android.OptionMenu.MenuItem.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.Android.OptionMenu.MenuItem.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android" ], "properties": [ { "filename": "Titanium.UI.Android.OptionMenu.MenuItem.icon-property", "name": "icon", "type": "string", "value": "the path to the image to display on the menu option
" }, { "filename": "Titanium.UI.Android.OptionMenu.MenuItem.title-property", "name": "title", "type": "string", "value": "the text for the menu option
" } ], "returns": null, "since": "1.1", "subtype": "proxy", "type": "object" }, "Titanium.UI.Animation": { "deprecated": null, "description": "The Animation object is used for specifying lower-level animation properties and more low-level control of events during an animation. The Animation is created by the method Titanium.UI.createAnimation.
", "events": [ { "filename": "Titanium.UI.Animation.complete-event", "name": "complete", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the animation completes
" }, { "filename": "Titanium.UI.Animation.start-event", "name": "start", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the animation starts
" } ], "examples": [ { "code": "Create a simple animation and apply it to the view. In this example, the view will animate from red to black to orange over 2 seconds.
\nvar view = Titanium.UI.createView({\n backgroundColor:'red'\n});\nvar animation = Titanium.UI.createAnimation();\nanimation.backgroundColor = 'black';\nanimation.duration = 1000;\nanimation.addEventListener('complete',function()\n{\n animation.removeEventListener('complete',this);\n animation.backgroundColor = 'orange';\n view.animate(animation);\n});\nview.animate(animation);\nthe property specifies if the animation should be replayed in reverse upon completion
" }, { "filename": "Titanium.UI.Animation.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "value of the backgroundColor property to change during animation
" }, { "filename": "Titanium.UI.Animation.bottom-property", "name": "bottom", "type": "float", "value": "value of the bottom property to change during animation
" }, { "filename": "Titanium.UI.Animation.center-property", "name": "center", "type": "object", "value": "value of the center property to change during animation
" }, { "filename": "Titanium.UI.Animation.color-property", "name": "color", "type": "string", "value": "value of the color property to change during animation
" }, { "filename": "Titanium.UI.Animation.curve-property", "name": "curve", "type": "int", "value": "the curve of the animation
" }, { "filename": "Titanium.UI.Animation.delay-property", "name": "delay", "type": "float", "value": "the duration of time in milliseconds before starting the animation
" }, { "filename": "Titanium.UI.Animation.duration-property", "name": "duration", "type": "float", "value": "the duration of time in milliseconds to perform the animation
" }, { "filename": "Titanium.UI.Animation.height-property", "name": "height", "type": "float", "value": "value of the height property to change during animation
" }, { "filename": "Titanium.UI.Animation.left-property", "name": "left", "type": "float", "value": "value of the left property to change during animation
" }, { "filename": "Titanium.UI.Animation.opacity-property", "name": "opacity", "type": "float", "value": "value of the opacity property to change during animation
" }, { "filename": "Titanium.UI.Animation.opaque-property", "name": "opaque", "type": "boolean", "value": "value of the opaque property to change during animation
" }, { "filename": "Titanium.UI.Animation.repeat-property", "name": "repeat", "type": "int", "value": "the number of times the animation should be performed
" }, { "filename": "Titanium.UI.Animation.right-property", "name": "right", "type": "float", "value": "value of the right property to change during animation
" }, { "filename": "Titanium.UI.Animation.top-property", "name": "top", "type": "float", "value": "value of the top property to change during animation
" }, { "filename": "Titanium.UI.Animation.transform-property", "name": "transform", "type": "object", "value": "value of the transform property to change during animation
" }, { "filename": "Titanium.UI.Animation.transition-property", "name": "transition", "type": "int", "value": "during a transition animation, this is the constant to the type of transition to use
" }, { "filename": "Titanium.UI.Animation.visible-property", "name": "visible", "type": "boolean", "value": "value of the visible property to change during animation
" }, { "filename": "Titanium.UI.Animation.width-property", "name": "width", "type": "float", "value": "value of the width property to change during animation
" }, { "filename": "Titanium.UI.Animation.zIndex-property", "name": "zIndex", "type": "int", "value": "value of the zIndex property to change during animation
" } ], "returns": null, "since": "0.9", "subtype": "proxy", "type": "object" }, "Titanium.UI.Button": { "deprecated": null, "description": "A Button is created by the method Titanium.UI.createButton.
", "events": [ { "filename": "Titanium.UI.Button.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the user presses the button
" }, { "filename": "Titanium.UI.Button.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.Button.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.Button.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.Button.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.Button.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.Button.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.Button.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.Button.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.Button.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "var button = Titanium.UI.createButton({\n title: 'Hello'\n});\nbutton.addEventListener('click',function(e)\n{\n Titanium.API.info(\"You clicked the button\");\n});\nthe buttons background color
" }, { "filename": "Titanium.UI.Button.backgroundDisabledImage-property", "name": "backgroundDisabledImage", "type": "string", "value": "url to a button image that is drawn as the background of the button when the button is in the disabled state
" }, { "filename": "Titanium.UI.Button.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.Button.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "url to a button image that is drawn as the background of the button
" }, { "filename": "Titanium.UI.Button.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.Button.backgroundSelectedImage-property", "name": "backgroundSelectedImage", "type": "string", "value": "url to a button image that is drawn as the background of the button when the button is in the selected state
" }, { "filename": "Titanium.UI.Button.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.Button.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.Button.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.Button.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.Button.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Button.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.Button.color-property", "name": "color", "type": "string", "value": "the foreground color of the button text
" }, { "filename": "Titanium.UI.Button.enabled-property", "name": "enabled", "type": "boolean", "value": "boolean that indicates if the button is enabled or not
" }, { "filename": "Titanium.UI.Button.font-property", "name": "font", "type": "object", "value": "the font properties of the button
" }, { "filename": "Titanium.UI.Button.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.Button.image-property", "name": "image", "type": "string", "value": "the image to display on the button to the left of the title
" }, { "filename": "Titanium.UI.Button.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Button.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.Button.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Button.selectedColor-property", "name": "selectedColor", "type": "string", "value": "the selected color of the button text when the button is in the selected state
" }, { "filename": "Titanium.UI.Button.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.Button.style-property", "name": "style", "type": "int", "value": "style constant for the type of button
" }, { "filename": "Titanium.UI.Button.title-property", "name": "title", "type": "string", "value": "button title
" }, { "filename": "Titanium.UI.Button.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Button.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.Button.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.Button.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.Button.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.Button.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.ButtonBar": { "deprecated": null, "description": "A Button Bar is created by the method Titanium.UI.createButtonBar.
", "events": [ { "filename": "Titanium.UI.ButtonBar.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "index[int]": "the index of the button that was clicked
", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a button on the button bar is clicked
" }, { "filename": "Titanium.UI.ButtonBar.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.ButtonBar.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.ButtonBar.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.ButtonBar.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.ButtonBar.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.ButtonBar.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.ButtonBar.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.ButtonBar.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.ButtonBar.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "var bb1 = Titanium.UI.createButtonBar({\n labels:['One', 'Two', 'Three'],\n backgroundColor:'#336699',\n top:50,\n style:Titanium.UI.iPhone.SystemButtonStyle.BAR,\n height:25,\n width:200\n});\nwin.add(bb1);\nFor iPhone, the style constants are available in the constants defined in Titanium.UI.iPhone.SystemButtonStyle.
", "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.ButtonBar.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.ButtonBar.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.ButtonBar.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the button bar
" }, { "filename": "Titanium.UI.ButtonBar.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.ButtonBar.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.ButtonBar.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.ButtonBar.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.ButtonBar.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.ButtonBar.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.ButtonBar.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.ButtonBar.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ButtonBar.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.ButtonBar.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.ButtonBar.index-property", "name": "index", "type": "int", "value": "the selected index
" }, { "filename": "Titanium.UI.ButtonBar.labels-property", "name": "labels", "type": "array", "value": "the array of labels for the button bar. each object should have the properties title, image, width and enabled.
" }, { "filename": "Titanium.UI.ButtonBar.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ButtonBar.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.ButtonBar.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ButtonBar.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.ButtonBar.style-property", "name": "style", "type": "int", "value": "the style of the button bar
" }, { "filename": "Titanium.UI.ButtonBar.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ButtonBar.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.ButtonBar.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.ButtonBar.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.ButtonBar.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.ButtonBar.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.CoverFlowView": { "deprecated": null, "description": "The Cover Flow view is container for showing animated, three dimensional images in a nice UI. The Cover Flow view is created by the method Titanium.UI.createCoverFlowView.
", "events": [ { "filename": "Titanium.UI.CoverFlowView.change-event", "name": "change", "properties": { "index": "the index of the image that is now visible
", "previous": "the previous index of the image that was visible
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the user changes the image using a gesture
" }, { "filename": "Titanium.UI.CoverFlowView.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "index": "the index of the image that is now visible
", "previous": "the previous index of the image that was visible
", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the user clicks on an image
" }, { "filename": "Titanium.UI.CoverFlowView.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.CoverFlowView.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.CoverFlowView.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.CoverFlowView.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.CoverFlowView.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.CoverFlowView.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.CoverFlowView.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.CoverFlowView.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.CoverFlowView.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "Create a rounded view.
\nvar view = Titanium.UI.createCoverFlowView({\n images:['a.png','b.png','c.png'],\n backgroundColor:'#000'\n});\nwindow.add(view);\nchange an image for a index
" }, { "filename": "Titanium.UI.CoverFlowView.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.CoverFlowView.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "", "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.CoverFlowView.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.CoverFlowView.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.CoverFlowView.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.CoverFlowView.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.CoverFlowView.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.CoverFlowView.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.CoverFlowView.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.CoverFlowView.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.CoverFlowView.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.CoverFlowView.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.CoverFlowView.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.CoverFlowView.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.CoverFlowView.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.CoverFlowView.images-property", "name": "images", "type": "array", "value": "array of images to display in the view
" }, { "filename": "Titanium.UI.CoverFlowView.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.CoverFlowView.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.CoverFlowView.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.CoverFlowView.selected-property", "name": "selected", "type": "int", "value": "index to make selected
" }, { "filename": "Titanium.UI.CoverFlowView.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.CoverFlowView.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.CoverFlowView.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.CoverFlowView.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.CoverFlowView.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.CoverFlowView.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.CoverFlowView.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.DashboardItem": { "deprecated": null, "description": "An item that represents a visual icon in the Titanium.UI.DashboardView. The Dashboard Item is created by the method Titanium.UI.createDashboardItem.
", "events": [ { "filename": "Titanium.UI.DashboardItem.click-event", "name": "click", "properties": { "item": "the Titanium.UI.DashboardItem that was clicked
", "location": "the location object with the properties x and y of where in the parent view the click was
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when a Titanium.UI.DashboardItem is clicked
" }, { "filename": "Titanium.UI.DashboardItem.delete-event", "name": "delete", "properties": { "item": "the Titanium.UI.DashboardItem that was deleted
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when a Titanium.UI.DashboardItem is deleted during editings
" }, { "filename": "Titanium.UI.DashboardItem.move-event", "name": "move", "properties": { "item": "the Titanium.UI.DashboardItem that was moved
", "items": "the pending data array in the new order (uncommitted)
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when a Titanium.UI.DashboardItem is moved during editing
" } ], "examples": [], "methods": [ { "filename": "Titanium.UI.DashboardItem.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.DashboardItem.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.DashboardItem.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.DashboardItem.badge-property", "name": "badge", "type": "int", "value": "the badge value or 0 to remove the badge
" }, { "filename": "Titanium.UI.DashboardItem.canDelete-property", "name": "canDelete", "type": "boolean", "value": "a boolean to indicate if this item can be deleted when it edit mode
" }, { "filename": "Titanium.UI.DashboardItem.image-property", "name": "image", "type": "string", "value": "the URL to the image
" }, { "filename": "Titanium.UI.DashboardItem.selectedImage-property", "name": "selectedImage", "type": "string", "value": "the URL to the image to display when the item is depressed (clicked)
" } ], "returns": null, "since": "1.2", "subtype": "proxy", "type": "object" }, "Titanium.UI.DashboardView": { "deprecated": null, "description": "The Dashboard View provides a view that supports the ability to have Springboard-like view of icons which can be reordered by dragging and can contain multiple pages of icons in a scrollable view. The Dashboard View is created by the method Titanium.UI.createDashboardView.
", "events": [ { "filename": "Titanium.UI.DashboardView.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "item": "the Titanium.UI.DashboardItem that was clicked
", "location": "the location object with the properties x and y of where in the parent view the click was
", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a Titanium.UI.DashboardItem is clicked
" }, { "filename": "Titanium.UI.DashboardView.commit-event", "name": "commit", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when editing ends
" }, { "filename": "Titanium.UI.DashboardView.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.DashboardView.delete-event", "name": "delete", "properties": { "item": "the Titanium.UI.DashboardItem that was deleted
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when a Titanium.UI.DashboardItem is deleted during editings
" }, { "filename": "Titanium.UI.DashboardView.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.DashboardView.edit-event", "name": "edit", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when editing begins
" }, { "filename": "Titanium.UI.DashboardView.move-event", "name": "move", "properties": { "item": "the Titanium.UI.DashboardItem that was moved
", "items": "the pending data array in the new order (uncommitted)
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when a Titanium.UI.DashboardItem is moved during editing
" }, { "filename": "Titanium.UI.DashboardView.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.DashboardView.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.DashboardView.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.DashboardView.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.DashboardView.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.DashboardView.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.DashboardView.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [], "methods": [ { "filename": "Titanium.UI.DashboardView.add-method", "name": "add", "parameters": [ { "description": "the view to add to this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "add a child to the view hierarchy" }, { "filename": "Titanium.UI.DashboardView.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.DashboardView.animate-method", "name": "animate", "parameters": [ { "description": "either a dictionary of animation properties or an Animation object", "name": "obj", "type": "object" }, { "description": "function to be invoked upon completion of the animation", "name": "callback", "type": "function" } ], "returntype": "void", "value": "animate the view" }, { "filename": "Titanium.UI.DashboardView.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.DashboardView.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.DashboardView.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.DashboardView.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.DashboardView.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.DashboardView.startEditing-method", "name": "startEditing", "parameters": [], "returntype": "void", "value": "put the dashboard in edit mode
" }, { "filename": "Titanium.UI.DashboardView.stopEditing-method", "name": "stopEditing", "parameters": [], "returntype": "void", "value": "cancel editing
" }, { "filename": "Titanium.UI.DashboardView.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.DashboardView.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.DashboardView.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.DashboardView.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.DashboardView.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.DashboardView.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.DashboardView.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.DashboardView.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.DashboardView.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.DashboardView.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.DashboardView.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.DashboardView.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.DashboardView.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.DashboardView.data-property", "name": "data", "type": "array", "value": "an array of Titanium.UI.DashboardItem objects to display in the view
" }, { "filename": "Titanium.UI.DashboardView.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.DashboardView.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.DashboardView.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.DashboardView.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.DashboardView.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.DashboardView.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.DashboardView.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.DashboardView.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.DashboardView.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.DashboardView.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.DashboardView.wobble-property", "name": "wobble", "type": "boolean", "value": "true (default) to wobble during edit, false to disable wobble effect
" }, { "filename": "Titanium.UI.DashboardView.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "1.2", "subtype": "view", "type": "object" }, "Titanium.UI.EmailDialog": { "deprecated": null, "description": "The Email Dialog is created by Titanium.UI.createEmailDialog and allows you to send in application emails on behalf of the application user.
", "events": [ { "filename": "Titanium.UI.EmailDialog.complete-event", "name": "complete", "properties": { "error": "string message of the error or null if successfully sent
", "result": "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.)
", "source": "the source object that fired the event", "success": "boolean to indicate if the email was successfully sent
", "type": "the name of the event fired" }, "value": "fired when the email dialog has completed sending the email
" } ], "examples": [ { "code": "In this example, we send an email with a file attachment.
\nvar emailDialog = Titanium.UI.createEmailDialog()\nemailDialog.subject = \"Hello from Titanium\";\nemailDialog.toRecipients = ['foo@yahoo.com'];\nemailDialog.messageBody = 'Appcelerator Titanium Rocks!';\nvar f = Ti.Filesystem.getFile('cricket.wav');\nemailDialog.addAttachment(f);\nemailDialog.open();\nadd an attachment to the email. the attachment can either be a Blob or File object. (Note: Android will only accept one attachment at this time.)
" }, { "filename": "Titanium.UI.EmailDialog.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.EmailDialog.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.EmailDialog.open-method", "name": "open", "parameters": [ { "description": "object of animation properties. pass animated property (as boolean) to indicate if the dialog should be animated on open.", "name": "properties", "type": "object" } ], "returntype": "void", "value": "open the email dialog. the email dialog itself is a modal window
" }, { "filename": "Titanium.UI.EmailDialog.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": "", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.EmailDialog.CANCELLED-property", "name": "CANCELLED", "type": "int", "value": "constant for the CANCELLED status result
" }, { "filename": "Titanium.UI.EmailDialog.FAILED-property", "name": "FAILED", "type": "int", "value": "constant for the FAILED status result
" }, { "filename": "Titanium.UI.EmailDialog.SAVED-property", "name": "SAVED", "type": "int", "value": "constant for the SAVED status result
" }, { "filename": "Titanium.UI.EmailDialog.SENT-property", "name": "SENT", "type": "int", "value": "constant for the SENT status result
" }, { "filename": "Titanium.UI.EmailDialog.barColor-property", "name": "barColor", "type": "string", "value": "the bar color of the email dialog window when opened
" }, { "filename": "Titanium.UI.EmailDialog.bccRecipients-property", "name": "bccRecipients", "type": "array", "value": "array of email BCC: recipients
" }, { "filename": "Titanium.UI.EmailDialog.ccRecipients-property", "name": "ccRecipients", "type": "array", "value": "array of email CC: recipients
" }, { "filename": "Titanium.UI.EmailDialog.html-property", "name": "html", "type": "boolean", "value": "boolean to indicate whether the email messageBody should be sent as HTML content type. defaults to false
" }, { "filename": "Titanium.UI.EmailDialog.messageBody-property", "name": "messageBody", "type": "string", "value": "the email message body
" }, { "filename": "Titanium.UI.EmailDialog.subject-property", "name": "subject", "type": "string", "value": "the subject line for the email
" }, { "filename": "Titanium.UI.EmailDialog.toRecipients-property", "name": "toRecipients", "type": "array", "value": "array of email recipients
" } ], "returns": null, "since": "0.8", "subtype": "proxy", "type": "object" }, "Titanium.UI.ImageView": { "deprecated": null, "description": "An Image View is used to display an image or a series of images in an animation. The Image View is created by the method Titanium.UI.createImageView.
", "events": [ { "filename": "Titanium.UI.ImageView.change-event", "name": "change", "properties": { "index": "the index of the image frame being displayed
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired for each frame changed during an animation
" }, { "filename": "Titanium.UI.ImageView.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.ImageView.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.ImageView.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.ImageView.load-event", "name": "load", "properties": { "source": "the source object that fired the event", "state": "either url to indicate the url property is loaded or images when all the images are loaded
", "type": "the name of the event fired" }, "value": "fired when either the initial image and/or all of the images in an animation are loaded
" }, { "filename": "Titanium.UI.ImageView.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.ImageView.start-event", "name": "start", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the animation starts
" }, { "filename": "Titanium.UI.ImageView.stop-event", "name": "stop", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the animation stops
" }, { "filename": "Titanium.UI.ImageView.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.ImageView.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.ImageView.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.ImageView.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.ImageView.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.ImageView.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "In this example, we create a simple image view:
\nvar image = Titanium.UI.createImageView({url:'myimage.png'});\nview.add(image);\npause a started animation.
" }, { "filename": "Titanium.UI.ImageView.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.ImageView.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.ImageView.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.ImageView.start-method", "name": "start", "parameters": [], "returntype": "void", "value": "start the image animation. this method only works if you set multiple images
" }, { "filename": "Titanium.UI.ImageView.stop-method", "name": "stop", "parameters": [], "returntype": "void", "value": "stop a started animation and reset the index to the first image
" }, { "filename": "Titanium.UI.ImageView.toBlob-method", "name": "toBlob", "parameters": [], "returntype": "void", "value": "return the image as a Blob object
" }, { "filename": "Titanium.UI.ImageView.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "If you specify a width and/or height property on the image, the image will be scaled to fit into this space if the image is larger.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.ImageView.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.ImageView.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.ImageView.animating-property", "name": "animating", "type": "boolean", "value": "readonly boolean to indicate if the animation is animating
" }, { "filename": "Titanium.UI.ImageView.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.ImageView.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.ImageView.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.ImageView.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.ImageView.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.ImageView.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.ImageView.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.ImageView.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.ImageView.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ImageView.canScale-property", "name": "canScale", "type": "boolean", "value": "allow image to scale (Android)
" }, { "filename": "Titanium.UI.ImageView.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.ImageView.defaultImage-property", "name": "defaultImage", "type": "string", "value": "url to the default image to display while loading a remote image
" }, { "filename": "Titanium.UI.ImageView.duration-property", "name": "duration", "type": "float", "value": "amount of time in milliseconds to animate one cycle
" }, { "filename": "Titanium.UI.ImageView.enableZoomControls-property", "name": "enableZoomControls", "type": "boolean", "value": "enable zoom controls on Android. Default is true for backward compatibility. (1.3.0)
" }, { "filename": "Titanium.UI.ImageView.height-property", "name": "height", "type": "float", "value": "height of the image display
" }, { "filename": "Titanium.UI.ImageView.image-property", "name": "image", "type": "object", "value": "image to display either as string url, Blob or File
" }, { "filename": "Titanium.UI.ImageView.images-property", "name": "images", "type": "array", "value": "array of images (either as string url, Blob or File) to display in an animation
" }, { "filename": "Titanium.UI.ImageView.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ImageView.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.ImageView.paused-property", "name": "paused", "type": "boolean", "value": "readonly boolean to indicate if the animation is paused
" }, { "filename": "Titanium.UI.ImageView.preventDefaultImage-property", "name": "preventDefaultImage", "type": "boolean", "value": "boolean to indicate if the default image should be displaying while loading a remote image
" }, { "filename": "Titanium.UI.ImageView.repeatCount-property", "name": "repeatCount", "type": "int", "value": "number of times to repeat the image animation
" }, { "filename": "Titanium.UI.ImageView.reverse-property", "name": "reverse", "type": "boolean", "value": "boolean to indicate if the animation should happen in reverse (from last to first)
" }, { "filename": "Titanium.UI.ImageView.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ImageView.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.ImageView.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ImageView.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.ImageView.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.ImageView.url-property", "name": "url", "type": "string", "value": "url to the image to display (NOTE: this property is deprecated. use image instead)
" }, { "filename": "Titanium.UI.ImageView.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.ImageView.width-property", "name": "width", "type": "float", "value": "width of the image display
" }, { "filename": "Titanium.UI.ImageView.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.9", "subtype": "view", "type": "object" }, "Titanium.UI.Label": { "deprecated": null, "description": "A Label is created by the method Titanium.UI.createLabel.
", "events": [ { "filename": "Titanium.UI.Label.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.Label.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.Label.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.Label.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.Label.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.Label.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.Label.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.Label.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.Label.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.Label.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "Create a label with a nice text shadow, 48px font that's aligned center and height auto.
\nvar l2 = Titanium.UI.createLabel({\n text:'Appcelerator',\n height:'auto',\n width:'auto',\n shadowColor:'#aaa',\n shadowOffset:{x:5,y:5},\n color:'#900',\n font:{fontSize:48},\n textAlign:'center'\n});\nbackground image for the label
" }, { "filename": "Titanium.UI.Label.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.Label.backgroundPaddingBottom-property", "name": "backgroundPaddingBottom", "type": "int", "value": "the number of pixels to extend the background image past the label on the bottom
" }, { "filename": "Titanium.UI.Label.backgroundPaddingLeft-property", "name": "backgroundPaddingLeft", "type": "int", "value": "the number of pixels to extend the background image past the label on the left
" }, { "filename": "Titanium.UI.Label.backgroundPaddingRight-property", "name": "backgroundPaddingRight", "type": "int", "value": "the number of pixels to extend the background image past the label on the right
" }, { "filename": "Titanium.UI.Label.backgroundPaddingTop-property", "name": "backgroundPaddingTop", "type": "int", "value": "the number of pixels to extend the background image past the label on the top
" }, { "filename": "Titanium.UI.Label.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.Label.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.Label.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.Label.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.Label.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Label.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.Label.color-property", "name": "color", "type": "string", "value": "the color of the label
" }, { "filename": "Titanium.UI.Label.font-property", "name": "font", "type": "object", "value": "the label font object properties
" }, { "filename": "Titanium.UI.Label.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.Label.highlightedColor-property", "name": "highlightedColor", "type": "string", "value": "the color of the label when in the highlighted state
" }, { "filename": "Titanium.UI.Label.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Label.minimumFontSize-property", "name": "minimumFontSize", "type": "int", "value": "the minimum size of the font when the font is sized based on the contents. Enables font scaling to fit and forces the label content to be limited to a single line
" }, { "filename": "Titanium.UI.Label.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.Label.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Label.shadowColor-property", "name": "shadowColor", "type": "string", "value": "the text shadow color
" }, { "filename": "Titanium.UI.Label.shadowOffset-property", "name": "shadowOffset", "type": "object", "value": "the shadow offset as a dictionary with the properties x and y
" }, { "filename": "Titanium.UI.Label.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.Label.text-property", "name": "text", "type": "string", "value": "the text of the label
" }, { "filename": "Titanium.UI.Label.textAlign-property", "name": "textAlign", "type": "string,int", "value": "the alignment constant or string value such as left, center or right
" }, { "filename": "Titanium.UI.Label.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Label.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.Label.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.Label.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.Label.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.Label.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.OptionDialog": { "deprecated": null, "description": "The Option Dialog is created by Titanium.UI.createOptionDialog and allows you to show a modal dialog of one or more options to the user.
", "events": [ { "filename": "Titanium.UI.OptionDialog.click-event", "name": "click", "properties": { "cancel": "boolean to indicate if the cancel button was pressed
", "destructive": "boolean to indicate if the destructive button was pressed
", "index": "the button index that was pressed
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when a button in the dialog is clicked
" } ], "examples": [ { "code": "In this example, we show a simple option dialog.
\nvar dialog = Titanium.UI.createOptionDialog({\n title: 'Hello',\n options: ['Option 1','Option 2'],\n cancel:1\n});\ndialog.show();\ncause the dialog to become visible
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.OptionDialog.cancel-property", "name": "cancel", "type": "int", "value": "an index to indicate which button should be the cancel button
" }, { "filename": "Titanium.UI.OptionDialog.destructive-property", "name": "destructive", "type": "int", "value": "the destructive button (indicated by a visual clue in the UI)
" }, { "filename": "Titanium.UI.OptionDialog.options-property", "name": "options", "type": "array", "value": "array of button names as strings
" }, { "filename": "Titanium.UI.OptionDialog.title-property", "name": "title", "type": "string", "value": "the title of the dialog
" } ], "returns": null, "since": "0.8", "subtype": null, "type": "object" }, "Titanium.UI.Picker": { "deprecated": null, "description": "A Picker is created by the method Titanium.UI.createPicker. A Picker can be used to select one or more fixed values.
", "events": [ { "filename": "Titanium.UI.Picker.change-event", "name": "change", "properties": { "column": "the column object
", "columnIndex": "the selected column index
", "row": "the row object
", "rowIndex": "the selected row index
", "selectedValue": "the array of selected values
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the value of a picker row and/or column changes
" } ], "examples": [ { "code": "In this basic picker example, we create a one column picker with 4 rows.
\nvar picker = Titanium.UI.createPicker();\nvar data = [];\ndata[0]=Titanium.UI.createPickerRow({title:'Bananas'});\ndata[1]=Titanium.UI.createPickerRow({title:'Strawberries'});\ndata[2]=Titanium.UI.createPickerRow({title:'Mangos'});\ndata[3]=Titanium.UI.createPickerRow({title:'Grapes'});\npicker.add(data);\nIn this example, we use a custom label for each row in a column.
\nvar picker = Titanium.UI.createPicker();\nvar row = Titanium.UI.createPickerRow();\nvar label = Titanium.UI.createLabel({\n text:text,\n font:{fontSize:24,fontWeight:'bold'},\n color:text,\n width:'auto',\n height:'auto'\n});\nrow.add(label);\npicker.add(row);\nadd an array of rows, a single row or a column to the picker
" }, { "filename": "Titanium.UI.Picker.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.Picker.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.Picker.getSelectedRow-method", "name": "getSelectedRow", "parameters": [ { "description": "for the column index, return the row object or nil if not found", "name": "index", "type": "int" } ], "returntype": "object", "value": "get the selected row object for column
" }, { "filename": "Titanium.UI.Picker.reloadColumn-method", "name": "reloadColumn", "parameters": [ { "description": "new column to load", "name": "column", "type": "object" } ], "returntype": "void", "value": "causes the picker to reload the values from the new column
" }, { "filename": "Titanium.UI.Picker.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.Picker.setSelectedRow-method", "name": "setSelectedRow", "parameters": [ { "description": "the column index", "name": "column", "type": "int" }, { "description": "the row index", "name": "row", "type": "int" }, { "description": "boolean to indicate if the selection should be animated (default)", "name": "animated", "type": "boolean" } ], "returntype": "void", "value": "set the column's row to the selected state
" } ], "notes": "Android does not support the DateTime or Count Down Timer picker type.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.Picker.columns-property", "name": "columns", "type": "array", "value": "array of column values
" }, { "filename": "Titanium.UI.Picker.countDownDuration-property", "name": "countDownDuration", "type": "double", "value": "the duration value in milliseconds for count down timer pickers
" }, { "filename": "Titanium.UI.Picker.locale-property", "name": "locale", "type": "string", "value": "the locale used for displaying Date/Time pickers values
" }, { "filename": "Titanium.UI.Picker.maxDate-property", "name": "maxDate", "type": "date", "value": "the maximum Date/Time for value for date pickers
" }, { "filename": "Titanium.UI.Picker.minDate-property", "name": "minDate", "type": "date", "value": "the minimum Date/Time for value for date pickers
" }, { "filename": "Titanium.UI.Picker.minuteInterval-property", "name": "minuteInterval", "type": "int", "value": "property to set the interval displayed by the minutes wheel (for example, 15 minutes). The interval value must be evenly divided into 60; if it is not, the default value is used. The default and minimum values are 1; the maximum value is 30.
" }, { "filename": "Titanium.UI.Picker.selectionIndicator-property", "name": "selectionIndicator", "type": "boolean", "value": "for basic picker, boolean value to indicate whether the visual selection style is shown. On the iPhone, this is a blue selected bar.
" }, { "filename": "Titanium.UI.Picker.type-property", "name": "type", "type": "int", "value": "the type constant for the picker. One of Titanium.UI.PICKER_TYPE_PLAIN (default), Titanium.UI.PICKER_TYPE_DATE_AND_TIME, Titanium.UI.PICKER_TYPE_DATE, Titanium.UI.PICKER_TYPE_TIME or Titanium.UI.PICKER_TYPE_COUNT_DOWN_TIMER.
" }, { "filename": "Titanium.UI.Picker.value-property", "name": "value", "type": "date", "value": "the Date/Time value for date pickers
" } ], "returns": null, "since": "0.8", "subtype": "proxy", "type": "object" }, "Titanium.UI.PickerColumn": { "deprecated": null, "description": "The picker row object created by Titanium.UI.createPickerColumn.
", "events": [ { "filename": "Titanium.UI.PickerColumn.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.PickerColumn.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.PickerColumn.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.PickerColumn.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.PickerColumn.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.PickerColumn.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.PickerColumn.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.PickerColumn.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.PickerColumn.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.PickerColumn.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [], "methods": [ { "filename": "Titanium.UI.PickerColumn.add-method", "name": "add", "parameters": [ { "description": "the view to add to this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "add a child to the view hierarchy" }, { "filename": "Titanium.UI.PickerColumn.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.PickerColumn.addRow[object]-method", "name": "addRow[object]", "parameters": [], "returntype": "void", "value": "a Titanium.UI.PickerRow object to add to the column
" }, { "filename": "Titanium.UI.PickerColumn.animate-method", "name": "animate", "parameters": [ { "description": "either a dictionary of animation properties or an Animation object", "name": "obj", "type": "object" }, { "description": "function to be invoked upon completion of the animation", "name": "callback", "type": "function" } ], "returntype": "void", "value": "animate the view" }, { "filename": "Titanium.UI.PickerColumn.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.PickerColumn.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.PickerColumn.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.PickerColumn.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.PickerColumn.removeRow[object]-method", "name": "removeRow[object]", "parameters": [], "returntype": "void", "value": "a Titanium.UI.PickerRow object to remove
" }, { "filename": "Titanium.UI.PickerColumn.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.PickerColumn.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.PickerColumn.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.PickerColumn.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.PickerColumn.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.PickerColumn.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.PickerColumn.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.PickerColumn.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.PickerColumn.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.PickerColumn.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.PickerColumn.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.PickerColumn.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.PickerColumn.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.PickerColumn.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.PickerColumn.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.PickerColumn.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.PickerColumn.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.PickerColumn.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.PickerColumn.rowCount-property", "name": "rowCount", "type": "int", "value": "number of rows in the column (readonly)
" }, { "filename": "Titanium.UI.PickerColumn.rows-property", "name": "rows", "type": "array", "value": "an array of rows
" }, { "filename": "Titanium.UI.PickerColumn.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.PickerColumn.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.PickerColumn.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.PickerColumn.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.PickerColumn.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.PickerColumn.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.PickerColumn.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.9", "subtype": "view", "type": "object" }, "Titanium.UI.PickerRow": { "deprecated": null, "description": "The picker row object created by Titanium.UI.createPickerRow.
", "events": [ { "filename": "Titanium.UI.PickerRow.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.PickerRow.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.PickerRow.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.PickerRow.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.PickerRow.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.PickerRow.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.PickerRow.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.PickerRow.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.PickerRow.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.PickerRow.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "Since the row object is itself a view, you can add views and widgets to it to customize the the rows display. In the example below, we create a custom label for the row.
\nvar row = Ti.UI.createPickerRow();\nvar label = Ti.UI.createLabel({\n text:text,\n font:{fontSize:24,fontWeight:'bold'},\n color:text,\n width:'auto',\n height:'auto'\n});\nrow.add(label);\npicker.add(row);\nthe font size when displaying the text. ignored when using a custom view
" }, { "filename": "Titanium.UI.PickerRow.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.PickerRow.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.PickerRow.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.PickerRow.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.PickerRow.selected-property", "name": "selected", "type": "boolean", "value": "when used in the constructor, set the row to selected on initial display
" }, { "filename": "Titanium.UI.PickerRow.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.PickerRow.title-property", "name": "title", "type": "string", "value": "the display text
" }, { "filename": "Titanium.UI.PickerRow.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.PickerRow.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.PickerRow.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.PickerRow.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.PickerRow.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.PickerRow.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.9", "subtype": "view", "type": "object" }, "Titanium.UI.ProgressBar": { "deprecated": null, "description": "A Progress Bar is created by the method Titanium.UI.createProgressBar.
", "events": [], "examples": [ { "code": "In this example we create a progress bar with the min value of 0 and the max value of 10 and the current value of 0. The change the value of the progress bar to cause it to move, we would set the value property to a value between min and max.
\nvar pb=Titanium.UI.createProgressBar({\n width:250,\n min:0,\n max:10,\n value:0,\n color:'#fff',\n message:'Downloading 0 of 10',\n font:{fontSize:14, fontWeight:'bold'},\n style:Titanium.UI.iPhone.ProgressBarStyle.PLAIN,\n});\nFor iPhone, progress bar styles are constants defined in Titanium.UI.iPhone.ProgressBarStyle.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.ProgressBar.color-property", "name": "color", "type": "string", "value": "the color of the progress bar text
" }, { "filename": "Titanium.UI.ProgressBar.font-property", "name": "font", "type": "object", "value": "the font object for the progress bar text
" }, { "filename": "Titanium.UI.ProgressBar.max-property", "name": "max", "type": "float", "value": "the maximum value of the progress bar
" }, { "filename": "Titanium.UI.ProgressBar.message-property", "name": "message", "type": "string", "value": "the progress bar message
" }, { "filename": "Titanium.UI.ProgressBar.min-property", "name": "min", "type": "float", "value": "the minimum value of the progress bar
" }, { "filename": "Titanium.UI.ProgressBar.style-property", "name": "style", "type": "int", "value": "the style of the progress bar
" }, { "filename": "Titanium.UI.ProgressBar.value-property", "name": "value", "type": "float", "value": "the current value of the progress bar
" } ], "returns": null, "since": "0.8", "subtype": null, "type": "object" }, "Titanium.UI.ScrollView": { "deprecated": null, "description": "A Scroll View is used to create a scrollable region of content. Views added to the Scroll View will be scrolled based on the content size of the Scroll View. The Scroll View is created by the method Titanium.UI.createScrollView. Note: In Android, Scroll Views can only scroll in one direction, either vertical or horizontal, but not both at the same time. See the Titanium.UI.ScrollView.scrollType property
", "events": [ { "filename": "Titanium.UI.ScrollView.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.ScrollView.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.ScrollView.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.ScrollView.scale-event", "name": "scale", "properties": { "scale": "the new scale as a float
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the zoom scale factor changes
" }, { "filename": "Titanium.UI.ScrollView.scroll-event", "name": "scroll", "properties": { "decelerating": "boolean to indicate if the scroll is decelerating
", "dragging": "boolean to indicate if the scroll is based on a dragging gesture
", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the new x location
", "y": "the new y location
" }, "value": "fired when the view is scrolled
" }, { "filename": "Titanium.UI.ScrollView.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.ScrollView.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.ScrollView.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.ScrollView.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.ScrollView.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.ScrollView.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.ScrollView.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "Create a scroll view with content.
\nvar scrollView = Titanium.UI.createScrollView({\n contentWidth:'auto',\n contentHeight:'auto',\n top:0,\n showVerticalScrollIndicator:true,\n showHorizontalScrollIndicator:true\n});\nvar view = Ti.UI.createView({\n backgroundColor:'#336699',\n borderRadius:10,\n width:300,\n height:2000,\n top:10\n});\nscrollView.add(view);\nTitanium.UI.currentWindow.add(scrollView);\nscrollTo a particular point
" }, { "filename": "Titanium.UI.ScrollView.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.ScrollView.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "If your scrollable region fits within the size of the content area the scroll view will not scroll.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.ScrollView.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.ScrollView.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.ScrollView.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.ScrollView.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.ScrollView.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.ScrollView.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.ScrollView.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.ScrollView.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.ScrollView.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.ScrollView.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.ScrollView.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ScrollView.canCancelEvents-property", "name": "canCancelEvents", "type": "boolean", "value": "(iPhone only) boolean to indicate if the scroll view can cancel subview touches in order to scroll instead. Default of true
" }, { "filename": "Titanium.UI.ScrollView.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.ScrollView.contentHeight-property", "name": "contentHeight", "type": "float", "value": "the height of the scrollable area
" }, { "filename": "Titanium.UI.ScrollView.contentOffset-property", "name": "contentOffset", "type": "object", "value": "an object (with x and y properties) to indicate the offset of the content area
" }, { "filename": "Titanium.UI.ScrollView.contentWidth-property", "name": "contentWidth", "type": "float", "value": "the width of the scrollable area
" }, { "filename": "Titanium.UI.ScrollView.disableBounce-property", "name": "disableBounce", "type": "boolean", "value": "boolean to control bounce during scrolling
" }, { "filename": "Titanium.UI.ScrollView.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.ScrollView.horizontalBounce-property", "name": "horizontalBounce", "type": "boolean", "value": "boolean to control the horizontal bounce during scrolling
" }, { "filename": "Titanium.UI.ScrollView.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ScrollView.maxZoomScale-property", "name": "maxZoomScale", "type": "float", "value": "the maximum scale of the content
" }, { "filename": "Titanium.UI.ScrollView.minZoomScale-property", "name": "minZoomScale", "type": "float", "value": "the minimum scale of the content
" }, { "filename": "Titanium.UI.ScrollView.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.ScrollView.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ScrollView.scrollType-property", "name": "scrollType", "type": "string", "value": "(Android only) the type of ScrollView: \"vertical\" or \"horizontal\"
" }, { "filename": "Titanium.UI.ScrollView.showHorizontalScrollIndicator-property", "name": "showHorizontalScrollIndicator", "type": "boolean", "value": "boolean to indicate whether the horizontal scroll indicator is visible
" }, { "filename": "Titanium.UI.ScrollView.showVerticalScrollIndicator-property", "name": "showVerticalScrollIndicator", "type": "boolean", "value": "boolean to indicate whether the vertical scroll indicator is visible
" }, { "filename": "Titanium.UI.ScrollView.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.ScrollView.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ScrollView.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.ScrollView.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.ScrollView.verticalBounce-property", "name": "verticalBounce", "type": "boolean", "value": "boolean to control the vertical bounce during scrolling
" }, { "filename": "Titanium.UI.ScrollView.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.ScrollView.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.ScrollView.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" }, { "filename": "Titanium.UI.ScrollView.zoomScale-property", "name": "zoomScale", "type": "float", "value": "set the zoom scale for the current content area
" } ], "returns": null, "since": "0.9", "subtype": "view", "type": "object" }, "Titanium.UI.ScrollableView": { "deprecated": null, "description": "The Scrollable View provides a view that supports horizontal scrolling on one or more views in a gesture motion. The Scrollable View also optionally supports a visual paging control to indicate the page that the view is visible. The Scrollable View is created by the method Titanium.UI.createScrollableView.
", "events": [ { "filename": "Titanium.UI.ScrollableView.click-event", "name": "click", "properties": { "currentPage": "the current page index
", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "view": "the current page view
", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the page control is touched
" }, { "filename": "Titanium.UI.ScrollableView.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.ScrollableView.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.ScrollableView.scroll-event", "name": "scroll", "properties": { "currentPage": "the current page index
", "source": "the source object that fired the event", "type": "the name of the event fired", "view": "the current page view
" }, "value": "fired when the scroll view is scrolled
" }, { "filename": "Titanium.UI.ScrollableView.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.ScrollableView.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.ScrollableView.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.ScrollableView.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.ScrollableView.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.ScrollableView.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.ScrollableView.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "Create three views and place each into a scrollable view.
\nvar view1 = Titanium.UI.createView({backgroundColor:'#123'});\nvar view2 = Titanium.UI.createView({backgroundColor:'#123'});\nvar view3 = Titanium.UI.createView({backgroundColor:'#123'});\nvar scrollView = Titanium.UI.createScrollableView({\n views:[view1,view2,view3],\n showPagingControl:true\n});\nwin.add(scrollView);\nadd a new view to the Scrollable View
" }, { "filename": "Titanium.UI.ScrollableView.animate-method", "name": "animate", "parameters": [ { "description": "either a dictionary of animation properties or an Animation object", "name": "obj", "type": "object" }, { "description": "function to be invoked upon completion of the animation", "name": "callback", "type": "function" } ], "returntype": "void", "value": "animate the view" }, { "filename": "Titanium.UI.ScrollableView.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.ScrollableView.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.ScrollableView.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.ScrollableView.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.ScrollableView.removeView-method", "name": "removeView", "parameters": [ { "description": "the view to remove", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove an existing view from the Scrollable View
" }, { "filename": "Titanium.UI.ScrollableView.scrollToView-method", "name": "scrollToView", "parameters": [ { "description": "either an integer index or the view object to bring into view as the currentPage", "name": "view", "type": "int,object" } ], "returntype": "void", "value": "scroll to a specific view
" }, { "filename": "Titanium.UI.ScrollableView.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.ScrollableView.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.ScrollableView.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.ScrollableView.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.ScrollableView.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.ScrollableView.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.ScrollableView.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.ScrollableView.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.ScrollableView.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.ScrollableView.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.ScrollableView.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.ScrollableView.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.ScrollableView.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ScrollableView.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.ScrollableView.currentPage-property", "name": "currentPage", "type": "int", "value": "the current page visible in the view
" }, { "filename": "Titanium.UI.ScrollableView.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.ScrollableView.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ScrollableView.maxZoomScale-property", "name": "maxZoomScale", "type": "float", "value": "the maximum zoom scale for the view
" }, { "filename": "Titanium.UI.ScrollableView.minZoomScale-property", "name": "minZoomScale", "type": "float", "value": "the minimum zoom scale for the view
" }, { "filename": "Titanium.UI.ScrollableView.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.ScrollableView.pagingControlColor-property", "name": "pagingControlColor", "type": "string", "value": "the color of the paging control. defaults to black.
" }, { "filename": "Titanium.UI.ScrollableView.pagingControlHeight-property", "name": "pagingControlHeight", "type": "float", "value": "the height in pixels of the paging control, if visible. defaults to 20
" }, { "filename": "Titanium.UI.ScrollableView.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ScrollableView.showPagingControl-property", "name": "showPagingControl", "type": "boolean", "value": "boolean to indicate whether the paging control UI is visible
" }, { "filename": "Titanium.UI.ScrollableView.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.ScrollableView.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.ScrollableView.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.ScrollableView.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.ScrollableView.views-property", "name": "views", "type": "array", "value": "array of view objects to place in the view
" }, { "filename": "Titanium.UI.ScrollableView.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.ScrollableView.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.ScrollableView.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.SearchBar": { "deprecated": null, "description": "A Search Bar is created by the method Titanium.UI.createSearchBar.
", "events": [ { "filename": "Titanium.UI.SearchBar.blur-event", "name": "blur", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the search bar loses focus
" }, { "filename": "Titanium.UI.SearchBar.cancel-event", "name": "cancel", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the cancel button is pressed
" }, { "filename": "Titanium.UI.SearchBar.change-event", "name": "change", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the value of the search bar changes
" }, { "filename": "Titanium.UI.SearchBar.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.SearchBar.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.SearchBar.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.SearchBar.focus-event", "name": "focus", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the search bar gains focus
" }, { "filename": "Titanium.UI.SearchBar.return-event", "name": "return", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when keyboard search button is pressed
" }, { "filename": "Titanium.UI.SearchBar.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.SearchBar.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.SearchBar.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.SearchBar.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.SearchBar.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.SearchBar.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.SearchBar.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "var search = Titanium.UI.createSearchBar({\n barColor:'#000', \n showCancel:true,\n height:43,\n top:0,\n});\ncalled to force the search bar to lose focus
" }, { "filename": "Titanium.UI.SearchBar.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.SearchBar.focus-method", "name": "focus", "parameters": [], "returntype": "void", "value": "called to force the search bar to focus
" }, { "filename": "Titanium.UI.SearchBar.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.SearchBar.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.SearchBar.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.SearchBar.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.SearchBar.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.SearchBar.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.SearchBar.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.SearchBar.autocapitalization-property", "name": "autocapitalization", "type": "boolean", "value": "boolean to indicate if the text in the field should be autocapitalized as typed
" }, { "filename": "Titanium.UI.SearchBar.autocorrect-property", "name": "autocorrect", "type": "boolean", "value": "boolean to indicate if the text in the field should be autocorrected as typed
" }, { "filename": "Titanium.UI.SearchBar.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.SearchBar.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.SearchBar.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.SearchBar.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.SearchBar.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.SearchBar.barColor-property", "name": "barColor", "type": "string", "value": "the bar color of the search bar view
" }, { "filename": "Titanium.UI.SearchBar.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.SearchBar.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.SearchBar.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.SearchBar.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.SearchBar.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.SearchBar.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.SearchBar.hintText-property", "name": "hintText", "type": "string", "value": "the text to show when the search bar field is not focused
" }, { "filename": "Titanium.UI.SearchBar.keyboardType-property", "name": "keyboardType", "type": "int", "value": "the keyboard type constant to use when the field is focused
" }, { "filename": "Titanium.UI.SearchBar.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.SearchBar.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.SearchBar.prompt-property", "name": "prompt", "type": "string", "value": "a single line of text displayed at the top of the search bar
" }, { "filename": "Titanium.UI.SearchBar.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.SearchBar.showCancel-property", "name": "showCancel", "type": "boolean", "value": "boolean indicates whether the cancel button is displayed
" }, { "filename": "Titanium.UI.SearchBar.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.SearchBar.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.SearchBar.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.SearchBar.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.SearchBar.value-property", "name": "value", "type": "string", "value": "the value of the search bar
" }, { "filename": "Titanium.UI.SearchBar.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.SearchBar.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.SearchBar.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.Slider": { "deprecated": null, "description": "A Slider is created by the method Titanium.UI.createSlider.
", "events": [ { "filename": "Titanium.UI.Slider.change-event", "name": "change", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "value[string]": "the new value of the slider
" }, "value": "fired when the value of the slider changes
" }, { "filename": "Titanium.UI.Slider.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.Slider.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.Slider.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.Slider.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.Slider.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.Slider.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.Slider.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.Slider.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.Slider.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.Slider.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [], "methods": [ { "filename": "Titanium.UI.Slider.add-method", "name": "add", "parameters": [ { "description": "the view to add to this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "add a child to the view hierarchy" }, { "filename": "Titanium.UI.Slider.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.Slider.animate-method", "name": "animate", "parameters": [ { "description": "either a dictionary of animation properties or an Animation object", "name": "obj", "type": "object" }, { "description": "function to be invoked upon completion of the animation", "name": "callback", "type": "function" } ], "returntype": "void", "value": "animate the view" }, { "filename": "Titanium.UI.Slider.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.Slider.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.Slider.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.Slider.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.Slider.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.Slider.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.Slider.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.Slider.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.Slider.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.Slider.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.Slider.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.Slider.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.Slider.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.Slider.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.Slider.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.Slider.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.Slider.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Slider.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.Slider.disabledLeftTrackImage-property", "name": "disabledLeftTrackImage", "type": "string", "value": "the image url of the slider left track when in the disabled state
" }, { "filename": "Titanium.UI.Slider.disabledRightTrackImage-property", "name": "disabledRightTrackImage", "type": "string", "value": "the image url of the slider right track when in the disabled state
" }, { "filename": "Titanium.UI.Slider.disabledThumbImage-property", "name": "disabledThumbImage", "type": "string", "value": "the image url of the slider thumb when in the disabled state
" }, { "filename": "Titanium.UI.Slider.enabled-property", "name": "enabled", "type": "boolean", "value": "boolean to indicate the enabled state of the slider
" }, { "filename": "Titanium.UI.Slider.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.Slider.highlightedLeftTrackImage-property", "name": "highlightedLeftTrackImage", "type": "string", "value": "the image url of the slider left track when in the highlighted state
" }, { "filename": "Titanium.UI.Slider.highlightedRightTrackImage-property", "name": "highlightedRightTrackImage", "type": "string", "value": "the image url of the slider right track when in the highlighted state
" }, { "filename": "Titanium.UI.Slider.highlightedThumbImage-property", "name": "highlightedThumbImage", "type": "string", "value": "the image url of the slider thumb when in the highlighted state
" }, { "filename": "Titanium.UI.Slider.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Slider.leftTrackImage-property", "name": "leftTrackImage", "type": "string", "value": "the image url of the slider left track
" }, { "filename": "Titanium.UI.Slider.max-property", "name": "max", "type": "float", "value": "the maximum slider value
" }, { "filename": "Titanium.UI.Slider.min-property", "name": "min", "type": "float", "value": "the minimum slider value
" }, { "filename": "Titanium.UI.Slider.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.Slider.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Slider.rightTrackImage-property", "name": "rightTrackImage", "type": "string", "value": "the image url of the slider right track
" }, { "filename": "Titanium.UI.Slider.selectedLeftTrackImage-property", "name": "selectedLeftTrackImage", "type": "string", "value": "the image url of the slider left track when in the selected state
" }, { "filename": "Titanium.UI.Slider.selectedRightTrackImage-property", "name": "selectedRightTrackImage", "type": "string", "value": "the image url of the slider right track when in the selected state
" }, { "filename": "Titanium.UI.Slider.selectedThumbImage-property", "name": "selectedThumbImage", "type": "string", "value": "the image url of the slider thumb when in the selected state
" }, { "filename": "Titanium.UI.Slider.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.Slider.thumbImage-property", "name": "thumbImage", "type": "string", "value": "the image url to the slider thumb
" }, { "filename": "Titanium.UI.Slider.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Slider.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.Slider.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.Slider.value-property", "name": "value", "type": "string", "value": "the value of the slider
" }, { "filename": "Titanium.UI.Slider.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.Slider.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.Slider.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.Switch": { "deprecated": null, "description": "A Switch is created by the method Titanium.UI.createSwitch.
", "events": [ { "filename": "Titanium.UI.Switch.change-event", "name": "change", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "value[boolean]": "the new value of the switch
" }, "value": "fired when the switch value is changed
" }, { "filename": "Titanium.UI.Switch.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.Switch.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.Switch.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.Switch.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.Switch.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.Switch.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.Switch.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.Switch.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.Switch.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.Switch.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "The following is a simple example of a switch and receiving change events.
\nvar basicSwitch = Titanium.UI.createSwitch({\n value:false\n});\nbasicSwitch.addEventListener('change',function(e)\n{\n Titanium.API.info('Basic Switch value = ' + e.value + ' act val ' + basicSwitch.value);\n});\nboolean for the state of the switch
" }, { "filename": "Titanium.UI.Switch.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.Switch.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Switch.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.Switch.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Switch.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.Switch.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Switch.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.Switch.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.Switch.value-property", "name": "value", "type": "boolean", "value": "boolean value of the switch where true is the switch is on and false the switch if off
" }, { "filename": "Titanium.UI.Switch.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.Switch.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.Switch.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.Tab": { "deprecated": null, "description": "A TabGroup Tab instance. Each Tab instance maintains a stack of tab windows. Only one window within in the Tab can be visible at a time. When a window is closed, either by the user or by code, the window is removed from the stack, make the previous window visible. The root tab window cannot be removed. The Tab Group is created by the method Titanium.UI.createTab.
", "events": [ { "filename": "Titanium.UI.Tab.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.Tab.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.Tab.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.Tab.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.Tab.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.Tab.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.Tab.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.Tab.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.Tab.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.Tab.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "In this example, we create a simple tab and add it to a tab group.
\nvar tab = Titanium.UI.createTab({\n window:mywin,\n title:'Hello',\n icon:'myicon.png'\n});\ntabGroup.addTab(tab);\nthe badge value for the tab group for this tab. null indicates no badge is value
" }, { "filename": "Titanium.UI.Tab.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.Tab.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.Tab.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.Tab.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Tab.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.Tab.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.Tab.icon-property", "name": "icon", "type": "string", "value": "the icon url for the tab group for this tab
" }, { "filename": "Titanium.UI.Tab.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Tab.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.Tab.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Tab.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.Tab.title-property", "name": "title", "type": "string", "value": "the title for the tab group for this tab
" }, { "filename": "Titanium.UI.Tab.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Tab.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.Tab.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.Tab.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.Tab.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.Tab.window-property", "name": "window", "type": "object", "value": "the root level tab window. all tabs must have at least one root level tab window.
" }, { "filename": "Titanium.UI.Tab.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.TabGroup": { "deprecated": null, "description": "The Tab Group allows you to manage a tabbed UI of one or more windows. The Tab Group is created by the method Titanium.UI.createTabGroup.
", "events": [ { "filename": "Titanium.UI.TabGroup.blur-event", "name": "blur", "properties": { "index": "the tab index
", "previousIndex": "the previous tab index
", "previousTab": "the previous tab object
", "source": "the source object that fired the event", "tab": "the tab object
", "type": "the name of the event fired" }, "value": "fired when the tab group loses focus
" }, { "filename": "Titanium.UI.TabGroup.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.TabGroup.close-event", "name": "close", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the tab group is closed
" }, { "filename": "Titanium.UI.TabGroup.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.TabGroup.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.TabGroup.focus-event", "name": "focus", "properties": { "index": "the tab index
", "previousIndex": "the previous tab index
", "previousTab": "the previous tab object
", "source": "the source object that fired the event", "tab": "the tab object
", "type": "the name of the event fired" }, "value": "fired when the tab group gains focus
" }, { "filename": "Titanium.UI.TabGroup.open-event", "name": "open", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the tab group is opened
" }, { "filename": "Titanium.UI.TabGroup.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.TabGroup.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.TabGroup.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.TabGroup.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.TabGroup.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.TabGroup.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.TabGroup.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [], "methods": [ { "filename": "Titanium.UI.TabGroup.add-method", "name": "add", "parameters": [ { "description": "the view to add to this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "add a child to the view hierarchy" }, { "filename": "Titanium.UI.TabGroup.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.TabGroup.addTab-method", "name": "addTab", "parameters": [], "returntype": "void", "value": "add a tab to the tab group
" }, { "filename": "Titanium.UI.TabGroup.animate-method", "name": "animate", "parameters": [ { "description": "either a dictionary of animation properties or an Animation object", "name": "obj", "type": "object" }, { "description": "function to be invoked upon completion of the animation", "name": "callback", "type": "function" } ], "returntype": "void", "value": "animate the view" }, { "filename": "Titanium.UI.TabGroup.close-method", "name": "close", "parameters": [], "returntype": "void", "value": "close the tab group and remove it from the UI
" }, { "filename": "Titanium.UI.TabGroup.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.TabGroup.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.TabGroup.open-method", "name": "open", "parameters": [], "returntype": "void", "value": "open the tab group and make it visible
" }, { "filename": "Titanium.UI.TabGroup.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.TabGroup.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.TabGroup.removeTab-method", "name": "removeTab", "parameters": [], "returntype": "void", "value": "remove a tab from the tab group
" }, { "filename": "Titanium.UI.TabGroup.setActiveTab-method", "name": "setActiveTab", "parameters": [ { "description": "an int representing the desired tab index or a reference to the tab object you'd like to switch to", "name": "indexOrObject", "type": "object" } ], "returntype": "void", "value": "select the currently active tab in a tab group
" }, { "filename": "Titanium.UI.TabGroup.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.TabGroup.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.TabGroup.activeTab-property", "name": "activeTab", "type": "object", "value": "the active tab
" }, { "filename": "Titanium.UI.TabGroup.allowUserCustomization-property", "name": "allowUserCustomization", "type": "boolean", "value": "whether or not the user can configure the tab group via the 'More' tab's edit functionality. iPhone/iPad only
" }, { "filename": "Titanium.UI.TabGroup.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.TabGroup.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.TabGroup.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.TabGroup.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.TabGroup.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.TabGroup.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.TabGroup.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.TabGroup.barColor-property", "name": "barColor", "type": "string", "value": "the bar color
" }, { "filename": "Titanium.UI.TabGroup.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.TabGroup.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.TabGroup.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.TabGroup.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TabGroup.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.TabGroup.editButtonTitle-property", "name": "editButtonTitle", "type": "string", "value": "the title for the 'More' tab edit button. iPhone/iPad only
" }, { "filename": "Titanium.UI.TabGroup.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.TabGroup.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TabGroup.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.TabGroup.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TabGroup.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.TabGroup.tabs-property", "name": "tabs", "type": "array", "value": "array of tab objects that are managed by the tab group
" }, { "filename": "Titanium.UI.TabGroup.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TabGroup.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.TabGroup.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.TabGroup.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.TabGroup.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.TabGroup.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.9", "subtype": "view", "type": "object" }, "Titanium.UI.TabbedBar": { "deprecated": null, "description": "A Tabbed Bar is created by the method Titanium.UI.createTabbedBar. The difference between the Tabbed Bar and the Button Bar is that the tabbed bar visually maintains a state (visually distinguished as a pressed or selected look).
", "events": [ { "filename": "Titanium.UI.TabbedBar.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "index[int]": "the index of the button that was clicked
", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a button on the tabbed bar is clicked
" }, { "filename": "Titanium.UI.TabbedBar.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.TabbedBar.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.TabbedBar.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.TabbedBar.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.TabbedBar.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.TabbedBar.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.TabbedBar.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.TabbedBar.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.TabbedBar.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "var bb1 = Titanium.UI.createTabbedBar({\n labels:['One', 'Two', 'Three'],\n backgroundColor:'#336699',\n top:50,\n style:Titanium.UI.iPhone.SystemButtonStyle.BAR,\n height:25,\n width:200\n});\nwin.add(bb1);\nFor iPhone, the style constants are available in the constants defined in Titanium.UI.iPhone.SystemButtonStyle.
", "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.TabbedBar.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.TabbedBar.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.TabbedBar.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the tabbed bar
" }, { "filename": "Titanium.UI.TabbedBar.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.TabbedBar.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.TabbedBar.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.TabbedBar.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.TabbedBar.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.TabbedBar.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.TabbedBar.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.TabbedBar.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TabbedBar.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.TabbedBar.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.TabbedBar.index-property", "name": "index", "type": "int", "value": "the selected index
" }, { "filename": "Titanium.UI.TabbedBar.labels-property", "name": "labels", "type": "array", "value": "the array of labels for the tabbed bar. each object should have the properties title, image, width and enabled.
" }, { "filename": "Titanium.UI.TabbedBar.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TabbedBar.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.TabbedBar.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TabbedBar.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.TabbedBar.style-property", "name": "style", "type": "int", "value": "the style of the tabbed bar
" }, { "filename": "Titanium.UI.TabbedBar.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TabbedBar.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.TabbedBar.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.TabbedBar.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.TabbedBar.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.TabbedBar.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.TableView": { "deprecated": null, "description": "A Table View allows you to create a scrollable table of content in a list-based fashion. The Table View is created by the method Titanium.UI.createTableView.
", "events": [ { "filename": "Titanium.UI.TableView.click-event", "name": "click", "properties": { "detail": "boolean to indicate if the right area was clicked
", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "index": "table view row index
", "row": "table view row object
", "rowData": "table view row data object
", "searchMode": "boolean to indicate if the table is in search mode
", "section": "table view section object
", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a table row is clicked
" }, { "filename": "Titanium.UI.TableView.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.TableView.delete-event", "name": "delete", "properties": { "detail": "boolean to indicate if the right area was clicked
", "index": "table view row index
", "row": "table view row object
", "rowData": "table view row data object
", "searchMode": "boolean to indicate if the table is in search mode
", "section": "table view section object
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when a table row is delete by the user
" }, { "filename": "Titanium.UI.TableView.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.TableView.move-event", "name": "move", "properties": { "detail": "boolean to indicate if the right area was clicked
", "index": "table view row index
", "row": "table view row object
", "rowData": "table view row data object
", "searchMode": "boolean to indicate if the table is in search mode
", "section": "table view section object
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when a table row is moved by the user
" }, { "filename": "Titanium.UI.TableView.scroll-event", "name": "scroll", "properties": { "contentOffset": "dictionary with x and y properties containing the content offset
", "contentSize": "dictionary with width and height properties containing the size of the content (regardless of the display size in the case of scrolling)
", "size": "dictionary with width and height properties containing the size of the visible table view
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the table view is scrolled (currently, iphone only)
" }, { "filename": "Titanium.UI.TableView.scrollEnd-event", "name": "scrollEnd", "properties": { "contentOffset": "dictionary with x and y properties containing the content offset
", "contentSize": "dictionary with width and height properties containing the size of the content (regardless of the display size in the case of scrolling)
", "size": "dictionary with width and height properties containing the size of the visible table view
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the table view stops scrolling (currently, iphone only)
" }, { "filename": "Titanium.UI.TableView.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.TableView.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.TableView.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.TableView.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.TableView.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.TableView.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.TableView.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "The most basic example of a table view.
\nvar data = [{title:\"Row 1\"},{title:\"Row 2\"}];\nvar table = Titanium.UI.createTableView({data:data});\nwin.add(table);\nappend a row to the table, optionally with animation
" }, { "filename": "Titanium.UI.TableView.deleteRow-method", "name": "deleteRow", "parameters": [ { "description": "row to delete", "name": "row", "type": "object" }, { "description": "animation properties", "name": "properties", "type": "object" } ], "returntype": "void", "value": "delete an existing row, optionally with animation
" }, { "filename": "Titanium.UI.TableView.deselectRow-method", "name": "deselectRow", "parameters": [ { "description": "row index to deselect", "name": "row", "type": "int" } ], "returntype": "void", "value": "programmatically deselect a row
" }, { "filename": "Titanium.UI.TableView.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.TableView.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.TableView.insertRowAfter-method", "name": "insertRowAfter", "parameters": [ { "description": "index", "name": "index", "type": "int" }, { "description": "row to insert", "name": "row", "type": "object" }, { "description": "animation properties", "name": "properties", "type": "object" } ], "returntype": "void", "value": "insert a row before another row, optionally with animation
" }, { "filename": "Titanium.UI.TableView.insertRowBefore-method", "name": "insertRowBefore", "parameters": [ { "description": "index", "name": "index", "type": "int" }, { "description": "row to insert", "name": "row", "type": "object" }, { "description": "animation properties", "name": "properties", "type": "object" } ], "returntype": "void", "value": "insert a row after another row, optionally with animation
" }, { "filename": "Titanium.UI.TableView.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.TableView.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.TableView.scrollToIndex-method", "name": "scrollToIndex", "parameters": [ { "description": "index", "name": "index", "type": "int" }, { "description": "animation properties. position property controls the position constant to use for position (on iPhone, use constants from Titanium.UI.iPhone.TableViewScrollPosition).", "name": "properties", "type": "object" } ], "returntype": "void", "value": "scroll to a specific row index and ensure that that row is on screen
" }, { "filename": "Titanium.UI.TableView.scrollToTop-method", "name": "scrollToTop", "parameters": [ { "description": "y position", "name": "top", "type": "float" }, { "description": "optional dictionary with the key animated (default, true) as boolean to indicate if the scroll should be animated or immediate", "name": "properties", "type": "object" } ], "returntype": "void", "value": "scroll the table to a specific top position where 0 is the topmost y position in the table view
" }, { "filename": "Titanium.UI.TableView.selectRow-method", "name": "selectRow", "parameters": [ { "description": "row index to select", "name": "row", "type": "int" } ], "returntype": "void", "value": "programmatically select a row
" }, { "filename": "Titanium.UI.TableView.setData-method", "name": "setData", "parameters": [ { "description": "data array of rows either as objects or row objects", "name": "data", "type": "array" }, { "description": "animation properties", "name": "properties", "type": "object" } ], "returntype": "void", "value": "set the data in the table, optionally with animation
" }, { "filename": "Titanium.UI.TableView.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.TableView.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" }, { "filename": "Titanium.UI.TableView.updateRow-method", "name": "updateRow", "parameters": [ { "description": "row data to update", "name": "row", "type": "object" }, { "description": "animation properties", "name": "properties", "type": "object" } ], "returntype": "void", "value": "update an existing row, optionally with animation
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.TableView.allowsSelection-property", "name": "allowsSelection", "type": "boolean", "value": "true if the rows can be selected
" }, { "filename": "Titanium.UI.TableView.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.TableView.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.TableView.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the table view
" }, { "filename": "Titanium.UI.TableView.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.TableView.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image to render in the background of the table view
" }, { "filename": "Titanium.UI.TableView.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.TableView.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.TableView.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.TableView.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.TableView.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.TableView.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TableView.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.TableView.data-property", "name": "data", "type": "array", "value": "the data array of objects to be used for the rows of the table view
" }, { "filename": "Titanium.UI.TableView.editable-property", "name": "editable", "type": "boolean", "value": "allow the table view to be editable (this must be true for swipe-to-delete)
" }, { "filename": "Titanium.UI.TableView.editing-property", "name": "editing", "type": "boolean", "value": "boolean to control the editing state of the table view
" }, { "filename": "Titanium.UI.TableView.filterAttribute-property", "name": "filterAttribute", "type": "string", "value": "the filter attribute to be used when searching. this property maps to your data object or a property on the row object
" }, { "filename": "Titanium.UI.TableView.filterCaseInsensitive-property", "name": "filterCaseInsensitive", "type": "boolean", "value": "boolean to indicate if the search should be case sensitive or case insensitive (default)
" }, { "filename": "Titanium.UI.TableView.footerTitle-property", "name": "footerTitle", "type": "string", "value": "the table view footer title
" }, { "filename": "Titanium.UI.TableView.footerView-property", "name": "footerView", "type": "object", "value": "the table view footer as a view that will be rendered instead of a label
" }, { "filename": "Titanium.UI.TableView.headerTitle-property", "name": "headerTitle", "type": "string", "value": "the table view header title
" }, { "filename": "Titanium.UI.TableView.headerView-property", "name": "headerView", "type": "object", "value": "the table view header as a view that will be rendered instead of a label
" }, { "filename": "Titanium.UI.TableView.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.TableView.index-property", "name": "index", "type": "array", "value": "an array of objects (with title and index properties) to control the table view index
" }, { "filename": "Titanium.UI.TableView.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TableView.maxRowHeight-property", "name": "maxRowHeight", "type": "float", "value": "max row height for table view rows
" }, { "filename": "Titanium.UI.TableView.minRowHeight-property", "name": "minRowHeight", "type": "float", "value": "min row height for table view rows
" }, { "filename": "Titanium.UI.TableView.moving-property", "name": "moving", "type": "boolean", "value": "boolean to control the moveable state of the table view
" }, { "filename": "Titanium.UI.TableView.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.TableView.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TableView.rowHeight-property", "name": "rowHeight", "type": "float", "value": "default row height for table view rows
" }, { "filename": "Titanium.UI.TableView.scrollable-property", "name": "scrollable", "type": "boolean", "value": "true (default) if tableview can be scrolled
" }, { "filename": "Titanium.UI.TableView.search-property", "name": "search", "type": "object", "value": "the search field to use for the table view
" }, { "filename": "Titanium.UI.TableView.searchHidden-property", "name": "searchHidden", "type": "boolean", "value": "boolean to control the visibility of the search field
" }, { "filename": "Titanium.UI.TableView.separatorColor-property", "name": "separatorColor", "type": "string", "value": "the separator color color as a hex or named value
" }, { "filename": "Titanium.UI.TableView.separatorStyle-property", "name": "separatorStyle", "type": "int", "value": "the separator style constant. For iPhone, Titanium.UI.iPhone.TableViewSeparatorStyle
" }, { "filename": "Titanium.UI.TableView.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.TableView.style-property", "name": "style", "type": "int", "value": "iPhone only. the style of the table view. constant from Titanium.UI.iPhone.TableViewStyle
" }, { "filename": "Titanium.UI.TableView.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TableView.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.TableView.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.TableView.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.TableView.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.TableView.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.TableViewRow": { "deprecated": null, "description": "A TableView row object created by the method Titanium.UI.createTableViewRow.
", "events": [ { "filename": "Titanium.UI.TableViewRow.click-event", "name": "click", "properties": { "detail": "boolean to indicate if the right area was clicked
", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "index": "table view row index
", "row": "table view row object
", "rowData": "table view row data object
", "searchMode": "boolean to indicate if the table is in search mode
", "section": "table view section object
", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the row is clicked. row events automatically propagate to the section and table view if an event listener is not added directly to the cell.
" }, { "filename": "Titanium.UI.TableViewRow.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.TableViewRow.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.TableViewRow.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.TableViewRow.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.TableViewRow.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.TableViewRow.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.TableViewRow.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.TableViewRow.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.TableViewRow.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "In this simple example, we create a table view row with a red square in the cell.
\nvar row = Titanium.UI.createTableViewRow();\nvar view = Titanium.UI.createView({backgroundColor:'red',width:20,height:20});\nrow.height = 'auto';\nrow.add(view);\nMake sure you set the tableClass on each row instance if using more than one type of row layout. You can use the same value for each instance of a row where the layout is the same - even if the value of the elements inside the row have different values. For example, if the text is the only thing different between two cells but the layout is the same, both row instances should have the same value for tableClass.
\nYou can listen for table row events on all rows by adding an event listener to the table view instance. Events automatically propagate to parent views.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.TableViewRow.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.TableViewRow.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.TableViewRow.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background cell color
" }, { "filename": "Titanium.UI.TableViewRow.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.TableViewRow.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background cell image
" }, { "filename": "Titanium.UI.TableViewRow.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.TableViewRow.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.TableViewRow.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.TableViewRow.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.TableViewRow.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.TableViewRow.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TableViewRow.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.TableViewRow.className-property", "name": "className", "type": "string", "value": "the class name of the table. each table view cell must have a unique class name if the cell layout is different. however, use the same name for rows that have the same structural layout (even if the content is different) to provide maximum rendering performance.
" }, { "filename": "Titanium.UI.TableViewRow.color-property", "name": "color", "type": "string", "value": "default color of the row when not selected
" }, { "filename": "Titanium.UI.TableViewRow.hasCheck-property", "name": "hasCheck", "type": "boolean", "value": "render a system provided check mark in the right image area of the row cell
" }, { "filename": "Titanium.UI.TableViewRow.hasChild-property", "name": "hasChild", "type": "boolean", "value": "render a system provided right arrow in the right image area of the row cell
" }, { "filename": "Titanium.UI.TableViewRow.hasDetail-property", "name": "hasDetail", "type": "boolean", "value": "render a system provided blue indicator icon in the right image area of the row cell
" }, { "filename": "Titanium.UI.TableViewRow.height-property", "name": "height", "type": "float", "value": "the height of the row. specify auto to calculate the row height based on the size of the child views of the row
" }, { "filename": "Titanium.UI.TableViewRow.indentionLevel-property", "name": "indentionLevel", "type": "int", "value": "the indention level for the cell (defaults to 0)
" }, { "filename": "Titanium.UI.TableViewRow.layout-property", "name": "layout", "type": "string", "value": "the layout algorithm to use for the layout. either absolute (default) or vertical.
" }, { "filename": "Titanium.UI.TableViewRow.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TableViewRow.leftImage-property", "name": "leftImage", "type": "string", "value": "image url to render in the left image area of the row cell
" }, { "filename": "Titanium.UI.TableViewRow.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.TableViewRow.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TableViewRow.rightImage-property", "name": "rightImage", "type": "string", "value": "image url to render in the right image area of the row cell
" }, { "filename": "Titanium.UI.TableViewRow.selectedBackgroundColor-property", "name": "selectedBackgroundColor", "type": "string", "value": "the background color to render when the row cell is selected
" }, { "filename": "Titanium.UI.TableViewRow.selectedBackgroundImage-property", "name": "selectedBackgroundImage", "type": "string", "value": "the background image to render when the row cell is selected
" }, { "filename": "Titanium.UI.TableViewRow.selectedColor-property", "name": "selectedColor", "type": "string", "value": "color of the row during selection
" }, { "filename": "Titanium.UI.TableViewRow.selectionStyle-property", "name": "selectionStyle", "type": "int", "value": "a selection style constant to control the selection color. For iPhone, use the constants from Titanium.UI.iPhone.TableViewCellSelectionStyle
" }, { "filename": "Titanium.UI.TableViewRow.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.TableViewRow.title-property", "name": "title", "type": "string", "value": "the title cell value. do not specify if using views as children of the row
" }, { "filename": "Titanium.UI.TableViewRow.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TableViewRow.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.TableViewRow.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.TableViewRow.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.TableViewRow.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.TableViewRow.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.9", "subtype": "view", "type": "object" }, "Titanium.UI.TableViewSection": { "deprecated": null, "description": "A TableView section object created by the method Titanium.UI.createTableViewSection.
", "events": [ { "filename": "Titanium.UI.TableViewSection.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.TableViewSection.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.TableViewSection.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.TableViewSection.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.TableViewSection.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.TableViewSection.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.TableViewSection.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.TableViewSection.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.TableViewSection.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.TableViewSection.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "In this example, we create a section with the header Hello and add two rows to it.
\nvar section = Titanium.UI.createTableViewSection();\nsection.headerTitle = \"Hello\";\nvar row1 = Titanium.UI.createTableViewRow({title:\"Hello 1\"});\nvar row2 = Titanium.UI.createTableViewRow({title:\"Hello 2\"});\nsection.add(row1);\nsection.add(row2);\ntableview.add(section);\nadd a row to the section
" }, { "filename": "Titanium.UI.TableViewSection.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.TableViewSection.animate-method", "name": "animate", "parameters": [ { "description": "either a dictionary of animation properties or an Animation object", "name": "obj", "type": "object" }, { "description": "function to be invoked upon completion of the animation", "name": "callback", "type": "function" } ], "returntype": "void", "value": "animate the view" }, { "filename": "Titanium.UI.TableViewSection.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.TableViewSection.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.TableViewSection.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" }, { "description": "the row object to remove from the section", "name": "row", "type": "object" } ], "returntype": "void", "value": "remove a remove from the section
" }, { "filename": "Titanium.UI.TableViewSection.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.TableViewSection.rowAtIndex-method", "name": "rowAtIndex", "parameters": [], "returntype": "void", "value": "retrieve the row object at a specific index
" }, { "filename": "Titanium.UI.TableViewSection.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.TableViewSection.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.TableViewSection.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.TableViewSection.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.TableViewSection.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.TableViewSection.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.TableViewSection.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.TableViewSection.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.TableViewSection.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.TableViewSection.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.TableViewSection.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.TableViewSection.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.TableViewSection.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TableViewSection.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.TableViewSection.footerTitle-property", "name": "footerTitle", "type": "string", "value": "the title of the section footer
" }, { "filename": "Titanium.UI.TableViewSection.footerView-property", "name": "footerView", "type": "object", "value": "a view to use instead of the default label when rendering the section footer
" }, { "filename": "Titanium.UI.TableViewSection.headerTitle-property", "name": "headerTitle", "type": "string", "value": "the title of the section header
" }, { "filename": "Titanium.UI.TableViewSection.headerView-property", "name": "headerView", "type": "object", "value": "a view to use instead of the default label when rendering the section header
" }, { "filename": "Titanium.UI.TableViewSection.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.TableViewSection.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TableViewSection.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.TableViewSection.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TableViewSection.rowCount-property", "name": "rowCount", "type": "int", "value": "the (readonly) number of rows in the section
" }, { "filename": "Titanium.UI.TableViewSection.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.TableViewSection.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TableViewSection.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.TableViewSection.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.TableViewSection.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.TableViewSection.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.TableViewSection.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.9", "subtype": "view", "type": "object" }, "Titanium.UI.TextArea": { "deprecated": null, "description": "A Text Area is created by the method Titanium.UI.createTextArea. The Text Area is a multiline field.
", "events": [ { "filename": "Titanium.UI.TextArea.blur-event", "name": "blur", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "value": "the value of the field upon blur
" }, "value": "fired when the field loses focus
" }, { "filename": "Titanium.UI.TextArea.change-event", "name": "change", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "value": "the value of the field upon change
" }, "value": "fired when the field value changes
" }, { "filename": "Titanium.UI.TextArea.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.TextArea.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.TextArea.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.TextArea.focus-event", "name": "focus", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "value": "the value of the field upon focus
" }, "value": "fired when the field gains focus
" }, { "filename": "Titanium.UI.TextArea.return-event", "name": "return", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "value": "the value of the field upon return
" }, "value": "fired when the field return key is pressed on the keyboard
" }, { "filename": "Titanium.UI.TextArea.selected-event", "name": "selected", "properties": { "range": "the range of text. range is an object with the properties location and length.
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the text in the field is selected
" }, { "filename": "Titanium.UI.TextArea.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.TextArea.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.TextArea.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.TextArea.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.TextArea.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.TextArea.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.TextArea.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "This example created a highly customized text area.
\nvar ta1 = Titanium.UI.createTextArea({\n value:'I am a textarea',\n height:70,\n width:300,\n top:60,\n font:{fontSize:20,fontFamily:'Marker Felt', fontWeight:'bold'},\n color:'#888',\n textAlign:'left',\n appearance:Titanium.UI.KEYBOARD_APPEARANCE_ALERT, \n keyboardType:Titanium.UI.KEYBOARD_NUMBERS_PUNCTUATION,\n returnKeyType:Titanium.UI.RETURNKEY_EMERGENCY_CALL,\n borderWidth:2,\n borderColor:'#bbb',\n borderRadius:5\n});\nforce the field to lose focus
" }, { "filename": "Titanium.UI.TextArea.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.TextArea.focus-method", "name": "focus", "parameters": [], "returntype": "void", "value": "force the field to gain focus
" }, { "filename": "Titanium.UI.TextArea.hasText-method", "name": "hasText", "parameters": [], "returntype": "void", "value": "return boolean (true) if the field has text
" }, { "filename": "Titanium.UI.TextArea.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.TextArea.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.TextArea.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.TextArea.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.TextArea.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "Both Text Areas and Text Fields can control the buttons displayed in a button bar above the keyboard when it's visible.
\nExample using a custom keyboard toolbar:
\nvar textfield = Titanium.UI.createTextField({\n color:'#336699',\n value:'Focus to see keyboard w/ toolbar',\n height:35,\n width:300,\n top:10,\n borderStyle:Titanium.UI.INPUT_BORDERSTYLE_ROUNDED,\n keyboardToolbar:[flexSpace,camera, flexSpace,tf,flexSpace, send,flexSpace],\n keyboardToolbarColor: '#999', \n keyboardToolbarHeight: 40,\n});\nvalue of the background color of the field
" }, { "filename": "Titanium.UI.TextArea.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.TextArea.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.TextArea.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.TextArea.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.TextArea.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.TextArea.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.TextArea.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.TextArea.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TextArea.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.TextArea.editable-property", "name": "editable", "type": "boolean", "value": "boolean indicating if the field is editable
" }, { "filename": "Titanium.UI.TextArea.enabled-property", "name": "enabled", "type": "boolean", "value": "boolean indicating the enabled state of the field
" }, { "filename": "Titanium.UI.TextArea.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.TextArea.keyboardToolbar-property", "name": "keyboardToolbar", "type": "array", "value": "array of toolbar button objects to be used when the keyboard is displayed
" }, { "filename": "Titanium.UI.TextArea.keyboardToolbarColor-property", "name": "keyboardToolbarColor", "type": "string", "value": "the color of the keyboard toolbar
" }, { "filename": "Titanium.UI.TextArea.keyboardToolbarHeight-property", "name": "keyboardToolbarHeight", "type": "float", "value": "the height of the keyboard toolbar
" }, { "filename": "Titanium.UI.TextArea.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TextArea.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.TextArea.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TextArea.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.TextArea.suppressReturn-property", "name": "suppressReturn", "type": "boolean", "value": "boolean to indicate if the return key should be suppressed during entry
" }, { "filename": "Titanium.UI.TextArea.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TextArea.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.TextArea.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.TextArea.value-property", "name": "value", "type": "string", "value": "value of the field
" }, { "filename": "Titanium.UI.TextArea.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.TextArea.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.TextArea.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.TextField": { "deprecated": null, "description": "A Text Area is created by the method Titanium.UI.createTextField. The Text Field is a single line field.
", "events": [ { "filename": "Titanium.UI.TextField.blur-event", "name": "blur", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "value": "the value of the field upon blur
" }, "value": "fired when the field loses focus
" }, { "filename": "Titanium.UI.TextField.change-event", "name": "change", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "value": "the value of the field upon change
" }, "value": "fired when the field value changes
" }, { "filename": "Titanium.UI.TextField.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.TextField.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.TextField.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.TextField.focus-event", "name": "focus", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "value": "the value of the field upon focus
" }, "value": "fired when the field gains focus
" }, { "filename": "Titanium.UI.TextField.return-event", "name": "return", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the field return key is pressed on the keyboard
" }, { "filename": "Titanium.UI.TextField.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.TextField.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.TextField.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.TextField.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.TextField.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.TextField.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.TextField.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "Create a simple text field with a round border style.
\nvar tf1 = Titanium.UI.createTextField({\n color:'#336699',\n height:35,\n top:10,\n left:10,\n width:250,\n borderStyle:Titanium.UI.INPUT_BORDERSTYLE_ROUNDED\n});\nforce the field to lose focus
" }, { "filename": "Titanium.UI.TextField.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.TextField.focus-method", "name": "focus", "parameters": [], "returntype": "void", "value": "force the field to gain focus
" }, { "filename": "Titanium.UI.TextField.hasText-method", "name": "hasText", "parameters": [], "returntype": "void", "value": "return boolean (true) if the field has text
" }, { "filename": "Titanium.UI.TextField.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.TextField.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.TextField.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.TextField.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.TextField.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "On iPhone, the borderStyle can be set with a constant from Titanium.UI.
\nBoth Text Areas and Text Fields can control the buttons displayed in a button bar above the keyboard when it's visible.
\nExample using a custom keyboard toolbar:
\nvar textfield = Titanium.UI.createTextField({\n color:'#336699',\n value:'Focus to see keyboard w/ toolbar',\n height:35,\n width:300,\n top:10,\n borderStyle:Titanium.UI.INPUT_BORDERSTYLE_ROUNDED,\n keyboardToolbar:[flexSpace,camera, flexSpace,tf,flexSpace, send,flexSpace],\n keyboardToolbarColor: '#999', \n keyboardToolbarHeight: 40,\n});\nvalue of the background color of the field
" }, { "filename": "Titanium.UI.TextField.backgroundDisabledImage-property", "name": "backgroundDisabledImage", "type": "string", "value": "the image url to the background image of the field when in the disabled state
" }, { "filename": "Titanium.UI.TextField.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.TextField.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the image url to the background image of the field
" }, { "filename": "Titanium.UI.TextField.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.TextField.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.TextField.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.TextField.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.TextField.borderStyle-property", "name": "borderStyle", "type": "int", "value": "the border style constant for the field
" }, { "filename": "Titanium.UI.TextField.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.TextField.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TextField.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.TextField.clearButtonMode-property", "name": "clearButtonMode", "type": "int", "value": "the mode constant for how to handle displaying the clear button
" }, { "filename": "Titanium.UI.TextField.clearOnEdit-property", "name": "clearOnEdit", "type": "boolean", "value": "boolean that indicates if the value of the field is cleared upon editing
" }, { "filename": "Titanium.UI.TextField.editable-property", "name": "editable", "type": "boolean", "value": "boolean indicating if the field is editable
" }, { "filename": "Titanium.UI.TextField.enabled-property", "name": "enabled", "type": "boolean", "value": "boolean indicating the enabled state of the field
" }, { "filename": "Titanium.UI.TextField.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.TextField.hintText-property", "name": "hintText", "type": "string", "value": "the hint text to display when the field is unfocused
" }, { "filename": "Titanium.UI.TextField.keyboardToolbar-property", "name": "keyboardToolbar", "type": "array", "value": "array of toolbar button objects to be used when the keyboard is displayed
" }, { "filename": "Titanium.UI.TextField.keyboardToolbarColor-property", "name": "keyboardToolbarColor", "type": "string", "value": "the color of the keyboard toolbar
" }, { "filename": "Titanium.UI.TextField.keyboardToolbarHeight-property", "name": "keyboardToolbarHeight", "type": "float", "value": "the height of the keyboard toolbar
" }, { "filename": "Titanium.UI.TextField.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TextField.leftButton-property", "name": "leftButton", "type": "object", "value": "the left button view
" }, { "filename": "Titanium.UI.TextField.leftButtonMode-property", "name": "leftButtonMode", "type": "int", "value": "the mode of the left button view
" }, { "filename": "Titanium.UI.TextField.leftButtonPadding-property", "name": "leftButtonPadding", "type": "float", "value": "the left padding of the space between the button and the edge of the field
" }, { "filename": "Titanium.UI.TextField.minimumFontSize-property", "name": "minimumFontSize", "type": "int", "value": "the minimum size of the font when the font is sized based on the contents. Enables font scaling to fit
" }, { "filename": "Titanium.UI.TextField.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.TextField.paddingLeft-property", "name": "paddingLeft", "type": "float", "value": "the left padding of the text field
" }, { "filename": "Titanium.UI.TextField.paddingRight-property", "name": "paddingRight", "type": "float", "value": "the right padding of the text field
" }, { "filename": "Titanium.UI.TextField.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TextField.rightButton-property", "name": "rightButton", "type": "object", "value": "the right button view
" }, { "filename": "Titanium.UI.TextField.rightButtonMode-property", "name": "rightButtonMode", "type": "int", "value": "the mode of the right button view
" }, { "filename": "Titanium.UI.TextField.rightButtonPadding-property", "name": "rightButtonPadding", "type": "float", "value": "the right padding of the space between the button and the edge of the field
" }, { "filename": "Titanium.UI.TextField.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.TextField.suppressReturn-property", "name": "suppressReturn", "type": "boolean", "value": "boolean to indicate if the return key should be suppressed during entry
" }, { "filename": "Titanium.UI.TextField.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.TextField.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.TextField.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.TextField.value-property", "name": "value", "type": "string", "value": "value of the field
" }, { "filename": "Titanium.UI.TextField.verticalAlign-property", "name": "verticalAlign", "type": "int,string", "value": "the constant or string value for the fields vertical alignment.
" }, { "filename": "Titanium.UI.TextField.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.TextField.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.TextField.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.Toolbar": { "deprecated": null, "description": "A Toolbar is created by the method Titanium.UI.createToolbar. A Toolbar can be placed at the bottom of a window and contain buttons.
", "events": [ { "filename": "Titanium.UI.Toolbar.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.Toolbar.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.Toolbar.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.Toolbar.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.Toolbar.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.Toolbar.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.Toolbar.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.Toolbar.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.Toolbar.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.Toolbar.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [], "methods": [ { "filename": "Titanium.UI.Toolbar.add-method", "name": "add", "parameters": [ { "description": "the view to add to this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "add a child to the view hierarchy" }, { "filename": "Titanium.UI.Toolbar.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.Toolbar.animate-method", "name": "animate", "parameters": [ { "description": "either a dictionary of animation properties or an Animation object", "name": "obj", "type": "object" }, { "description": "function to be invoked upon completion of the animation", "name": "callback", "type": "function" } ], "returntype": "void", "value": "animate the view" }, { "filename": "Titanium.UI.Toolbar.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.Toolbar.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.Toolbar.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.Toolbar.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.Toolbar.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.Toolbar.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "", "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.Toolbar.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.Toolbar.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.Toolbar.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.Toolbar.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.Toolbar.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.Toolbar.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.Toolbar.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.Toolbar.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.Toolbar.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.Toolbar.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.Toolbar.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Toolbar.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.Toolbar.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.Toolbar.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Toolbar.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.Toolbar.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Toolbar.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.Toolbar.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Toolbar.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.Toolbar.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.Toolbar.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.Toolbar.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.Toolbar.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.View": { "deprecated": null, "description": "The View is an empty drawing surface or container. The View is created by the method Titanium.UI.createView.
", "events": [ { "filename": "Titanium.UI.View.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.View.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.View.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.View.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.View.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.View.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.View.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.View.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.View.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.View.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "Create a rounded view.
\nvar view = Titanium.UI.createView({\n borderRadius:10,\n backgroundColor:'red',\n width:50,\n height:50\n});\nwindow.add(view);\nThe Web View allows you to open an HTML5 based view which can load either local or remote content. The content can be any valid web content such as HTML, PDF, SVG or other WebKit supported content types. The Web View is created by the method Titanium.UI.createWebView.
", "events": [ { "filename": "Titanium.UI.WebView.beforeload-event", "name": "beforeload", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "url": "the url of the web document
" }, "value": "fired before the webview starts loading its content
" }, { "filename": "Titanium.UI.WebView.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.WebView.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.WebView.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.WebView.error-event", "name": "error", "properties": { "message": "the error message
", "source": "the source object that fired the event", "type": "the name of the event fired", "url": "the url of the web document
" }, "value": "fired when the webview cannot load the content
" }, { "filename": "Titanium.UI.WebView.load-event", "name": "load", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired", "url": "the url of the web document
" }, "value": "fired when the webview is loaded
" }, { "filename": "Titanium.UI.WebView.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.WebView.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.WebView.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.WebView.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.WebView.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.WebView.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.WebView.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "Create a web view to a remote URL and open the window as modal.
\n var webview = Titanium.UI.createWebView({url:'http://www.appcelerator.com'});\n var window = Titanium.UI.createWindow();\n window.add(webview);\n window.open({modal:true});\nreturns true if the webview can go back in history
" }, { "filename": "Titanium.UI.WebView.canGoForward-method", "name": "canGoForward", "parameters": [], "returntype": "boolean", "value": "returns true if the webview can go forward in history
" }, { "filename": "Titanium.UI.WebView.evalJS-method", "name": "evalJS", "parameters": [ { "description": "JavaScript code as a string. The code will be evaluated inside the webview context.", "name": "content", "type": "string" } ], "returntype": "string", "value": "invoke JavaScript inside the context of the webview and optionally, return a result
" }, { "filename": "Titanium.UI.WebView.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.WebView.goBack-method", "name": "goBack", "parameters": [], "returntype": "void", "value": "go back one entry in history to the previous page
" }, { "filename": "Titanium.UI.WebView.goForward-method", "name": "goForward", "parameters": [], "returntype": "void", "value": "go forward one entry in history to the page before the current page
" }, { "filename": "Titanium.UI.WebView.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.WebView.reload-method", "name": "reload", "parameters": [], "returntype": "void", "value": "reload the current webpage
" }, { "filename": "Titanium.UI.WebView.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.WebView.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.WebView.repaint-method", "name": "repaint", "parameters": [], "returntype": "void", "value": "force the webview to repaint its contents
" }, { "filename": "Titanium.UI.WebView.setBasicAuthentication-method", "name": "setBasicAuthentication", "parameters": [ { "description": "the username", "name": "username", "type": "string" }, { "description": "the password", "name": "password", "type": "string" } ], "returntype": "void", "value": "set the basic authentication for the webview instance to be used on subsequent url requests
" }, { "filename": "Titanium.UI.WebView.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.WebView.stopLoading-method", "name": "stopLoading", "parameters": [], "returntype": "void", "value": "stop loading a currently loading page
" }, { "filename": "Titanium.UI.WebView.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "Creating webviews are more expensive than creating pure native views because of the requirement toload the HTML browser into memory.
\nSince a webview internally wants to handle its own events, scrolling and other related touch events against it's own view surface, you cannot have both Titanium style events against the webview instance and internal Javascript events in the DOM. You must choose between one or the other.
", "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.WebView.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.WebView.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.WebView.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color for the webview
" }, { "filename": "Titanium.UI.WebView.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.WebView.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.WebView.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.WebView.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.WebView.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.WebView.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.WebView.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.WebView.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.WebView.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.WebView.data-property", "name": "data", "type": "object", "value": "a data blob or file that is used to load the web document
" }, { "filename": "Titanium.UI.WebView.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.WebView.html-property", "name": "html", "type": "string", "value": "the html content of the web document
" }, { "filename": "Titanium.UI.WebView.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.WebView.loading-property", "name": "loading", "type": "boolean", "value": "boolean indicating if the webview is loading content
" }, { "filename": "Titanium.UI.WebView.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.WebView.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.WebView.scalesPageToFit-property", "name": "scalesPageToFit", "type": "boolean", "value": "whether the webview should scale it's contents or not
" }, { "filename": "Titanium.UI.WebView.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.WebView.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.WebView.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.WebView.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.WebView.url-property", "name": "url", "type": "string", "value": "the url to the web document. this property will change as the content of the webview changes (such as from internal hyperlinks, etc)
" }, { "filename": "Titanium.UI.WebView.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.WebView.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.WebView.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.8", "subtype": "view", "type": "object" }, "Titanium.UI.Window": { "deprecated": null, "description": "The Window is an empty drawing surface or container. The Window is created by the method Titanium.UI.createWindow. Unlike Views, Windows can be opened and closed and can have special display properties such as fullscreen or modal.
", "events": [ { "filename": "Titanium.UI.Window.blur-event", "name": "blur", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the window loses focus
" }, { "filename": "Titanium.UI.Window.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.Window.close-event", "name": "close", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the window is closed
" }, { "filename": "Titanium.UI.Window.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.Window.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.Window.focus-event", "name": "focus", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the window gains focus
" }, { "filename": "Titanium.UI.Window.open-event", "name": "open", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "fired when the window is opened
" }, { "filename": "Titanium.UI.Window.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.Window.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.Window.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.Window.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.Window.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.Window.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.Window.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "Create a fullscreen window with a red background.
\nvar window = Titanium.UI.createWindow({\n backgroundColor:'red'\n});\nwindow.open({fullscreen:true});\nclose the window
" }, { "filename": "Titanium.UI.Window.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.Window.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.Window.open-method", "name": "open", "parameters": [ { "description": "open the window with optional animation or display properties", "name": "options", "type": "object" } ], "returntype": "void", "value": "open the window
" }, { "filename": "Titanium.UI.Window.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.Window.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.Window.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.Window.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "Windows can be loaded from another Javascript file by specifying the property url and reference a file relative to your application Resources folder. It's important to note that Titanium will refuse to load Javascript files from a remote URL. Loading remote Javascript from a URL and providing it with the full capabilities of the Titanium API would be very dangerous.
\nWhen you Window is loaded from a separate Javascript file, the code will be executed in a separate Javascript context (called a \"sub-context\") than your app.js global context. It will also execute in its own separate thread.
\n
The special property Titanium.UI.currentWindow is available inside a sub-context that points to the Javascript instance by reference in the global context.
\n
By default, sub-context variables cannot access Javascript references in the global context. However, the global context can allow its sub-contexts the ability to have access to properties and functions in the global context by reference assignment. An example best illustrates how to do this.
\nIn app.js, you could define a function and a property.
\nvar a = 1;\nfunction b()\n{\n return \"hello\";\n}\nNow, you can create a new Window - let's call it foo.js - in your app.js.
\nvar w = Titanium.UI.createWindow({\n url:'foo.js'\n});\nTo give your new window access to both a and b, you would need to assign them to the new window reference w.
\nw.a = a;\nw.b = b;\nOf course, you could give them a different name than their original names. However, what name you give them in your app.js is how you will reference them in foo.js. Now, let's look at the code for foo.js.
\nalert(\"b() = \"+Titanium.UI.currentWindow.b());\nIn the above code, the foo.js will execute the function b in the global context and return the result. Since b is a reference (vs. a copy by value), any changes made to these Javascript references will be immediately available in all sub-contexts.
\nIf you'd like to send events to a window from the global context and vice versa, you could use the built-in event mechanism. For example, you could define a custom event called foo. The window could listen for this event and then respond with some action. For example, in your sub-context you might define:
\nTitanium.UI.currentWindow.addEventListener('foo',function(e)\n{\n Titanium.API.info(\"foo event received = \"+JSON.stringify(e));\n});\nYou could now fire the event from app.js like this:
\nvar window = Titanium.UI.createWindow({\n url:'bar.js'\n});\nwindow.open();\nwindow.fireEvent('foo',{a:'b'});\nIt's worth noting two important limitations of the example above:
\nWindows can be animated like any normal View. To transition between 2 windows, you can use the transition property on an animation. For example, to flip right-to-left between two windows, you could do the following:
\nvar window2 = Titanium.UI.createWindow({url:'foo.js'});\nvar t = Ti.UI.iPhone.AnimationStyle.FLIP_FROM_LEFT;\nwindow1.animate({view:window2,transition:t});\nIn the above example, the window2 view will be animated from the right-to-left over window1.
\nWindows can be opened or closed with animation. In the example below, we create a window that will open from small to large with a bounce effect. This is done by applying a transformation at initialization time that scales the original size of the window to 0. When the window is opened, a new 2D transformation is applied that will scale the window size from 0 to 110% of it's original size and then, after 1/20th of a second, will scale it back to it's original size at 100%. This gives the bounce effect during animation.
\nvar t = Titanium.UI.create2DMatrix().scale(0);\n\n// create a window with the initial transform scaled to 0\nvar w = Titanium.UI.createWindow({\n backgroundColor:'#336699',\n borderWidth:8,\n borderColor:'#999',\n height:400,\n width:300,\n borderRadius:10,\n opacity:0.92,\n transform:t\n});\n\n// create first transform to go beyond normal size\nvar t1 = Titanium.UI.create2DMatrix().scale(1.1);\n\nvar a = Titanium.UI.createAnimation();\na.transform = t1;\na.duration = 200;\n\n// when this animation completes, scale to normal size\na.addEventListener('complete', function()\n{\n // we can use the identity transform to take it back to it's real size\n var t2 = Titanium.UI.create2DMatrix();\n w.animate({transform:t2, duration:200});\n});\nFor iPad, iPhone SDK 3.2 and Titanium 1.2 introduced several new ways of presenting modal windows.
\n
The example below is a modal window.
\n
You can create this type of modal window on iPad with the following code snippet:
\nvar window = Titanium.UI.createWindow();\nwindow.open({\n modal:true,\n modalTransitionStyle: Ti.UI.iPhone.MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL,\n modalStyle: Ti.UI.iPhone.MODAL_PRESENTATION_FORMSHEET\n})\nIn Android, you may wish to specify that a window which you create (such as the first window) should be considered the root window and that the application should exit when the back button is pressed from that window. This is particularly useful if your application is not using a Tab Group and therefore the splash screen window is appearing whenever you press the back button from your lowest window on the stack.
\nTo indicate that a particular window should cause an application to exit when the back button is pressed, pass exitOnClose: true as one of the creation arguments, as shown here:
\nvar win = Titanium.UI.createWindow({\n title: 'My Root Window',\n exitOnClose: true\n});\ntitle for the back button. only available in iPhone. this is only valid when the window is a child of a tab.
" }, { "filename": "Titanium.UI.Window.backButtonTitleImage-property", "name": "backButtonTitleImage", "type": "string", "value": "url to an image to show as the back button. only available in iPhone. this is only valid when the window is a child of a tab.
" }, { "filename": "Titanium.UI.Window.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.Window.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.Window.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.Window.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.Window.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.Window.barColor-property", "name": "barColor", "type": "string", "value": "web named color or hex value for the color of the nav bar. only available in iPhone.
" }, { "filename": "Titanium.UI.Window.barImage-property", "name": "barImage", "type": "string", "value": "url to a local image to place as the background of the nav bar. only available in iPhone.
" }, { "filename": "Titanium.UI.Window.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.Window.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.Window.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.Window.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Window.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.Window.exitOnClose-property", "name": "exitOnClose", "type": "boolean", "value": "(Android only.) Boolean indicates if the application should exit when the Android back button is pressed while the window is being shown. You can only set this as a createWindow({...}) option. Setting it after window creation will no effect.
" }, { "filename": "Titanium.UI.Window.fullscreen-property", "name": "fullscreen", "type": "boolean", "value": "boolean indicates if the window is fullscreen (no device chrome)
" }, { "filename": "Titanium.UI.Window.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.Window.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Window.leftNavButton-property", "name": "leftNavButton", "type": "object", "value": "view to show in the left nav bar area. only available in iPhone.
" }, { "filename": "Titanium.UI.Window.modal-property", "name": "modal", "type": "boolean", "value": "boolean to indicate if the window should be opened modal in front of other windows
" }, { "filename": "Titanium.UI.Window.navBarHidden-property", "name": "navBarHidden", "type": "boolean", "value": "for modal windows, hide the nav bar (true) or show the nav bar (false, default).
" }, { "filename": "Titanium.UI.Window.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.Window.orientationModes-property", "name": "orientationModes", "type": "array", "value": "array of orientation mode constants defined in [Titanium.UI]
" }, { "filename": "Titanium.UI.Window.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Window.rightNavButton-property", "name": "rightNavButton", "type": "object", "value": "view to show in the right nav bar area. only available in iPhone.
" }, { "filename": "Titanium.UI.Window.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.Window.tabBarHidden-property", "name": "tabBarHidden", "type": "boolean", "value": "boolean to indicate if the tab bar should be hidden. this is only valid when the window is a child of a tab.
" }, { "filename": "Titanium.UI.Window.title-property", "name": "title", "type": "string", "value": "title of the window.
" }, { "filename": "Titanium.UI.Window.titleControl-property", "name": "titleControl", "type": "object", "value": "view to show in the title area. only available in iPhone.
" }, { "filename": "Titanium.UI.Window.titleImage-property", "name": "titleImage", "type": "string", "value": "url to a image that show in the title area. only available in iPhone.
" }, { "filename": "Titanium.UI.Window.titlePrompt-property", "name": "titlePrompt", "type": "string", "value": "title prompt for the window. only available in iPhone.
" }, { "filename": "Titanium.UI.Window.toolbar-property", "name": "toolbar", "type": "array", "value": "array of button objects to show in the toolbar of the window. only available in iPhone. this is only valid when the window is a child of a tab.
" }, { "filename": "Titanium.UI.Window.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.Window.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.Window.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.Window.translucent-property", "name": "translucent", "type": "boolean", "value": "boolean to indicate if the nav bar is translucent. only available in iPhone.
" }, { "filename": "Titanium.UI.Window.url-property", "name": "url", "type": "string", "value": "url to a JavaScript file with the windows instructions. this window will create a new JavaScript sub-context that will run in its own thread and global variable space.
" }, { "filename": "Titanium.UI.Window.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.Window.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.Window.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "0.9", "subtype": "view", "type": "object" }, "Titanium.UI.iOS": { "deprecated": null, "description": "The Apple iOS specific UI capabilities. All properties, methods and events in this namespace will only work on the Apple iOS related devices.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.UI.iOS.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.iOS.createAdView-method", "name": "createAdView", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.iOS.AdView", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.iOS.AdView" }, { "filename": "Titanium.UI.iOS.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.iOS.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [ "Titanium.UI.iOS.AdView" ], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [], "returns": "object", "since": "1.4", "subtype": null, "type": "module" }, "Titanium.UI.iOS.AdView": { "deprecated": null, "description": "The AdView is a view for display Apple iAds. The View is created by the method Titanium.UI.iOS.createAdView.
", "events": [ { "filename": "Titanium.UI.iOS.AdView.action-event", "name": "action", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "called when a banner action is performed
" }, { "filename": "Titanium.UI.iOS.AdView.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.iOS.AdView.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.iOS.AdView.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.iOS.AdView.error-event", "name": "error", "properties": { "message": "the error message
", "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "called when a banner could not be loaded
" }, { "filename": "Titanium.UI.iOS.AdView.load-event", "name": "load", "properties": { "source": "the source object that fired the event", "type": "the name of the event fired" }, "value": "called when a banner is loaded and displayed
" }, { "filename": "Titanium.UI.iOS.AdView.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.iOS.AdView.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.iOS.AdView.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.iOS.AdView.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.iOS.AdView.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.iOS.AdView.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.iOS.AdView.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [], "methods": [ { "filename": "Titanium.UI.iOS.AdView.add-method", "name": "add", "parameters": [ { "description": "the view to add to this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "add a child to the view hierarchy" }, { "filename": "Titanium.UI.iOS.AdView.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.iOS.AdView.animate-method", "name": "animate", "parameters": [ { "description": "either a dictionary of animation properties or an Animation object", "name": "obj", "type": "object" }, { "description": "function to be invoked upon completion of the animation", "name": "callback", "type": "function" } ], "returntype": "void", "value": "animate the view" }, { "filename": "Titanium.UI.iOS.AdView.cancelAction-method", "name": "cancelAction", "parameters": [], "returntype": "void", "value": "A banner view action can cover your application's user interface. However, your application continues to run, and receives events normally. If your application receives an event that requires the user's attention, it can programmatically cancel the action and uncover its interface by calling cancelAction. Canceling actions frequently can cause a loss of revenue for your application.
" }, { "filename": "Titanium.UI.iOS.AdView.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.iOS.AdView.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.iOS.AdView.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.iOS.AdView.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.iOS.AdView.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.iOS.AdView.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iOS.AdView.SIZE_320x50-property", "name": "SIZE_320x50", "type": "string", "value": "constant for 320x50 ad sizes
" }, { "filename": "Titanium.UI.iOS.AdView.SIZE_480x32-property", "name": "SIZE_480x32", "type": "string", "value": "constant for 480x32 ad sizes
" }, { "filename": "Titanium.UI.iOS.AdView.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.iOS.AdView.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.iOS.AdView.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.iOS.AdView.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.iOS.AdView.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.iOS.AdView.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.iOS.AdView.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.iOS.AdView.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.iOS.AdView.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.iOS.AdView.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.iOS.AdView.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iOS.AdView.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.iOS.AdView.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.iOS.AdView.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iOS.AdView.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.iOS.AdView.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iOS.AdView.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.iOS.AdView.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iOS.AdView.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.iOS.AdView.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.iOS.AdView.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.iOS.AdView.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.iOS.AdView.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "1.4", "subtype": "view", "type": "object" }, "Titanium.UI.iPad": { "deprecated": null, "description": "The iPad specific UI capabilities. All properties, methods and events in this namespace will only work on the Apple iPad related devices. To develop for iPad, you will need the Apple iPhone SDK 3.2 or later and Titanium Mobile SDK 1.2 or later.
\nFor iPad UI programming guidelines, please review the iPad Human Interface Guidelines.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.UI.iPad.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.iPad.createPopover-method", "name": "createPopover", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.iPad.Popover", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.iPad.Popover" }, { "filename": "Titanium.UI.iPad.createSplitWindow-method", "name": "createSplitWindow", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.iPad.SplitWindow", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.iPad.SplitWindow" }, { "filename": "Titanium.UI.iPad.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.iPad.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": "The iPad supports the ability to embed your own fonts in your iPad application. To add your own fonts, you should add the
", "objects": [ "Titanium.UI.iPad.Popover", "Titanium.UI.iPad.SplitWindow" ], "parameters": [], "platforms": [ "ipad" ], "properties": [ { "filename": "Titanium.UI.iPad.POPOVER_ARROW_DIRECTION_ANY-property", "name": "POPOVER_ARROW_DIRECTION_ANY", "type": "int", "value": "An arrow that points in any direction.
" }, { "filename": "Titanium.UI.iPad.POPOVER_ARROW_DIRECTION_DOWN-property", "name": "POPOVER_ARROW_DIRECTION_DOWN", "type": "int", "value": "An arrow that points downward.
" }, { "filename": "Titanium.UI.iPad.POPOVER_ARROW_DIRECTION_LEFT-property", "name": "POPOVER_ARROW_DIRECTION_LEFT", "type": "int", "value": "An arrow that points toward the left.
" }, { "filename": "Titanium.UI.iPad.POPOVER_ARROW_DIRECTION_RIGHT-property", "name": "POPOVER_ARROW_DIRECTION_RIGHT", "type": "int", "value": "An arrow that points toward the right.
" }, { "filename": "Titanium.UI.iPad.POPOVER_ARROW_DIRECTION_UNKNOWN-property", "name": "POPOVER_ARROW_DIRECTION_UNKNOWN", "type": "int", "value": "The status of the arrow is currently unknown.
" }, { "filename": "Titanium.UI.iPad.POPOVER_ARROW_DIRECTION_UP-property", "name": "POPOVER_ARROW_DIRECTION_UP", "type": "int", "value": "An arrow that points upward.
" } ], "returns": "object", "since": "1.2", "subtype": null, "type": "module" }, "Titanium.UI.iPad.Popover": { "deprecated": null, "description": "A Popover is used to manage the presentation of content in a popover. You use popovers to present information temporarily but in a way that does not take over the entire screen like a modal view does. The popover content is layered on top of your existing content in a special type of window. The popover remains visible until the user taps outside of the popover window or you explicitly dismiss it. The Popover is created by the method Titanium.UI.iPad.createPopover.
\n![\"popover\"](\"http://img.skitch.com/20100406-pmssjk1a3a65s6ui8qnbqi59c4.png\")
fired when the popover is hidden
" }, { "filename": "Titanium.UI.iPad.Popover.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.iPad.Popover.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.iPad.Popover.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.iPad.Popover.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.iPad.Popover.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.iPad.Popover.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.iPad.Popover.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "In this example, we create a simple popover and position it near the button
\nvar popover = Ti.UI.iPad.createPopover({height:100,width:100});\npopover.add(view);\npopover.show({view:button});\nIn this example, we create a popover with a title and right navigation button.
\nvar popover = Ti.UI.iPad.createPopover({ \n width:250, \n height:100,\n title: \"Yo Yo\",\n rightNavButton:button\n});\nhide the popover
" }, { "filename": "Titanium.UI.iPad.Popover.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.iPad.Popover.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.iPad.Popover.setHeight-method", "name": "setHeight", "parameters": [ { "description": "height of the popover", "name": "height", "type": "int,string" } ], "returntype": "void", "value": "change the height of the popover
" }, { "filename": "Titanium.UI.iPad.Popover.setWidth-method", "name": "setWidth", "parameters": [ { "description": "width of the popover", "name": "width", "type": "int,string" } ], "returntype": "void", "value": "change the width of the popover
" }, { "filename": "Titanium.UI.iPad.Popover.show-method", "name": "show", "parameters": [ { "description": "dictionary of the following properties: rect, animated and view. The view property should specify the view relative to where the popover should display. animated is a boolean indicating if the showing of the popover should be animated, defaults to true. The property rect is a dictionary with the following properties: x, y, width and height, where the rectangle in view at which to anchor the popover.", "name": "options", "type": "object" } ], "returntype": "void", "value": "show the popover
" }, { "filename": "Titanium.UI.iPad.Popover.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "ipad" ], "properties": [ { "filename": "Titanium.UI.iPad.Popover.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.iPad.Popover.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.iPad.Popover.arrowDirection-property", "name": "arrowDirection", "type": "int", "value": "return the arrow direction of the popover
" }, { "filename": "Titanium.UI.iPad.Popover.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.iPad.Popover.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.iPad.Popover.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.iPad.Popover.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.iPad.Popover.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.iPad.Popover.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.iPad.Popover.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.iPad.Popover.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.iPad.Popover.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iPad.Popover.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.iPad.Popover.height-property", "name": "height", "type": "float", "value": "height of the popover
" }, { "filename": "Titanium.UI.iPad.Popover.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iPad.Popover.leftNavButton-property", "name": "leftNavButton", "type": "object", "value": "the left button in the nav area of the popover
" }, { "filename": "Titanium.UI.iPad.Popover.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.iPad.Popover.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iPad.Popover.rightNavButton-property", "name": "rightNavButton", "type": "object", "value": "the right button in the nav area of the popover
" }, { "filename": "Titanium.UI.iPad.Popover.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.iPad.Popover.title-property", "name": "title", "type": "string", "value": "the title of the nav area of the popover
" }, { "filename": "Titanium.UI.iPad.Popover.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iPad.Popover.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.iPad.Popover.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.iPad.Popover.visible-property", "name": "visible", "type": "boolean", "value": "boolean to indicate if the popover is visible
" }, { "filename": "Titanium.UI.iPad.Popover.width-property", "name": "width", "type": "float", "value": "width of the popover
" }, { "filename": "Titanium.UI.iPad.Popover.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "1.2", "subtype": "view", "type": "object" }, "Titanium.UI.iPad.SplitWindow": { "deprecated": null, "description": "A SplitWindow is a window that manages the presentation of two side-by-side view controllers. You use this class to implement a master-detail interface, in which the left-side view presents a list of items and the right-side presents details of the selected item. The SplitView is for use exclusively on iPad devices. The SplitWindow is created by the method Titanium.UI.iPad.createSplitWindow.
\n![\"splitview\"](\"http://img.skitch.com/20100406-1f85bm9cx8t768xgsjqax1ng6y.png\")
for view view type, the button that is automatically wired to control the master view popover
", "popover": "for either popover or detail view types, the popover instance
", "source": "the source object that fired the event", "type": "the name of the event fired", "view": "the type of view becoming visible. either master, popover or detail.
" }, "value": "fired when the masterView or detailView becomes visible.
" } ], "examples": [ { "code": "This is an example of a Split Window.
\nvar win = Ti.UI.createWindow();\n\nvar nav = Ti.UI.iPhone.createNavigationGroup({\n window: win\n});\n\nvar splitwin = Ti.UI.iPad.createSplitWindow({\n detailView:nav,\n masterView:masterView\n});\n\nsplitwin.addEventListener('visible',function(e)\n{\n if (e.view == 'detail')\n {\n e.button.title = \"Master\";\n win.leftNavButton = e.button;\n }\n else if (e.view == 'master')\n {\n win.leftNavButton = null;\n }\n});\n\nsplitwin.open();\nThe SplitWindow inherits its methods and properties from Titanium.UI.Window.
\nThe masterView and detailView properties are required in the constructor of the SplitWindow and cannot be changed once set.
\nThe SplitWindow is a top-level window and cannot be contained within another window or view.
\n
view for the detail view section of the SplitWindow
" }, { "filename": "Titanium.UI.iPad.SplitWindow.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.iPad.SplitWindow.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iPad.SplitWindow.masterView-property", "name": "masterView", "type": "object", "value": "view for the master view section of the SplitWindow
" }, { "filename": "Titanium.UI.iPad.SplitWindow.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.iPad.SplitWindow.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iPad.SplitWindow.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.iPad.SplitWindow.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iPad.SplitWindow.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.iPad.SplitWindow.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.iPad.SplitWindow.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.iPad.SplitWindow.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.iPad.SplitWindow.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "1.2", "subtype": "view", "type": "object" }, "Titanium.UI.iPhone": { "deprecated": null, "description": "The iPhone/iPad specific UI capabilities. All properties, methods and events in this namespace will only work on the Apple iPhone or iPad related devices.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.UI.iPhone.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.UI.iPhone.createNavigationGroup-method", "name": "createNavigationGroup", "parameters": [ { "description": "(optional) a dictionary object properties defined in Titanium.UI.iPhone.NavigationGroup", "name": "parameters", "type": "object" } ], "returntype": "object", "value": "create and return an instance of Titanium.UI.iPhone.NavigationGroup" }, { "filename": "Titanium.UI.iPhone.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.iPhone.hideStatusBar-method", "name": "hideStatusBar", "parameters": [ { "description": "boolean to indicate if the action should be animated", "name": "animated", "type": "boolean" }, { "description": "the animation style", "name": "animationStyle", "type": "int" } ], "returntype": "void", "value": "convenience method to hide the status bar
" }, { "filename": "Titanium.UI.iPhone.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.iPhone.showStatusBar-method", "name": "showStatusBar", "parameters": [ { "description": "boolean to indicate if the action should be animated", "name": "animated", "type": "boolean" }, { "description": "the animation style", "name": "animationStyle", "type": "int" } ], "returntype": "void", "value": "convenience method to show the status bar
" } ], "notes": null, "objects": [ "Titanium.UI.iPhone.ActivityIndicatorStyle", "Titanium.UI.iPhone.AnimationStyle", "Titanium.UI.iPhone.NavigationGroup", "Titanium.UI.iPhone.ProgressBarStyle", "Titanium.UI.iPhone.RowAnimationStyle", "Titanium.UI.iPhone.ScrollIndicatorStyle", "Titanium.UI.iPhone.StatusBar", "Titanium.UI.iPhone.SystemButtonStyle", "Titanium.UI.iPhone.SystemIcon", "Titanium.UI.iPhone.TableViewCellSelectionStyle", "Titanium.UI.iPhone.TableViewScrollPosition", "Titanium.UI.iPhone.TableViewSeparatorStyle", "Titanium.UI.iPhone.TableViewStyle" ], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.MODAL_PRESENTATION_CURRENT_CONTEXT-property", "name": "MODAL_PRESENTATION_CURRENT_CONTEXT", "type": "int", "value": "The view is presented using the same style as its parent window. This is currently only available currently on iPhone/iPad and SDK 3.2+.
" }, { "filename": "Titanium.UI.iPhone.MODAL_PRESENTATION_FORMSHEET-property", "name": "MODAL_PRESENTATION_FORMSHEET", "type": "int", "value": "The width and height of the presented window are smaller than those of the screen and the view is centered on the screen. If the device is in a landscape orientation and the keyboard is visible, the position of the view is adjusted upward so that the view remains visible. All uncovered areas are dimmed to prevent the user from interacting with them. This is currently only available currently on iPhone/iPad and SDK 3.2+.
" }, { "filename": "Titanium.UI.iPhone.MODAL_PRESENTATION_FULLSCREEN-property", "name": "MODAL_PRESENTATION_FULLSCREEN", "type": "int", "value": "The presented window covers the screen. This is currently only available currently on iPhone/iPad and SDK 3.2+.
" }, { "filename": "Titanium.UI.iPhone.MODAL_PRESENTATION_PAGESHEET-property", "name": "MODAL_PRESENTATION_PAGESHEET", "type": "int", "value": "The height of the presented window is set to the height of the screen and the view's width is set to the width of the screen in a portrait orientation. Any uncovered areas are dimmed to prevent the user from interacting with them. (In portrait orientations, this option is essentially the same as Titanium.UI.iPhone.MODAL_PRESENTATION_FULLSCREEN). This is currently only available currently on iPhone/iPad and SDK 3.2+.
" }, { "filename": "Titanium.UI.iPhone.MODAL_TRANSITION_STYLE_COVER_VERTICAL-property", "name": "MODAL_TRANSITION_STYLE_COVER_VERTICAL", "type": "int", "value": "When the window is presented, its view slides up from the bottom of the screen. On dismissal, the view slides back down. This is the default transition style. This is currently only available currently on iPhone/iPad.
" }, { "filename": "Titanium.UI.iPhone.MODAL_TRANSITION_STYLE_CROSS_DISSOLVE-property", "name": "MODAL_TRANSITION_STYLE_CROSS_DISSOLVE", "type": "int", "value": "When the window is presented, the current view fades out while the new view fades in at the same time. On dismissal, a similar type of cross-fade is used to return to the original view. This is currently only available currently on iPhone/iPad.
" }, { "filename": "Titanium.UI.iPhone.MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL-property", "name": "MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL", "type": "int", "value": "When the window is presented, the current view initiates a horizontal 3D flip from right-to-left, resulting in the revealing of the new view as if it were on the back of the previous view. On dismissal, the flip occurs from left-to-right, returning to the original view. This is currently only available currently on iPhone/iPad.
" }, { "filename": "Titanium.UI.iPhone.MODAL_TRANSITION_STYLE_PARTIAL_CURL-property", "name": "MODAL_TRANSITION_STYLE_PARTIAL_CURL", "type": "int", "value": "When the window is presented, one corner of the current view curls up to reveal the modal view underneath. On dismissal, the curled up page unfurls itself back on top of the modal view. A modal view presented using this transition is itself prevented from presenting any additional modal views. This transition style is supported only if the window is presenting a Titanium.UI.iPhone.MODAL_PRESENTATION_FULLSCREEN modal presentation style. This is currently only available currently on iPhone/iPad and SDK 3.2+.
" }, { "filename": "Titanium.UI.iPhone.appBadge-property", "name": "appBadge", "type": "string", "value": "set the application badge for the application's icon in the springboard
" }, { "filename": "Titanium.UI.iPhone.appSupportsShakeToEdit-property", "name": "appSupportsShakeToEdit", "type": "boolean", "value": "control whether the shake to edit system wide capability is enabled
" }, { "filename": "Titanium.UI.iPhone.statusBarHidden-property", "name": "statusBarHidden", "type": "boolean", "value": "control the status bar visibility
" }, { "filename": "Titanium.UI.iPhone.statusBarStyle-property", "name": "statusBarStyle", "type": "int", "value": "constant that controls the status bar color style
" } ], "returns": "object", "since": "0.5", "subtype": null, "type": "module" }, "Titanium.UI.iPhone.ActivityIndicatorStyle": { "deprecated": null, "description": "A set of constants for the styles available for Titanium.UI.ActivityIndicator objects.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.ActivityIndicatorStyle.BIG-property", "name": "BIG", "type": "int", "value": "The large white style of indicator.
" }, { "filename": "Titanium.UI.iPhone.ActivityIndicatorStyle.DARK-property", "name": "DARK", "type": "int", "value": "The standard gray style of indicator.
" }, { "filename": "Titanium.UI.iPhone.ActivityIndicatorStyle.PLAIN-property", "name": "PLAIN", "type": "int", "value": "The standard white style of indicator (the default).
" } ], "returns": null, "since": "0.9", "subtype": null, "type": "object" }, "Titanium.UI.iPhone.AnimationStyle": { "deprecated": null, "description": "A set of constants for the Animation Styles used for transitions.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.AnimationStyle.CURL_DOWN-property", "name": "CURL_DOWN", "type": "int", "value": "Curl downwards during a transition animation
" }, { "filename": "Titanium.UI.iPhone.AnimationStyle.CURL_UP-property", "name": "CURL_UP", "type": "int", "value": "Curl upwards during a transition animation
" }, { "filename": "Titanium.UI.iPhone.AnimationStyle.FLIP_FROM_LEFT-property", "name": "FLIP_FROM_LEFT", "type": "int", "value": "Flip from left to right during a transition animation
" }, { "filename": "Titanium.UI.iPhone.AnimationStyle.FLIP_FROM_RIGHT-property", "name": "FLIP_FROM_RIGHT", "type": "int", "value": "Flip from right to left during a transition animation
" }, { "filename": "Titanium.UI.iPhone.AnimationStyle.NONE-property", "name": "NONE", "type": "int", "value": "No animation
" } ], "returns": null, "since": "0.9", "subtype": null, "type": "object" }, "Titanium.UI.iPhone.NavigationGroup": { "deprecated": null, "description": "A Navigation Group implements a specialized view that manages the navigation of hierarchical content. The Navigation Group is created by the method Titanium.UI.iPhone.NavigationGroup.
\n![\"navgroup\"](\"http://img.skitch.com/20100406-rwe44533tkd94fdnbqqudxynpe.png\")
A Navigation Group is very similar to Tab Bars with the exception that they do not maintain a group of windows with a interface bar at the bottom.
", "events": [ { "filename": "Titanium.UI.iPhone.NavigationGroup.click-event", "name": "click", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a click (longer than touch) against the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.dblclick-event", "name": "dblclick", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double click against the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.doubletap-event", "name": "doubletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a double tap against the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.singletap-event", "name": "singletap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a single tap against the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.swipe-event", "name": "swipe", "properties": { "direction": "direction of the swipe - either left or right", "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a swipe (left or right) against the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.touchcancel-event", "name": "touchcancel", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is interrupted by the device. this happens in circumenstances such as an incoming call to allow the UI to clean up state." }, { "filename": "Titanium.UI.iPhone.NavigationGroup.touchend-event", "name": "touchend", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when a touch event is completed" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.touchmove-event", "name": "touchmove", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects movement of a touch. Event coordinates are always relative to the view in which the initial touch occurred" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.touchstart-event", "name": "touchstart", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired as soon as the device detects a gesture" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.twofingertap-event", "name": "twofingertap", "properties": { "globalPoint": "a dictionary with properties x and y describing the point of the event in screen coordinates", "source": "the source object that fired the event", "type": "the name of the event fired", "x": "the x point of the event in receiving view coordiantes", "y": "the y point of the event, in receiving view coordinates" }, "value": "fired when the device detects a two-finger tap against the view" } ], "examples": [ { "code": "In this example, we open 2 windows in a navigation group. When you run this, the initial window should be blue. When you click the back button, you should see a window that should be red.
\nvar win = Titanium.UI.createWindow();\nvar win1 = Titanium.UI.createWindow({\n backgroundColor:\"red\",\n title:\"Red Window\"\n});\nvar nav = Titanium.UI.iPhone.createNavigationGroup({\n window: win1\n});\nwin.add(nav);\nwin.open();\nvar win2 = Titanium.UI.createWindow({\n backgroundColor:\"blue\",\n title:\"Blue Window\"\n});\nnav.open(win2,{animated:true});\nclose a window and remove it from the navigation group
" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.hide-method", "name": "hide", "parameters": [], "returntype": "void", "value": "hide the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.open-method", "name": "open", "parameters": [ { "description": "window to open within the tab group", "name": "window", "type": "object" }, { "description": "optional dictionary. the only current property supported is animated which is a boolean to indicate if the window should be opened animated (default) or not.", "name": "properties", "type": "object" } ], "returntype": "void", "value": "open a window within the navigation group
" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.remove-method", "name": "remove", "parameters": [ { "description": "the view to remove from this views hiearchy", "name": "view", "type": "object" } ], "returntype": "void", "value": "remove a previously add view from the view hiearchy" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.show-method", "name": "show", "parameters": [], "returntype": "void", "value": "make the view visible" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.toImage-method", "name": "toImage", "parameters": [ { "description": "function to be invoked upon completion. if non-null, this method will be performed asynchronously. if null, it will be performed immediately", "name": "f", "type": "function" } ], "returntype": "object", "value": "return a Blob image of the rendered view" } ], "notes": "The window property must be set initially in the constructor when creating a navigation group to the root level window. All Navigation Groups must have at least one root window that cannot be removed.
", "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.NavigationGroup.anchorPoint-property", "name": "anchorPoint", "type": "object", "value": "a dictionary with properties x and y to indicate the anchor point value. anchor specifies the position by which animation should occur. center is 0.5, 0.5" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.animatedCenterPoint-property", "name": "animatedCenterPoint", "type": "object", "value": "read-only object with x and y properties of where the view is during animation" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.backgroundColor-property", "name": "backgroundColor", "type": "string", "value": "the background color of the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.backgroundGradient-property", "name": "backgroundGradient", "type": "object", "value": "a background gradient for the view with the properties: type,startPoint,endPoint,startRadius,endRadius,backfillStart,backfillEnd,colors." }, { "filename": "Titanium.UI.iPhone.NavigationGroup.backgroundImage-property", "name": "backgroundImage", "type": "string", "value": "the background image url of the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.backgroundLeftCap-property", "name": "backgroundLeftCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.backgroundTopCap-property", "name": "backgroundTopCap", "type": "float", "value": "End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.borderColor-property", "name": "borderColor", "type": "string", "value": "the border color of the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.borderRadius-property", "name": "borderRadius", "type": "float", "value": "the border radius of the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.borderWidth-property", "name": "borderWidth", "type": "float", "value": "the border width of the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.bottom-property", "name": "bottom", "type": "float,string", "value": "property for the view bottom position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iPhone.NavigationGroup.center-property", "name": "center", "type": "object", "value": "a dictionary with properties x and y to indicate the center of the views position relative to the parent view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.height-property", "name": "height", "type": "float,string", "value": "property for the view height. can be either float value or a string of the width." }, { "filename": "Titanium.UI.iPhone.NavigationGroup.left-property", "name": "left", "type": "float,string", "value": "property for the view left position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iPhone.NavigationGroup.opacity-property", "name": "opacity", "type": "float", "value": "the opacity from 0.0-1.0" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.right-property", "name": "right", "type": "float,string", "value": "property for the view right position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iPhone.NavigationGroup.size-property", "name": "size", "type": "object", "value": "the size of the view as a dictionary of width and height properties" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.top-property", "name": "top", "type": "float,string", "value": "property for the view top position. this position is relative to the views parent. can be either a float value or a string of the width." }, { "filename": "Titanium.UI.iPhone.NavigationGroup.touchEnabled-property", "name": "touchEnabled", "type": "boolean", "value": "a boolean indicating if the view should receive touch events (true, default) or forward them to peers (false)" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.transform-property", "name": "transform", "type": "object", "value": "the transformation matrix to apply to the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.visible-property", "name": "visible", "type": "boolean", "value": "a boolean of the visibility of the view" }, { "filename": "Titanium.UI.iPhone.NavigationGroup.width-property", "name": "width", "type": "float,string", "value": "property for the view width. can either be `auto`, a float value or a string of the width." }, { "filename": "Titanium.UI.iPhone.NavigationGroup.zIndex-property", "name": "zIndex", "type": "int", "value": "the z index position relative to other sibling views" } ], "returns": null, "since": "1.2", "subtype": "view", "type": "object" }, "Titanium.UI.iPhone.ProgressBarStyle": { "deprecated": null, "description": "A set of constants for the bar styles used on the style property of Titanium.UI.ProgressBar.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.ProgressBarStyle.BAR-property", "name": "BAR", "type": "int", "value": "The style of progress view that is used in a toolbar.
" }, { "filename": "Titanium.UI.iPhone.ProgressBarStyle.DEFAULT-property", "name": "DEFAULT", "type": "int", "value": "he standard progress-view style. This is the default.
" }, { "filename": "Titanium.UI.iPhone.ProgressBarStyle.PLAIN-property", "name": "PLAIN", "type": "int", "value": "The standard progress-view style. Same as DEFAULT.
" } ], "returns": null, "since": "0.8", "subtype": null, "type": "object" }, "Titanium.UI.iPhone.RowAnimationStyle": { "deprecated": null, "description": "A set of constants for the Animation Styles used for transition on table view rows.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.RowAnimationStyle.BOTTOM-property", "name": "BOTTOM", "type": "int", "value": "The inserted row or rows slides in from the bottom; the deleted row or rows slides out toward the bottom.
" }, { "filename": "Titanium.UI.iPhone.RowAnimationStyle.FADE-property", "name": "FADE", "type": "int", "value": "The inserted or deleted row or rows fades into or out of the table view.
" }, { "filename": "Titanium.UI.iPhone.RowAnimationStyle.LEFT-property", "name": "LEFT", "type": "int", "value": "The inserted row or rows slides in from the left; the deleted row or rows slides out to the left.
" }, { "filename": "Titanium.UI.iPhone.RowAnimationStyle.NONE-property", "name": "NONE", "type": "int", "value": "No animation is performed. The new cell value appears as if the cell had just been reloaded.
" }, { "filename": "Titanium.UI.iPhone.RowAnimationStyle.RIGHT-property", "name": "RIGHT", "type": "int", "value": "The inserted row or rows slides in from the right; the deleted row or rows slides out to the right.
" }, { "filename": "Titanium.UI.iPhone.RowAnimationStyle.TOP-property", "name": "TOP", "type": "int", "value": "The inserted row or rows slides in from the top; the deleted row or rows slides out toward the top.
" } ], "returns": null, "since": "0.9", "subtype": null, "type": "object" }, "Titanium.UI.iPhone.ScrollIndicatorStyle": { "deprecated": null, "description": "A set of constants for the styles available for Titanium.UI.ActivityIndicator objects.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.ScrollIndicatorStyle.BLACK-property", "name": "BLACK", "type": "int", "value": "A style of indicator which is black smaller than the default style. This style is good against a white content background.
" }, { "filename": "Titanium.UI.iPhone.ScrollIndicatorStyle.DEFAULT-property", "name": "DEFAULT", "type": "int", "value": "The default style of scroll indicator, which is black with a white border. This style is good against any content background.
" }, { "filename": "Titanium.UI.iPhone.ScrollIndicatorStyle.WHITE-property", "name": "WHITE", "type": "int", "value": "A style of indicator is white and smaller than the default style. This style is good against a black content background.
" } ], "returns": null, "since": "0.9", "subtype": null, "type": "object" }, "Titanium.UI.iPhone.StatusBar": { "deprecated": null, "description": "A set of constants for the status bar style.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.StatusBar.DEFAULT-property", "name": "DEFAULT", "type": "int", "value": "The default status bar style
" }, { "filename": "Titanium.UI.iPhone.StatusBar.GRAY-property", "name": "GRAY", "type": "int", "value": "The gray colored status bar style
" }, { "filename": "Titanium.UI.iPhone.StatusBar.OPAQUE_BLACK-property", "name": "OPAQUE_BLACK", "type": "int", "value": "The opaque black status bar style.
" }, { "filename": "Titanium.UI.iPhone.StatusBar.TRANSLUCENT_BLACK-property", "name": "TRANSLUCENT_BLACK", "type": "int", "value": "The translucent black status bar style. This style provides some level of transparency to the device background.
" } ], "returns": null, "since": "0.9", "subtype": null, "type": "object" }, "Titanium.UI.iPhone.SystemButtonStyle": { "deprecated": null, "description": "A set of constants for the system button styles that can be used for the button style property.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.SystemButtonStyle.BORDERED-property", "name": "BORDERED", "type": "int", "value": "A simple button style with a border.
" }, { "filename": "Titanium.UI.iPhone.SystemButtonStyle.DONE-property", "name": "DONE", "type": "int", "value": "The style for a done button - for example, a button that completes some task and returns to the previous view.
" }, { "filename": "Titanium.UI.iPhone.SystemButtonStyle.PLAIN-property", "name": "PLAIN", "type": "int", "value": "Glows when tapped. The default item style.
" } ], "returns": null, "since": "0.8", "subtype": null, "type": "object" }, "Titanium.UI.iPhone.SystemIcon": { "deprecated": null, "description": "A set of constants for the system icon styles that can be used on a tab group tab.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.SystemIcon.BOOKMARKS-property", "name": "BOOKMARKS", "type": "int", "value": "Bookmark style icon
" }, { "filename": "Titanium.UI.iPhone.SystemIcon.CONTACTS-property", "name": "CONTACTS", "type": "int", "value": "Contacts style icon
" }, { "filename": "Titanium.UI.iPhone.SystemIcon.DOWNLOADS-property", "name": "DOWNLOADS", "type": "int", "value": "Downloads style icon
" }, { "filename": "Titanium.UI.iPhone.SystemIcon.FAVORITES-property", "name": "FAVORITES", "type": "int", "value": "Favorites style icon
" }, { "filename": "Titanium.UI.iPhone.SystemIcon.FEATURED-property", "name": "FEATURED", "type": "int", "value": "Featured style icon
" }, { "filename": "Titanium.UI.iPhone.SystemIcon.HISTORY-property", "name": "HISTORY", "type": "int", "value": "History style icon
" }, { "filename": "Titanium.UI.iPhone.SystemIcon.MORE-property", "name": "MORE", "type": "int", "value": "More style icon
" }, { "filename": "Titanium.UI.iPhone.SystemIcon.MOST_RECENT-property", "name": "MOST_RECENT", "type": "int", "value": "Most recent style icon
" }, { "filename": "Titanium.UI.iPhone.SystemIcon.MOST_VIEWED-property", "name": "MOST_VIEWED", "type": "int", "value": "Most viewed style icon
" }, { "filename": "Titanium.UI.iPhone.SystemIcon.RECENTS-property", "name": "RECENTS", "type": "int", "value": "Recents style icon
" }, { "filename": "Titanium.UI.iPhone.SystemIcon.SEARCH-property", "name": "SEARCH", "type": "int", "value": "Search style icon
" }, { "filename": "Titanium.UI.iPhone.SystemIcon.TOP_RATED-property", "name": "TOP_RATED", "type": "int", "value": "Top rated style icon
" } ], "returns": null, "since": "0.8", "subtype": null, "type": "object" }, "Titanium.UI.iPhone.TableViewCellSelectionStyle": { "deprecated": null, "description": "A set of constants for the style that can be used for the selectionStyle property of Titanium.UI.TableViewRow.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.TableViewCellSelectionStyle.BLUE-property", "name": "BLUE", "type": "int", "value": "The cell when selected has a blue background. This is the default value.
" }, { "filename": "Titanium.UI.iPhone.TableViewCellSelectionStyle.GRAY-property", "name": "GRAY", "type": "int", "value": "Then cell when selected has a gray background.
" }, { "filename": "Titanium.UI.iPhone.TableViewCellSelectionStyle.NONE-property", "name": "NONE", "type": "int", "value": "The cell has no distinct style for when it is selected.
" } ], "returns": null, "since": "0.9", "subtype": null, "type": "object" }, "Titanium.UI.iPhone.TableViewScrollPosition": { "deprecated": null, "description": "A set of constants for the position value that can be used for the position property of Titanium.UI.TableView when invoking scrollToIndex.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.TableViewScrollPosition.BOTTOM-property", "name": "BOTTOM", "type": "int", "value": "The table view scrolls the row of interest to the bottom of the visible table view.
" }, { "filename": "Titanium.UI.iPhone.TableViewScrollPosition.MIDDLE-property", "name": "MIDDLE", "type": "int", "value": "The table view scrolls the row of interest to the middle of the visible table view.
" }, { "filename": "Titanium.UI.iPhone.TableViewScrollPosition.NONE-property", "name": "NONE", "type": "int", "value": "The table view scrolls the row of interest to be fully visible with a minimum of movement. If the row is already fully visible, no scrolling occurs. For example, if the row is above the visible area, the behavior is identical to that specified by TOP. This is the default.
" }, { "filename": "Titanium.UI.iPhone.TableViewScrollPosition.TOP-property", "name": "TOP", "type": "int", "value": "The table view scrolls the row of interest to the top of the visible table view.
" } ], "returns": null, "since": "0.9", "subtype": null, "type": "object" }, "Titanium.UI.iPhone.TableViewSeparatorStyle": { "deprecated": null, "description": "A set of constants for the style that can be used for the separatorStyle property of Titanium.UI.TableView.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.TableViewSeparatorStyle.NONE-property", "name": "NONE", "type": "int", "value": "The separator cell has no distinct style.
" }, { "filename": "Titanium.UI.iPhone.TableViewSeparatorStyle.SINGLE_LINE-property", "name": "SINGLE_LINE", "type": "int", "value": "The separator cell has a single line running across its width. This is the default value.
" } ], "returns": null, "since": "0.9", "subtype": null, "type": "object" }, "Titanium.UI.iPhone.TableViewStyle": { "deprecated": null, "description": "A set of constants for the style that can be used for the button style property of Titanium.UI.TableView.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "iphone", "ipad" ], "properties": [ { "filename": "Titanium.UI.iPhone.TableViewStyle.GROUPED-property", "name": "GROUPED", "type": "int", "value": "A table view whose sections present distinct groups of rows. The section headers and footers do not float.
" }, { "filename": "Titanium.UI.iPhone.TableViewStyle.PLAIN-property", "name": "PLAIN", "type": "int", "value": "A plain table view. Any section headers or footers are displayed as inline separators and float when the table view is scrolled.
" } ], "returns": null, "since": "0.9", "subtype": null, "type": "object" }, "Titanium.Utils": { "deprecated": null, "description": "The top level Utils module. The Utils module is a set of common JavaScript functions that are \nuseful for applications.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Utils.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Utils.base64decode-method", "name": "base64decode", "parameters": [ { "description": "the string to use for the input", "name": "str", "type": "string" } ], "returntype": "string", "value": "decode a Base64 string
" }, { "filename": "Titanium.Utils.base64encode-method", "name": "base64encode", "parameters": [ { "description": "the string to use for the input", "name": "str", "type": "string" } ], "returntype": "string", "value": "encode a string into Base64
" }, { "filename": "Titanium.Utils.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Utils.md5HexDigest-method", "name": "md5HexDigest", "parameters": [ { "description": "the string to use for the input", "name": "str", "type": "string" } ], "returntype": "string", "value": "compute a MD5 hash algorithm against the input and return a hex-based string
" }, { "filename": "Titanium.Utils.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [], "returns": null, "since": "0.9", "subtype": null, "type": "module" }, "Titanium.XML": { "deprecated": null, "description": "The top level XML module. The XML module is used parsing and processing XML-based content.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.XML.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.XML.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.XML.parseString-method", "name": "parseString", "parameters": [ { "description": "the XML content as a string", "name": "xml", "type": "string" } ], "returntype": "object", "value": "parse an XML string into a DOMDocument
" }, { "filename": "Titanium.XML.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" } ], "notes": null, "objects": [ "Titanium.XML.DOMDocument" ], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [], "returns": null, "since": "0.9", "subtype": null, "type": "module" }, "Titanium.XML.DOMDocument": { "deprecated": null, "description": "The DOMDocument returned from Titanium.XML.parseString. The result is an object that implementes the DOM Level 2 API.
", "events": [], "examples": [], "methods": [], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [], "returns": null, "since": "0.9", "subtype": null, "type": "object" }, "Titanium.Yahoo": { "deprecated": null, "description": "The top level Yahoo module. The Yahoo module is used for accessing Yahoo related API services.
", "events": [], "examples": [], "methods": [ { "filename": "Titanium.Yahoo.addEventListener-method", "name": "addEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function to invoke when the event is fired", "name": "callback", "type": "function" } ], "returntype": "void", "value": "add an event listener for the instance to receive view triggered events" }, { "filename": "Titanium.Yahoo.fireEvent-method", "name": "fireEvent", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "event object", "name": "event", "type": "object" } ], "returntype": "void", "value": "fire a synthesized event to the views listener" }, { "filename": "Titanium.Yahoo.removeEventListener-method", "name": "removeEventListener", "parameters": [ { "description": "name of the event", "name": "name", "type": "string" }, { "description": "callback function passed in addEventListener", "name": "callback", "type": "function" } ], "returntype": "void", "value": "remove a previously added event listener" }, { "filename": "Titanium.Yahoo.yql-method", "name": "yql", "parameters": [ { "description": "the YQL query to execute", "name": "yql", "type": "string" }, { "description": "the function to execute when the query completes. The event will contain the boolean property success if successful. If success is false, the message property will contain the error message. If success is true, the data property will contain the data payload received from the YQL.", "name": "callback", "type": "function" } ], "returntype": "void", "value": "invoke a Yahoo YQL query
" } ], "notes": null, "objects": [], "parameters": [], "platforms": [ "android", "iphone", "ipad" ], "properties": [], "returns": null, "since": "0.8", "subtype": null, "type": "module" } }