{ "types": [ { "name": "Alloy.Controller", "description": "

The base class for Alloy controllers.

", "isInternal": false, "properties": [], "functions": [ { "name": "addClass", "description": "Adds a TSS class to the specified view object. ", "since": { "since": [ "1.2.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "Object", "name": "proxy" }, { "usage": "required", "type": "Array", "name": "classes" }, { "usage": "optional", "type": "Object", "name": "opts" } ], "returns": { "type": "void", "description": "\n" } }, { "name": "addListener", "description": "Adds a tracked event listeners to a view proxy object. ", "since": { "since": [ "1.7.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "Object", "name": "proxy" }, { "usage": "required", "type": "String", "name": "type" }, { "usage": "required", "type": "Function", "name": "callback" } ], "returns": { "type": "String", "description": "

ID attribute of the view object. If one does not exist, Alloy will create a unique ID.

" } }, { "name": "createStyle", "description": "Creates a dictionary of properties based on the specified styles. ", "since": { "since": [ "1.2.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "Object", "name": "opts" } ], "returns": { "type": "Object", "description": "\n" } }, { "name": "destroy", "description": "Frees binding resources associated with this controller and its\nUI components. ", "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [], "returns": { "type": "void", "description": "\n" } }, { "name": "getListener", "description": "Gets all the tracked event listeners of the view-controller or\nonly the ones specified by the view object or event name. ", "since": { "since": [ "1.7.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "optional", "type": "Object", "name": "proxy" }, { "usage": "optional", "type": "String", "name": "type" } ], "returns": { "type": "Array", "description": "

List of tracked event listeners.

" } }, { "name": "getTopLevelViews", "description": "Returns a list of the root view elements associated with this controller. ", "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [], "returns": { "type": "Array", "description": "\n" } }, { "name": "getView", "description": "Returns the specified view associated with this controller. ", "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "optional", "type": "String", "name": "id" } ], "returns": { "type": "Object", "description": "\n" } }, { "name": "getViews", "description": "Returns a list of all IDed view elements associated with this controller. ", "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [], "returns": { "type": "Array", "description": "\n" } }, { "name": "removeClass", "description": "Removes a TSS class from the specified view object. ", "since": { "since": [ "1.2.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "Object", "name": "proxy" }, { "usage": "required", "type": "Array", "name": "classes" }, { "usage": "optional", "type": "Object", "name": "opts" } ], "returns": { "type": "void", "description": "\n" } }, { "name": "removeListener", "description": "Removes all tracked event listeners or only the ones\nspecified by the view object, event name or callback. ", "since": { "since": [ "1.7.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "optional", "type": "Object", "name": "proxy" }, { "usage": "optional", "type": "String", "name": "type" }, { "usage": "optional", "type": "Function", "name": "callback" } ], "returns": { "type": "Object", "description": "

Controller instance.

" } }, { "name": "resetClass", "description": "Sets the array of TSS classes for the target View object, adding the classes specified and\nremoving any applied class", "since": { "since": [ "1.2.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "Object", "name": "proxy" }, { "usage": "optional", "type": "Array", "name": "classes" }, { "usage": "optional", "type": "Object", "name": "opts" } ], "returns": { "type": "void", "description": "\n" } }, { "name": "updateViews", "description": "Applies a set of properties to view elements associated with this controller. ", "since": { "since": [ "1.4.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "Object", "name": "args" } ], "returns": { "type": "Object", "description": "

this

" } } ], "events": [] }, { "name": "Alloy", "description": "

Top-level module for Alloy functions.

", "isInternal": false, "properties": [ { "name": "CFG", "description": "An object that stores Alloy configuration values as defined in your app's\napp/config.json file. ", "type": "Object", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false }, { "name": "Collections", "description": "An object for storing globally accessible Alloy collections. ", "type": "Object", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false }, { "name": "Globals", "description": "An object for storing globally accessible variables and functions. ", "type": "Object", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false }, { "name": "Models", "description": "An object for storing globally accessible Alloy models. ", "type": "Object", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false }, { "name": "isHandheld", "description": "

true if the current device is a handheld device (not a tablet).

", "type": "Boolean", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false }, { "name": "isTablet", "description": "

true if the current device is a tablet.

", "type": "Boolean", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false } ], "functions": [ { "name": "createCollection", "description": "Factory method for instantiating a Backbone collection of model objects. ", "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "String", "name": "name" }, { "usage": "optional", "type": "Object", "name": "args" } ], "returns": { "type": "Backbone.Collection", "description": "

Backbone collection object.

" } }, { "name": "createController", "description": "Factory method for instantiating a controller. ", "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "String", "name": "name" }, { "usage": "optional", "type": "Object", "name": "args" } ], "returns": { "type": "Object", "description": "

Alloy controller object.

" } }, { "name": "createModel", "description": "Factory method for instantiating a Backbone Model object. ", "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "String", "name": "name" }, { "usage": "optional", "type": "Object", "name": "args" } ], "returns": { "type": "Backbone.Model", "description": "

Backbone model object.

" } }, { "name": "createWidget", "description": "Factory method for instantiating a widget controller. ", "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "String", "name": "id" }, { "usage": "optional", "type": "String", "name": "name" }, { "usage": "optional", "type": "Object", "name": "args" } ], "returns": { "type": "Object", "description": "

Alloy widget controller object.

" } } ], "events": [] }, { "name": "Alloy.Collections", "description": "

Class to access or create collections.

", "isInternal": false, "properties": [], "functions": [ { "name": "instance", "description": "Creates a singleton instance of a Collection based on the given model, or\nreturns an existing instance if one has alr", "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "String", "name": "name" } ], "returns": { "type": "Backbone.Collection", "description": "

An Alloy Collection object singleton

" } } ], "events": [] }, { "name": "Alloy.Controller.UI", "description": "

Provides convenience methods for working with Titanium UI objects.

", "isInternal": false, "properties": [], "functions": [ { "name": "create", "description": "Creates a Titanium UI object with the specified styles. ", "since": { "since": [ "1.2.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "String", "name": "apiName" }, { "usage": "required", "type": "Object", "name": "opts" } ], "returns": { "type": "Object", "description": "\n" } } ], "events": [] }, { "name": "AlloyStyleDict", "description": "

Simple JavaScript object of properties and TSS classes to apply to a Titanium UI object.

", "since": { "since": [ "1.2.0" ], "version": "Titanium Mobile SDK" }, "isInternal": false, "properties": [ { "name": "apiName", "description": "Name of the Titanium UI object. ", "type": "String", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false }, { "name": "classes", "description": "

Array of TSS classes to apply to the Titanium UI object.

", "type": "Array", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false }, { "name": "id", "description": "

TSS ID style to apply to the Titanium UI object.

", "type": "String", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false } ], "functions": [], "events": [] }, { "name": "TrackedEventListener", "description": "

A tracked event listener.

", "since": { "since": [ "1.7.0" ], "version": "Titanium Mobile SDK" }, "isInternal": false, "properties": [ { "name": "handler", "description": "

Callback bound to the view's event.

", "type": "Function", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false }, { "name": "id", "description": "ID attribute of the view object. ", "type": "String", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false }, { "name": "type", "description": "

Name of the event.

", "type": "String", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false }, { "name": "view", "description": "

View object bound to the event listener.

", "type": "Object", "isInternal": false, "isClassProperty": true, "isInstanceProperty": false } ], "functions": [], "events": [] }, { "name": "Alloy.Models", "description": "

Class to access or create models.

", "isInternal": false, "properties": [], "functions": [ { "name": "instance", "description": "Creates a singleton instance of a Model based on the given model, or\nreturns an existing instance if one has already ", "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "String", "name": "name" } ], "returns": { "type": "Backbone.Model", "description": "

An Alloy Model object singleton

" } } ], "events": [] }, { "name": "Widget", "description": "

Widgets are self-contained components that can be easily dropped into an Alloy project.\nThey were conceived as a way to reuse code in multiple projects or to be used multiple\ntimes in the same project.

", "isInternal": false, "properties": [], "functions": [ { "name": "createCollection", "description": "Factory method for instantiating a Backbone collection of model objects. ", "since": { "since": [ "1.1.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "String", "name": "name" }, { "usage": "optional", "type": "Object", "name": "args" } ], "returns": { "type": "Backbone.Collection", "description": "

Backbone collection object.

" } }, { "name": "createController", "description": "Factory method for instantiating a controller. ", "since": { "since": [ "1.1.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "String", "name": "name" }, { "usage": "optional", "type": "Object", "name": "args" } ], "returns": { "type": "Object", "description": "

Alloy controller object.

" } }, { "name": "createModel", "description": "Factory method for instantiating a Backbone Model object. ", "since": { "since": [ "1.1.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "String", "name": "name" }, { "usage": "optional", "type": "Object", "name": "args" } ], "returns": { "type": "Backbone.Model", "description": "

Backbone model object.

" } }, { "name": "createWidget", "description": "Factory method for instantiating a widget controller. ", "since": { "since": [ "1.1.0" ], "version": "Titanium Mobile SDK" }, "isMethod": true, "isConstruction": false, "isInternal": false, "isInstanceProperty": true, "isClassProperty": false, "parameters": [ { "usage": "required", "type": "String", "name": "id" }, { "usage": "optional", "type": "String", "name": "name" }, { "usage": "optional", "type": "Object", "name": "args" } ], "returns": { "type": "Object", "description": "

Alloy widget controller object.

" } } ], "events": [] } ], "version": "1.0" }