Titanium.Gesture
> Titanium.Gesture

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

  • 0.8
  • 0.8
  • 0.8
Defined By

Properties

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

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, Button returns Ti.UI.Button.

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

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

  • 3.0.0
  • 3.0.0
  • 3.0.0
Titanium.Gesture
landscape : Booleanreadonly

Indicates if the device is currently held in landscape form.

Indicates if the device is currently held in landscape form.

Value is true if in landscape, and false otherwise.

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

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.

  • 3.6.0
Titanium.Gesture
orientation : Numberreadonly

Orientation of the device.

Orientation of the device.

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

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

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

Titanium.Gesture
portrait : Booleanreadonly

Indicates if the device is currently held in portrait form.

Indicates if the device is currently held in portrait form.

Value is true if in portrait, and false otherwise.

Defined By

Methods

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

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

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.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.Gesture
( ) : Number
Gets the value of the orientation property. ...

Gets the value of the orientation property.

Returns

  • Number
Titanium.Gesture
( ) : Booleandeprecated
Returns whether or not the device is currently held in landscape form. ...

Returns whether or not the device is currently held in landscape form.

deprecated since 6.1.0

Use <Titanium.Gesture.landscape> for parity instead.

Value returns true if in landscape, and false otherwise.

Returns

  • Boolean
Titanium.Gesture
( ) : Booleandeprecated
Returns whether or not the device is currently held in portrait form. ...

Returns whether or not the device is currently held in portrait form.

deprecated since 6.1.0

Use <Titanium.Gesture.portrait> for parity instead.

Value returns true if in portrait, and false otherwise.

Returns

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

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 : String

    Name of the event.

  • callback : Callback<Object>

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

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Defined By

Events

Titanium.Gesture
Fired when the device orientation changes. ...

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

Titanium.Gesture
Fired when the device is shaken. ...

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

  • 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.

    •  
    •  
    •