# Titanium.Gesture

The Gesture module is responsible for high-level device gestures such as orientation changes and shake gestures.

Availability
0.8
0.8
9.2.0

# Properties

# apiName READONLY

Availability
3.2.0
3.2.0
9.2.0
apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.


# bubbleParent

Availability
3.0.0
3.0.0
9.2.0
bubbleParent :Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true


# landscape READONLY

Availability
0.8
0.8
9.2.0
landscape :Boolean

Indicates if the device is currently held in landscape form.

Value is true if in landscape, and false otherwise.


# lifecycleContainer

Availability
3.6.0

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.


# orientation READONLY

Availability
0.8
0.8
9.2.0
orientation :Number

Orientation of the device.

Value may be one of the group of Titanium.UI orientation constants, PORTRAIT, UPSIDE_PORTRAIT, LANDSCAPE_LEFT, LANDSCAPE_RIGHT, FACE_UP, FACE_DOWN, or UNKNOWN.

On iOS and Windows, returns the current orientation of the device, regardless of the window orientation. To determine the current window orientation, use orientation.

To set the allowable orientations for a window, see orientationModes.


# portrait READONLY

Availability
0.8
0.8
9.2.0
portrait :Boolean

Indicates if the device is currently held in portrait form.

Value is true if in portrait, and false otherwise.

# Methods

# addEventListener

Availability
0.8
0.8
9.2.0
addEventListener(name, callback) void

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

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to invoke when the event is fired.

Returns

Type
void

# applyProperties

Availability
3.0.0
3.0.0
9.2.0
applyProperties(props) void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name Type Description
props Dictionary

A dictionary of properties to apply.

Returns

Type
void

# fireEvent

Availability
0.8
0.8
9.2.0
fireEvent(name[, event]) void

Fires a synthesized event to any registered listeners.

Parameters

Name Type Description
name String

Name of the event.

event Dictionary

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

Returns

Type
void

# removeEventListener

Availability
0.8
0.8
9.2.0
removeEventListener(name, callback) void

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

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

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

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

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

window.removeEventListener('click', listener);

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

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

Returns

Type
void

# Events

# orientationchange

Availability
0.8
0.8
9.2.0

Fired when the device orientation changes.

On Android, note that the application must have a heavyweight window or tab group open in order to receive the orientationchange event. It is not necessary for the heavyweight window to be the topmost window.

Almost all real-world applications will have a heavyweight window or a tab group. This is only likely to be an issue if you create a test case or test application that adds an orientation change listener from app.js without opening a heavyweight window.

Properties

Name Type Description
orientation Number

Orientation of the device.

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.


# shake

Availability
0.8
0.8
9.2.0

Fired when the device is shaken.

A shake gesture consists of a series of quick accelerations, and is represented by a series of shake events.

The timestamp property represents the interval between shake events. It is measured in milliseconds on Android, and in seconds on iOS.

Properties

Name Type Description
timestamp Number

Time interval since previous shake event. On iOS, this value is 0 for the first shake event in a series.

x Number

Acceleration along the X axis, in Gs.

y Number

Acceleration along the Y axis, in Gs.

z Number

Acceleration along the Z axis, in Gs.

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.