> Titanium.UI.Window

The Window is an empty drawing surface or container.

To create a window, use the Titanium.UI.createWindow method or a <Window> Alloy element.

A window is a top-level container which can contain other views. Windows can be opened and closed. Opening a window causes the window and its child views to be added to the application's render stack, on top of any previously opened windows. Closing a window removes the window and its children from the render stack.

Windows contain other views, but in general they are not contained inside other views. There are a few specialized views that manage windows:

By default, windows occupy the entire screen except for the navigation bar, status bar, and in the case of windows contained in tab groups, the tab bar. To take up the entire screen, covering any other UI, specify fullscreen:true when creating the window.

Pass Context Between Windows

To pass data between windows, use a CommonJS module to save information from one window then retrieve it in another. In the example below, the foo module exposes two methods to store and retrieve an object. The first window of the project loads the foo module and uses the set method to store some data before opening the second window. The second window loads the same module and is able to retrieve the content saved by the first window with the get method.

Note that for Alloy projects, you can simply pass the context as the second argument of the Alloy.createController method, then retrieve the data with the special variable arguments[0] in the controller code.

app/lib/foo.js:

// For a classic Titanium project, save the file to 'Resources/foo.js'
var data = {};
function setData (obj){
    data = obj;
}
function getData () {
    return data;
}

// The special variable 'exports' exposes the functions as public
exports.setData = setData;
exports.getData = getData;

app/views/index.xml:

<Alloy>
    <Window backgroundColor="blue">
        <Label onClick="openWindow">Open the Red Window!</Label>
    </Window>
</Alloy>

app/controllers/index.js:

var foo = require('foo');
foo.setData({foobar: 42});

function openWindow () {
    var win2 = Alloy.createController('win2').getView();
    // For Alloy projects, you can pass context
    // to the controller in the Alloy.createController method.
    // var win2 = Alloy.createController('win2', {foobar: 42}).getView();
    win2.open();
}

$.index.open();

app/views/win2.xml:

<Alloy>
    <Window backgroundColor="red">
        <Label id="label">I am a red window.</Label>
    </Window>
</Alloy>

app/controllers/win2.js:

var foo = require('foo');
$.label.text = foo.getData().foobar;

// For Alloy projects, you can also pass in context
// with the Alloy.createController method and retrieve
// it in the controller code.
// var args = arguments[0] || {};
// $.label.text = args.foobar;

Modal Windows

In the user interface, a modal window is a window that blocks the main application UI until the modal window is dismissed. A modal window requires the user to interact with it to resume the normal flow of the application. For example, if an action requires the user to login, the application can present a login window, then after the user is authenticated, the normal flow of the application can be resumed.

To create a modal window, set the modal property to true in the dictionary passed to either the Titanium.UI.createWindow() method or the Window object's open() method.

Android Behavior

The Android platform does not have a concept of a modal window but instead uses modal dialogs. You may want to use a Titanium.UI.AlertDialog or Titanium.UI.OptionDialog and use the androidView property rather than a modal window.

For Android, Titanium creates a heavyweight window with a translucent background (if the background properties are not set). Before API level 14 (Android 4.x), the modal window will blur the background. On API level 14 and above, the Android OS no longer supports the blur effect.

The combination of fullscreen:true and modal:true will not work as expected. If the background window displays the status bar or action bar, it will be visible behind the modal window.

Note that Titanium will allow a non-modal window to open on top of a modal window on Android.

iOS Behavior

By default, if you do not set a backgroundColor, the modal's background color will be the value set to Titanium.UI.backgroundColor.

The modal window will not show the background window stack even if you make the modal translucent. For fullscreen modals, when the modal appears, the background window stack is removed. For non-fullscreen modals on the iPad, the background will be opaque gray if a background color is not specified.

By default, modal windows appear from the bottom of the screen and slide up. To change the default transition, set the modalTransitionStyle property to a Titanium.UI.iOS.MODAL_TRANSITION_STYLE_* constant in the dictionary passed to the Window object's open() method.

Modal windows should not support orientation modes that the window they are opened over do not support. Doing otherwise may cause bad visual/redraw behavior after the modal is dismissed, due to how iOS manages modal transitions.

Starting with Release 3.1.3, if the orientationModes property of a modal window is undefined, then the orientations supported by this window would be the orientation modes specified by the tiapp.xml with the UISupportedInterfaceOrientations key.

iOS does not allow opening non-modal windows on top of a modal window.

iPad Features

In addition to full-screen modal windows, iPad supports "Page sheet" and "Form sheet" style windows:

Page sheet style windows have a fixed width, equal to the width of the screen in portait mode, and a height equal to the current height of the screen. This means that in portrait mode, the window covers the entire screen. In landscape mode, the window is centered on the screen horizontally.
Form sheet style windows are smaller than the screen size, and centered on the screen.

The example below is a modal window using the Form sheet style:

You can create this type of modal window on iPad with the following code snippet:

var win = Ti.UI.iOS.createNavigationWindow({
    window: Ti.UI.createWindow({
        title: "Modal Window"
    })
});

win.open({
    modal: true,
    modalTransitionStyle: Ti.UI.iOS.MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL,
    modalStyle: Ti.UI.iOS.MODAL_PRESENTATION_FORMSHEET
});

Animations

Windows can be animated like a View, such as using an animation to open or close a window. The example below creates a window that opens 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, then, after 1/20th of a second, it is scaled back to it's original size at 100%. This gives the bounce effect during animation.

app/views/index.xml:

<Alloy>
    <Window backgroundColor="blue" onPostlayout="animateOpen" >
        <Label color="orange">Animated Window</Label>
    </Window>
</Alloy>

app/controllers/index.js:

$.index.transform = Titanium.UI.create2DMatrix().scale(0);
$.index.open();

var a = Ti.UI.createAnimation({
    transform : Ti.UI.create2DMatrix().scale(1.1),
    duration : 2000,
});
a.addEventListener('complete', function() {
    $.index.animate({
        transform: Ti.UI.create2DMatrix(),
        duration: 200
    });
});

function animateOpen() {
    $.index.animate(a);
}

Note that to animate an Android heavyweight window while you open it, you need to follow a specific procedure which is explained below in "Heavyweight Window Transitions in Android".

iOS Platform Notes

iOS Transition Animations

iOS contains built-in transition animations when switching between non-modal windows. In the Window's open method, set the transition property to a Titanium.UI.iOS.AnimationStyle constant to use an animation. For example, to flip right-to-left between two windows:

app/views/index.xml:

<Alloy>
    <Window backgroundColor="blue" onOpen="animateOpen">
        <Label id="label">I am a blue window!</Label>
    </Window>
</Alloy>

app/controllers/index.js

function animateOpen() {
    Alloy.createController('win2').getView().open({
        transition: Ti.UI.iOS.AnimationStyle.FLIP_FROM_LEFT
    });
}
$.index.open();

app/views/win2.xml:

<Alloy>
    <Window backgroundColor="red">
        <Label id="label">I am a red window!</Label>
    </Window>
</Alloy>

In the above example, the red window will be animated from the right-to-left over the blue window.

Starting with iOS 7, you can create transition animations when opening and closing windows in either a Titanium.UI.iOS.NavigationWindow or Titanium.UI.Tab.

Use the Titanium.UI.iOS.createTransitionAnimation method to specify an animation objects to hide and show the window, then set the newly created TransitionAnimation object to the window's transitionAnimation property.

In the example below, the windows are closed by rotating them upside down while simulatenously making them transparent:

app/views/index.xml:

<Alloy>
    <NavigationWindow platform="ios">
        <Window id="redwin" title="Red Window" backgroundColor="red">
            <Button id="button" onClick="openBlueWindow">Open Blue Window</Button>
        </Window>
    </NavigationWindow>
</Alloy>

app/controllers/index.js:

function openBlueWindow(e) {
    var bluewin = Alloy.createController('bluewin').getView();
    $.index.openWindow(bluewin);
}

$.redwin.transitionAnimation = Ti.UI.iOS.createTransitionAnimation({
    duration: 300,
    // The show transition makes the window opaque and rotates it correctly
    transitionTo: {
        opacity: 1,
        duration: 300,
        transform: Ti.UI.create2DMatrix()
    },
    // The hide transition makes the window transparent and rotates it upside down
    transitionFrom: {
        opacity: 0,
        duration: 300 / 2,
        transform: Ti.UI.create2DMatrix().rotate(180),
    }
});

$.index.open();

app/views/bluewin.xml:

<Alloy>
    <Window title="Blue Window" backgroundColor="blue" opacity="0">
        <Button onClick="closeWindow">Close Window</Button>
    </Window>
</Alloy>

app/controllers/bluewin.js:

function closeWindow(){
    $.bluewin.close();
}

$.bluewin.transitionAnimation = Ti.UI.iOS.createTransitionAnimation({
    duration: 300,
    // The show transition makes the window opaque and rotates it correctly
    transitionTo: {
        opacity: 1,
        duration: 300,
        transform: Ti.UI.create2DMatrix()
    },
    // The hide transition makes the window transparent and rotates it upside down
    transitionFrom: {
        opacity: 0,
        duration: 300 / 2,
        transform: Ti.UI.create2DMatrix().rotate(180),
    }
});

$.bluewin.transform = Ti.UI.create2DMatrix().rotate(180);

Android Platform Notes

Android Heavyweight and Lightweight Windows

Prior to Release Titanium 3.2.0 in Android, Titanium windows can be heavyweight or lightweight:

A heavyweight window is associated with a new Android Activity.
A lightweight window is a fullscreen view, and runs in the current Android Activity.

The createWindow call creates a heavyweight window if any of the following properties are defined (set to either true or false) on creation:

fullscreen
navBarHidden
modal
windowSoftInputMode

Starting with Release 3.2.0 in Android, all the windows are heavyweight. If you still want the old behavior, you can enable the ti.android.useLegacyWindow property in the tiapp.xml:

<property name="ti.android.useLegacyWindow" type="bool">true</property>

Note that this property only works with Release 3.2.x. It has no effect on other releases.

A heavyweight window is always created when you open a new window from inside a TabGroup.

Heavyweight Window Transitions in Android

As explained above, heavyweight windows are their own Android Activity. The only way to animate the opening or closing of an Activity in Android is to apply an animation resource to it. Passing a Titanium.UI.Animation object as a parameter to open or close will have no effect if the window being opened/closed is heavyweight and thus opens/closes its own Activity.

Instead, in the parameter dictionary you pass to open or close, you should set the activityEnterAnimation and activityExitAnimation keys to animation resources. activityEnterAnimation should be set to the animation you want to run on the incoming activity, while activityExitAnimation should be set to the animation you want to run on the outgoing activity that you are leaving.

Animation resources are available through the R object. Use either Titanium.Android.R for built-in resources or Titanium.App.Android.R for resources that you package in your application.

As an example, you may wish for the window that you are opening to fade in while the window you are leaving should fade out:

var win2 = Ti.UI.createWindow({
    fullscreen: false // Makes it heavyweight before Titanium 3.2.0
});

win2.open({
    activityEnterAnimation: Ti.Android.R.anim.fade_in,
    activityExitAnimation: Ti.Android.R.anim.fade_out
});

See the official Android R.anim documentation for information about built-in animations.

For information on creating your own animation resource XML files, see "View Animation" in Android's Resources documentation. After creating an animation resource file, you can place it under platform/android/res/anim in your Titanium project folder and it will be packaged in your app's APK and then available via Titanium.App.Android.R.

Material design transitions in Android

You can provide transition between common elements among participating activities. For example in a master-detail pattern, clicking on a row item animates the common elements of image, title smoothly into details activity as if they are part of the same scene. This seamless animation is called shared element transition and can be achieved by the following steps.

Say window A is opening window B. Firstly, specify a unique transitionName to the common UI elements between the two windows. Next use addSharedElement method on window B passing the window A common UI element and the transition name. This tells the system which views are shared between windows and performs the transition between them. Note that we specify the UI elements of window A since the system needs the source element and connects the destination element from the shared transition name once window B is created and shown.

For example to transition a title label in window A to a title label in window B.

// Create label in window A with a unique transitionName.
var titleInWinA = new Ti.UI.createLabel({
    text:'Top 10 pics from Mars!',
    left:70, top: 6,
    width:200, height: 30,
    transitionName: 'title'
});
windowA.add(titleInWinA);

// Creating label in window B, note that the same transitionName is used.
var titleInWinB = new Ti.UI.createLabel({
    text:'Top 10 pics from Mars!',
    left:50, top: 10,
    width:200, height: 30,
    transitionName: 'title'
});

// Before opening window B specify the common UI elements.
windowB.addSharedElement(titleInWinA, "title");
windowB.open();

Further you can use activityEnterTransition, activityExitTransition, activityReenterTransition and activityReturnTransition to customize the way activities transition into the scene. Currently activity transition will work only when atleast a shared element is used between the participating activities.

Note that specifying the transitions is not mandatory. If not specified it defaults to Material theme transition.

See the official Android Activity Transitions documentation for more information and supported transitons.

Android "root" Windows

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

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

var win = Titanium.UI.createWindow({
  title: 'My Root Window',
  exitOnClose: true
});

Starting with Release 3.2.0, the root window's exitOnClose property is set to true by default. Prior to Release 3.2.0, the default value of the property was false for all windows.

Examples

Full Screen Window example

Create a fullscreen window with a red background.

var window = Titanium.UI.createWindow({
   backgroundColor:'red'
});
window.open({fullscreen:true});

Alloy XML Markup

Previous example as an Alloy view.

<Alloy>
    <Window id="win" backgroundColor="red" fullscreen="true" />
</Alloy>

Defined By

Properties

Titanium.UI.View

accessibilityHidden : Boolean

Whether the view should be "hidden" from (i.e., ignored by) the accessibility service. ...

Whether the view should be "hidden" from (i.e., ignored by) the accessibility service.

Requires: Android 4.0 and later iOS 5.0 and later

On iOS this is a direct analog of the accessibilityElementsHidden property defined in the UIAccessibility Protocol. The native property is only available in iOS 5.0 and later; if accessibilityHidden is specified on earlier versions of iOS, it is ignored.

On Android, setting accessibilityHidden calls the native View.setImportantForAccessibility method. The native method is only available in Android 4.1 (API level 16/Jelly Bean) and later; if this property is specified on earlier versions of Android, it is ignored.

Default: false

3.0.0
3.0.0
3.0.0

Titanium.UI.View

accessibilityHint : String

Briefly describes what performing an action (such as a click) on the view will do. ...

Briefly describes what performing an action (such as a click) on the view will do.

On iOS this is a direct analog of the accessibilityHint property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityLabel and accessibilityValue in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method.

Default:

3.0.0
3.0.0
3.0.0

Titanium.UI.View

accessibilityLabel : String

A succint label identifying the view for the device's accessibility service. ...

A succint label identifying the view for the device's accessibility service.

On iOS this is a direct analog of the accessibilityLabel property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityValue and accessibilityHint in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method.

Default: Title or label of the control.

3.0.0
3.0.0
3.0.0

Titanium.UI.View

accessibilityValue : String

A string describing the value (if any) of the view for the device's accessibility service. ...

A string describing the value (if any) of the view for the device's accessibility service.

On iOS this is a direct analog of the accessibilityValue property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityLabel and accessibilityHint in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method.

Default: State or value of the control.

3.0.0
3.0.0
3.0.0

Titanium.UI.Window

activity : Titanium.Android.Activityreadonly

For lightweight windows, this property returns undefined. ...

For lightweight windows, this property returns undefined. For heavyweight windows, this property contains a reference to the Android Activity object associated with this window.

An Activity object is not created until the window is opened. Before the window is opened, activity refers to an empty JavaScript object. You can be set properties on this object, but cannot invoke any Activity methods on it. Once the window is opened, the actual Activity object is created, using any properties set on the JavaScript object. At this point, you can call methods on the activity and access any properties that are set when the activity is created, for example, actionBar.

Titanium.UI.Window

activityEnterTransition : NumberCreation-Only

The type of transition used when activity is entering. ...

The type of transition used when activity is entering.

Requires: Android 5 and later

Activity B's enter transition determines how views in B are animated when A starts B. Applicable for Android 5.0 and above. This value will be ignored if animated is set to false or there is no shared element between the participating activities. See "Material design activity transitions in Android" in the main description of Titanium.UI.Window for more information.

This API can be assigned the following constants:

Default: If not specified uses platform theme transition.

5.2.0

Titanium.UI.Window

activityExitTransition : NumberCreation-Only

The type of transition used when activity is exiting. ...

The type of transition used when activity is exiting.

Requires: Android 5 and later

Activity A's exit transition determines how views in A are animated when A starts B. Applicable for Android 5.0 and above. This value will be ignored if animated is set to false or there is no shared element between the participating activities. See "Material design activity transitions in Android" in the main description of Titanium.UI.Window for more information.

This API can be assigned the following constants:

Default: If not specified uses platform theme transition.

5.2.0

Titanium.UI.Window

activityReenterTransition : NumberCreation-Only

The type of transition used when reentering to a previously started activity. ...

The type of transition used when reentering to a previously started activity.

Requires: Android 5 and later

Activity A's reenter transition determines how views in A are animated when B returns to A. Applicable for Android 5.0 and above. This value will be ignored if animated is set to false or there is no shared element between the participating activities. See "Material design activity transitions in Android" in the main description of Titanium.UI.Window for more information.

This API can be assigned the following constants:

Default: If not specified uses `activityExitTransition`.

5.2.0

Titanium.UI.Window

activityReturnTransition : NumberCreation-Only

The type of transition used when returning from a previously started activity. ...

The type of transition used when returning from a previously started activity.

Requires: Android 5 and later

Activity B's return transition determines how views in B are animated when B returns to A. Applicable for Android 5.0 and above. This value will be ignored if animated is set to false or there is no shared element between the participating activities. See "Material design activity transitions in Android" in the main description of Titanium.UI.Window for more information.

This API can be assigned the following constants:

Default: If not specified uses `activityEnterTransition`.

5.2.0

Titanium.UI.Window

activitySharedElementEnterTransition : NumberCreation-Only

(https://github.com/android/platform_frameworks_base/blob/lollipop-release/core/res/res/transition/move.xml) transition. ...

(https://github.com/android/platform_frameworks_base/blob/lollipop-release/core/res/res/transition/move.xml) transition. ]

The type of enter transition used when animating shared elements between two activities.

Requires: Android 5 and later

Activity B's shared element enter transition determines how shared elements animate from A to B. Applicable for Android 5.0 and above. This value will be ignored if animated is set to false. See "Material design activity transitions in Android" in the main description of Titanium.UI.Window for more information.

This API can be assigned the following constants:

Default: Defaults to android platform's [move

5.2.0

Titanium.UI.Window

activitySharedElementExitTransition : NumberCreation-Only

(https://github.com/android/platform_frameworks_base/blob/lollipop-release/core/res/res/transition/move.xml) transition. ...

(https://github.com/android/platform_frameworks_base/blob/lollipop-release/core/res/res/transition/move.xml) transition. ]

The type of exit transition used when animating shared elements between two activities.

Requires: Android 5 and later

Activity A's shared element exit transition animates shared elements before they transition from A to B Applicable for Android 5.0 and above. This value will be ignored if animated is set to false. See "Material design activity transitions in Android" in the main description of Titanium.UI.Window for more information.

This API can be assigned the following constants:

Default: Defaults to android platform's [move

5.2.0

Titanium.UI.Window

activitySharedElementReenterTransition : NumberCreation-Only

(https://github.com/android/platform_frameworks_base/blob/lollipop-release/core/res/res/transition/move.xml) transition. ...

(https://github.com/android/platform_frameworks_base/blob/lollipop-release/core/res/res/transition/move.xml) transition. ]

The type of reenter transition used when animating shared elements between two activities.

Requires: Android 5 and later

Activity A's shared element reenter transition animates shared elements after they have transitioned from B to A. Applicable for Android 5.0 and above. This value will be ignored if animated is set to false. See "Material design activity transitions in Android" in the main description of Titanium.UI.Window for more information.

This API can be assigned the following constants:

Default: Defaults to android platform's [move

5.2.0

Titanium.UI.Window

activitySharedElementReturnTransition : NumberCreation-Only

(https://github.com/android/platform_frameworks_base/blob/lollipop-release/core/res/res/transition/move.xml) transition. ...

(https://github.com/android/platform_frameworks_base/blob/lollipop-release/core/res/res/transition/move.xml) transition. ]

The type of return transition used when animating shared elements between two activities.

Requires: Android 5 and later

Activity B's shared element return transition determines how shared elements animate from B to A. Applicable for Android 5.0 and above. This value will be ignored if animated is set to false. See "Material design activity transitions in Android" in the main description of Titanium.UI.Window for more information.

This API can be assigned the following constants:

Default: Defaults to android platform's [move

5.2.0

Titanium.UI.View

anchorPoint : Point

Coordinate of the view about which to pivot an animation. ...

Coordinate of the view about which to pivot an animation.

Used on iOS only. For Android, use Titanium.UI.Animation.anchorPoint.

Anchor point is specified as a fraction of the view's size. For example, {0, 0} is at the view's top-left corner, {0.5, 0.5} at its center and {1, 1} at its bottom-right corner.

See the "Using an anchorPoint" example in Titanium.UI.Animation for a demonstration.

Default: Center of this view.

Titanium.UI.View

animatedCenter : Pointreadonly

Current position of the view during an animation.

Titanium.Proxy

apiName : Stringreadonly

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

Titanium.UI.Window

autoAdjustScrollViewInsets : Boolean

Specifies whether or not the view controller should automatically adjust its scroll view insets. ...

Specifies whether or not the view controller should automatically adjust its scroll view insets. Valid on iOS 7 and greater.

Requires: iOS 7.0 and later

When the value is true, it allows the view controller to adjust its scroll view insets in response to the screen areas consumed by the status bar, navigation bar, toolbar and tab bar.

The default behavior assumes that this is false. Must be specified before opening the window.

3.1.3
3.1.3

Titanium.UI.Window

backButtonTitle : String

Title for the back button. ...

Title for the back button. This is only valid when the window is a child of a tab.

Titanium.UI.Window

backButtonTitleImage : String/Titanium.Blob

The image to show as the back button. ...

The image to show as the back button. This is only valid when the window is a child of a tab.

Titanium.UI.Window

backgroundColor : String

Background color of the window, as a color name or hex triplet. ...

Background color of the window, as a color name or hex triplet.

On Android, to specify a semi-transparent background, set the alpha value using the opacity property before opening the window.

For information about color values, see the "Colors" section of Titanium.UI.

Default: Transparent

Overrides: Titanium.UI.View.backgroundColor

Titanium.UI.View

backgroundDisabledColor : String

Disabled background color of the view, as a color name or hex triplet. ...

Disabled background color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Default: Same as the normal background color of this view.

Titanium.UI.View

backgroundDisabledImage : String

Disabled background image for the view, specified as a local file path or URL. ...

Disabled background image for the view, specified as a local file path or URL.

Default: If `backgroundDisabledImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is disabled.

Titanium.UI.View

backgroundFocusedColor : String

Focused background color of the view, as a color name or hex triplet. ...

Focused background color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

For normal views, the focused color is only used if focusable is true.

Default: Same as the normal background color of this view.

Titanium.UI.View

backgroundFocusedImage : String

Focused background image for the view, specified as a local file path or URL. ...

Focused background image for the view, specified as a local file path or URL.

For normal views, the focused background is only used if focusable is true.

Default: If `backgroundFocusedImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is focused.

Titanium.UI.View

backgroundGradient : Gradient

A background gradient for the view. ...

A background gradient for the view.

A gradient can be defined as either linear or radial. A linear gradient varies continuously along a line between the startPoint and endPoint.

A radial gradient is interpolated between two circles, defined by startPoint and startRadius and endPoint and endRadius respectively.

The start and end points and radius values can be defined in device units, in the view's coordinates, or as percentages of the view's size. Thus, if a view is 60 x 60, the center point of the view can be specified as:

{ x: 30, y: 30 }

Or: { x: '50%', y: '50%' }

When specifying multiple colors, you can specify an offset value for each color, defining how far into the gradient it takes effect. For example, the following color array specifies a gradient that goes from red to blue back to red:

colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ]

Android's linear gradients ignores backfillStart and backfillEnd, treating them as if they are true. Android's radial gradients ignore the endPoint property.

Examples

Linear and Radial Gradients

The following code excerpt creates two views, one with a linear gradient and one with a radial gradient.

var win1 = Titanium.UI.createWindow({
    title:'Tab 1',
    backgroundColor:'#fff',
    layout: 'vertical'
});

var radialGradient = Ti.UI.createView({
    top: 10,
    width: 100,
    height: 100,
    backgroundGradient: {
        type: 'radial',
        startPoint: { x: 50, y: 50 },
        endPoint: { x: 50, y: 50 },
        colors: [ 'red', 'blue'],
        startRadius: 50,
        endRadius: 0,
        backfillStart: true
    }
});
var linearGradient = Ti.UI.createView({
    top: 10,
    width: 100,
    height: 100,
    backgroundGradient: {
        type: 'linear',
        startPoint: { x: '0%', y: '50%' },
        endPoint: { x: '100%', y: '50%' },
        colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ],
    }
});
win1.add(radialGradient);
win1.add(linearGradient);
win1.open();

Default: No gradient

Titanium.UI.View

backgroundImage : String

Background image for the view, specified as a local file path or URL. ...

Background image for the view, specified as a local file path or URL.

Default: Default behavior when `backgroundImage` is unspecified depends on the type of view and the platform. For generic views, no image is used. For most controls (buttons, text fields, and so on), platform-specific default images are used.

Titanium.UI.View

backgroundLeftCap : Number

Size of the left end cap. ...

Size of the left end cap.

See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.

Default: 0

Titanium.UI.View

backgroundRepeat : Boolean

Determines whether to tile a background across a view. ...

Determines whether to tile a background across a view.

Setting this to true makes the set backgroundImage repeat across the view as a series of tiles. The tiling begins in the upper-left corner, where the upper-left corner of the background image is rendered. The image is then tiled to fill the available space of the view.

Note that setting this to true may incur performance penalties for large views or background images, as the tiling must be redone whenever a view is resized.

On iOS, the following views do not currently support tiled backgrounds:

Default: false

Titanium.UI.View

backgroundSelectedColor : String

Selected background color of the view, as a color name or hex triplet. ...

Selected background color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

focusable must be true for normal views.

Default: Background color of this view.

Titanium.UI.View

backgroundSelectedImage : String

Selected background image url for the view, specified as a local file path or URL. ...

Selected background image url for the view, specified as a local file path or URL.

For normal views, the selected background is only used if focusable is true.

Default: If `backgroundSelectedImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is selected.

Titanium.UI.View

backgroundTopCap : Number

Size of the top end cap. ...

Size of the top end cap.

See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.

Default: 0

Titanium.UI.Window

barColor : String

Background color for the nav bar, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Titanium.UI.Window

barImage : String

Background image for the nav bar, specified as a URL to a local image.

The behavior of this API on iOS has changed from version 3.2.0. Previous versions of the SDK created a custom image view and inserted it as a child of the navigation bar. The titanium sdk now uses the native call to set the background image of the navigation bar. You can set it to a 1px transparent png to use a combination of barColor and hideShadow:true.

Titanium.UI.View

borderColor : String

Border color of the view, as a color name or hex triplet. ...

Border color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Default: Same as the normal background color of this view (Android), black (iOS).

Titanium.UI.View

borderRadius : Number

Radius for the rounded corners of the view's border. ...

Radius for the rounded corners of the view's border.

Each corner is rounded using an arc of a circle.

Default: 0

Titanium.UI.View

borderWidth : Number

Border width of the view. ...

Border width of the view.

If borderColor is set without borderWidth, this value will be changed to 1 of the unit declared as 'ti.ui.defaultunit' in tiapp.xml descriptor.

Default: 0

Titanium.UI.Window

bottom : Number/String

Window's bottom position, in platform-specific units.

On Android, this property only works with lightweight windows. See "Android Heavyweight and Lightweight Windows" in the main description of Titanium.UI.Window for more information.

Overrides: Titanium.UI.View.bottom

Titanium.Proxy

bubbleParent : Boolean

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.UI.View

center : Point

View's center position, in the parent view's coordinates.

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Titanium.UI.View

children : Titanium.UI.View[]readonly

Array of this view's child views.

Titanium.UI.View

clipMode : Number

View's clipping behavior. ...

View's clipping behavior.

Setting this to Titanium.UI.iOS.CLIP_MODE_ENABLED enforces all child views to be clipped to this views bounds. Setting this to Titanium.UI.iOS.CLIP_MODE_DISABLED allows child views to be drawn outside the bounds of this view. When set to Titanium.UI.iOS.CLIP_MODE_DEFAULT or when this property is not set, clipping behavior is inferred. See section on iOS Clipping Behavior in Titanium.UI.View.

Default: Undefined. Behaves as if set to Titanium.UI.iOS.CLIP_MODE_DEFAULT.

3.3.0
3.3.0

Titanium.UI.View

elevation : Number

Base elevation of the view relative to its parent in pixels. ...

Base elevation of the view relative to its parent in pixels.

Requires: Android 5 and later

The elevation of a view determines the appearance of its shadow. Higher elevations produce larger and softer shadows.

Note: The elevation property only works on Titanium.UI.View objects. Many Android components have a default elevation that cannot be modified. For more information, see Google design guidelines: Elevation and shadows.

5.0.0

Titanium.UI.Window

exitOnClose : Boolean

Boolean value indicating if the application should exit when the Android Back button is pressed while the window is b...

Boolean value indicating if the application should exit when the Android Back button is pressed while the window is being shown or when the window is closed programmatically.

Starting in 3.4.2 you can set this property at any time. In earlier releases you can only set this as a createWindow({...}) option.

Default: true if this is the first window launched else false; prior to Release 3.3.0, the default was always false.

Titanium.UI.Window

extendEdges : Number[]

An array of supported values specified using the EXTEND_EDGE constants in Titanium.UI. ...

An array of supported values specified using the EXTEND_EDGE constants in Titanium.UI. Valid on iOS 7 and greater.

Requires: iOS 7.0 and later

This is only valid for windows hosted by navigation controllers or tab bar controllers. This property is used to determine the layout of the window within its parent view controller. For example if the window is specified to extend its top edge and it is hosted in a navigation controller, then the top edge of the window is extended underneath the navigation bar so that part of the window is obscured. If the navigation bar is opaque (translucent property on window is false), then the top edge of the window will only extend if includeOpaqueBars is set to true.

The default behavior is to assume that no edges are to be extended. Must be specified before opening the window.

This API can be assigned the following constants:

3.1.3
3.1.3

Titanium.UI.Window

extendSafeArea : BooleanCreation-Only

Specifies whether the content (subviews) of the window will render inside the safe-area or not. ...

Specifies whether the content (subviews) of the window will render inside the safe-area or not. Only used in iOS 11.0 and later.

Requires: iOS 11.0 and later

If set true (the default), then the content of the window will be extended to fill the whole screen and under the system's UI elements (such as the top status-bar) and physical obstructions (such as the iPhone X rounded corners and top sensor housing). In this case, it is the app developer's responsibility to position views so that they're unobstructed.

If set false, then the window's content will be laid out within the safe-area and its child views will be unobstructed. For example, you will not need to position a view below the top status-bar.

Read more about the safe-area layout-guide in the Human Interface Guidelines.

Default: true

6.3.0
6.3.0

Titanium.UI.Window

flagSecure : BooleanCreation-Only

Treat the content of the window as secure, preventing it from appearing in screenshots or from being viewed on non-se...

Treat the content of the window as secure, preventing it from appearing in screenshots or from being viewed on non-secure displays.

When the value is true, preventing it from appearing in screenshots or from being viewed on non-secure displays.

Default: false

3.3.0

Titanium.UI.View

focusable : Boolean

Whether view should be focusable while navigating with the trackball. ...

Whether view should be focusable while navigating with the trackball.

Default: false

Titanium.UI.Window

fullscreen : Boolean

Boolean value indicating if the window is fullscreen. ...

Boolean value indicating if the window is fullscreen.

A fullscreen window occupies all of the screen space, hiding the status bar. Must be specified at creation time or in the options dictionary passed to the Window.open method.

On iOS the behavior of this property has changed. Starting from 3.1.3, if this property is undefined then the property is set to the value for UIStatusBarHidden defined in tiapp.xml. If that is not defined it is treated as explicit false. On earlier versions, opening a window with this property undefined would not effect the status bar appearance.

On Android, setting this property forces the creation of a heavyweight window before Titanium 3.2.0. See "Android Heavyweight and Lightweight Windows" in the main description of this class for more information.

Default: false

Titanium.UI.View

height : Number/String

View height, in platform-specific units.

Defaults to: If undefined, defaults to either Titanium.UI.FILL or Titanium.UI.SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.

Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:

Titanium.UI.SIZE. The view should size itself to fit its contents.
Titanium.UI.FILL. The view should size itself to fill its parent.
'auto'. Represents the default sizing behavior for a given type of view. The use of 'auto' is deprecated, and should be replaced with the SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

This is an input property for specifying the view's height dimension. To determine the view's size once rendered, use the rect or size properties.

This API can be assigned the following constants:

Titanium.UI.View

hiddenBehavior : Number

Sets the behavior when hiding an object to release or keep the free space ...

Sets the behavior when hiding an object to release or keep the free space

If setting hiddenBehavior to Titanium.UI.HIDDEN_BEHAVIOR_GONE it will automatically release the space the view occupied. For example: in a vertical layout the views below the object will move up when you hide an object with hiddenBehavior:Titanium.UI.HIDDEN_BEHAVIOR_GONE.

Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE. Keeps the space and just hides the object (default).
Titanium.UI.HIDDEN_BEHAVIOR_GONE. Releases the space and hides the object.

This API can be assigned the following constants:

Default: Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE

6.1.0

Titanium.UI.Window

hideShadow : Boolean

Set this to true to hide the shadow image of the navigation bar. ...

Set this to true to hide the shadow image of the navigation bar.

This property is only honored if a valid value is specified for the barImage property.

Default: false

3.2.0
3.2.0

Titanium.UI.Window

hidesBarsOnSwipe : BooleanCreation-Only

Set this to true to hide the navigation bar on swipe. ...

Set this to true to hide the navigation bar on swipe.

Requires: iOS 8.0 and later

When this property is set to true, an upward swipe hides the navigation bar and toolbar. A downward swipe shows both bars again. If the toolbar does not have any items, it remains visible even after a swipe.

Default: false

6.0.0
6.0.0

Titanium.UI.Window

hidesBarsOnTap : BooleanCreation-Only

Set this to true to hide the navigation bar on tap. ...

Set this to true to hide the navigation bar on tap.

Requires: iOS 8.0 and later

When the value of this property is true, the navigation controller toggles the hiding and showing of its navigation bar and toolbar in response to an otherwise unhandled tap in the content area.

Default: false

6.0.0
6.0.0

Titanium.UI.Window

hidesBarsWhenKeyboardAppears : BooleanCreation-Only

Set this to true to hide the navigation bar when the keyboard appears. ...

Set this to true to hide the navigation bar when the keyboard appears.

Requires: iOS 8.0 and later

When this property is set to true, the appearance of the keyboard causes the navigation controller to hide its navigation bar and toolbar.

Default: false

6.0.0
6.0.0

Titanium.UI.View

horizontalWrap : Boolean

Determines whether the layout has wrapping behavior. ...

Determines whether the layout has wrapping behavior.

For more information, see the discussion of horizontal layout mode in the description of the layout property.

Default: true

2.1.0
2.1.0
2.1.0

Titanium.UI.Window

includeOpaqueBars : Boolean

Specifies if the edges should extend beyond opaque bars (navigation bar, tab bar, toolbar). ...

Specifies if the edges should extend beyond opaque bars (navigation bar, tab bar, toolbar). Valid on iOS 7 and greater.

Requires: iOS 7.0 and later

By default edges are only extended to include translucent bars. However if this is set to true, then edges are extended beyond opaque bars as well.

The default behavior assumes that this is false. Must be specified before opening the window.

3.1.3
3.1.3

Titanium.UI.View

keepScreenOn : Boolean

Determines whether to keep the device screen on. ...

Determines whether to keep the device screen on.

When true the screen will not power down. Note: enabling this feature will use more power, thereby adversely affecting run time when on battery.

Default: false

Titanium.UI.Window

largeTitleDisplayMode : Number

The mode to use when displaying the title of the navigation bar. ...

The mode to use when displaying the title of the navigation bar.

Requires: iOS 11.0 and later

Automatically use the large out-of-line title based on the state of the previous item in the navigation bar. An item with largeTitleDisplayMode = Ti.UI.iOS.LARGE_TITLE_DISPLAY_MODE_AUTOMATIC will show or hide the large title based on the request of the previous navigation item. If the first item pushed is set to Automatic, then it will show the large title if the navigation bar has largeTitleEnabled = true.

This API can be assigned the following constants:

Default: Titanium.UI.iOS.LARGE_TITLE_DISPLAY_MODE_AUTOMATIC

6.3.0
6.3.0

Titanium.UI.Window

largeTitleEnabled : String

A Boolean value indicating whether the title should be displayed in a large format. ...

A Boolean value indicating whether the title should be displayed in a large format.

Requires: iOS 11.0 and later

When set to true, the navigation bar will use a larger out-of-line title view when requested by the current navigation item. To specify when the large out-of-line title view appears, see largeTitleDisplayMode.

Default: false

6.3.0
6.3.0

Titanium.UI.View

layout : String

Specifies how the view positions its children. ...

Specifies how the view positions its children. One of: 'composite', 'vertical', or 'horizontal'.

There are three layout options:

composite (or absolute). Default layout. A child view is positioned based on its positioning properties or "pins" (top, bottom, left, right and center). If no positioning properties are specified, the child is centered.

The child is always sized based on its width and height properties, if these are specified. If the child's height or width is not specified explicitly, it may be calculated implicitly from the positioning properties. For example, if both left and center.x are specified, they can be used to calculate the width of the child control.

Because the size and position properties can conflict, there is a specific precedence order for the layout properties. For vertical positioning, the precedence order is: height, top, center.y, bottom.

The following table summarizes the various combinations of properties that can be used for vertical positioning, in order from highest precedence to lowest. (For example, if height, center.y and bottom are all specified, the height and center.y values take precedence.)

Scenario	Behavior
`height` & `top` specified	Child positioned `top` unit from parent's top, using specified `height`; any `center.y` and `bottom` values are ignored.
`height` & `center.y` specified	Child positioned with center at `center.y`, using specified `height`; any `bottom` value is ignored.
`height` & `bottom` specified	Child positioned `bottom` units from parent's bottom, using specified `height`.
`top` & `center.y` specified	Child positioned with top edge `top` units from parent's top and center at `center.y`. Height is determined implicitly; any `bottom` value is ignored.
`top` & `bottom` specified	Child positioned with top edge `top` units from parent's top and bottom edge `bottom` units from parent's bottom. Height is determined implicitly.
Only `top` specified	Child positioned `top` units from parent's top, and uses the default height calculation for the view type.
`center.y` and `bottom` specified	Child positioned with center at `center.y` and bottom edge `bottom` units from parent's bottom. Height is determined implicitly.
Only `center.y` specified	Child positioned with center at `center.y`, and uses the default height calculation for the view type.
Only `bottom` specified	Child positioned with bottom edge `bottom` units from parent's bottom, and uses the default height calculation for the view type.
`height`, `top`, `center.y`, and `bottom` unspecified	Child centered vertically in the parent and uses the default height calculation for the child view type.

Horizontal positioning works like vertical positioning, except that the precedence is width, left, center.x, right.

For complete details on composite layout rules, see Transitioning to the New UI Layout System in the Titanium Mobile Guides.

vertical. Children are laid out vertically from top to bottom. The first child is laid out top units from its parent's bounding box. Each subsequent child is laid out below the previous child. The space between children is equal to the upper child's bottom value plus the lower child's top value.

Each child is positioned horizontally as in the composite layout mode.

horizontal. Horizontal layouts have different behavior depending on whether wrapping is enabled. Wrapping is enabled by default (the horizontalWrap property is true).

With wrapping behavior, the children are laid out horizontally from left to right, in rows. If a child requires more horizontal space than exists in the current row, it is wrapped to a new row. The height of each row is equal to the maximum height of the children in that row.

Wrapping behavior is available on iOS and Android (Release 2.1.0 and later). When the horizontalWrap property is set to true, the first row is placed at the top of the parent view, and successive rows are placed below the first row. Each child is positioned vertically within its row somewhat like composite layout mode. In particular:

If neither top or bottom is specified, the child is centered in the row.
If either top or bottom is specified, the child is aligned to either the top or bottom of the row, with the specified amount of padding.
If both top and bottom is specified for a given child, the properties are both treated as padding.

If the horizontalWrap property is false, the behavior is more equivalent to a vertical layout. Children are laid or horizontally from left to right in a single row. The left and right properties are used as padding between the children, and the top and bottom properties are used to position the children vertically.

On Android and iOS prior to Release 2.1.0, the horizontal layout always wraps and the horizontalWrap property is not supported.

Default: Composite layout

Titanium.UI.Window

left : Number/String

Window's left position, in platform-specific units.

On Android, this property only works with lightweight windows. See "Android Heavyweight and Lightweight Windows" in the main description of Titanium.UI.Window for more information.

Overrides: Titanium.UI.View.left

Titanium.UI.Window

leftNavButton : Titanium.UI.View

View to show in the left nav bar area.

In an Alloy application you can specify this property with a <LeftNavButton> element inside the <Window> element, for example:

<Alloy>
    <TabGroup>
        <Tab>
            <Window class="container">
                <LeftNavButton platform=ios>
                    <Button title="Back" onClick="closeWindow" />
                </LeftNavButton>
            </Window>
        </Tab>
    </TabGroup>
</Alloy>

Titanium.UI.Window

leftNavButtons : Titanium.UI.View[]

An Array of views to show in the left nav bar area.

3.3.0
3.3.0

Titanium.Proxy

lifecycleContainer : Titanium.UI.Window/Titanium.UI.TabGroup

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.UI.Window

navBarHidden : Boolean

Hides the navigation bar (true) or shows the navigation bar (false). ...

Hides the navigation bar (true) or shows the navigation bar (false).

iOS Platform Notes

Since Titanium SDK 6.0.0, you can use this property to hide and show the property as well.

Using this property, the navigation bar will be hidden or shown animated by default. Please note that this property will only take effect if the window is used inside a Titanium.UI.iOS.NavigationWindow and will be ignored otherwise. If you want to hide or show the navigation without an animation, use t he methods showNavBar and hideNavBar with the second parameter to specify the animation:

// "myWindow" is a Ti.UI.Window inside a Ti.UI.iOS.NavigationWindow
myWindow.hideNavBar(true, {animated: false});

Android Platform Notes

Since Release 3.3.0, due to changes to support the appcompat library, this property has no effect. By default, the action bar is always displayed. To hide the action bar, see the Android Action Bar guide.

Default: false

Titanium.UI.Window

navTintColor : String

The tintColor to apply to the navigation bar. ...

The tintColor to apply to the navigation bar. This property is applicable on iOS 7 and greater.

Requires: iOS 7.0 and later

This property is a direct correspondant of the tintColor property of NavigationBar on iOS.

Default:

3.1.3
3.1.3

Titanium.UI.Window

onBack : Callback<Object>

Callback function that overrides the default behavior when the user presses the Back button.

This was separated from the event. You need to define this callback if you explicitly want to override the back button behavior.

Titanium.UI.Window

opacity : Number

The opacity from 0.0-1.0. ...

The opacity from 0.0-1.0.

iOS notes: For modal windows that cover the previous window, the previous window is removed from the render stack after the modal window finishes opening. If the modal window is semi-transparent, the underlying window will be visible during the transition animation, but disappear as soon as the animation is completed. (In general all modal windows cover the previous window, except for iPad modal windows using the Page sheet or Form sheet style.)

Android notes: If you set any of windowSoftInputMode, fullscreen, or navBarHidden, and you wish to use the opacity property at any time during the window's lifetime, be sure to set an opacity value before opening the window. You can later change that value -- and you can set it to 1 for full opacity if you wish -- but the important thing is that you set it to a value before opening the window if you will want to set it at any time during the window's lifetime.

The technical reason for this is that if the opacity property is present (i.e., has been set to something) and a new Android Activity is created for the window, then a translucent theme will be used for the Activity. Window transparency (opacity values below 1) will only work in Android if the Activity's theme is translucent, and Titanium only uses a translucent theme for an Activity if you set an opacity property before opening the window. Additionally, do not use opacity and fullscreen: true together, because translucent themes in Android cannot hide the status bar. Finally, if you do set the opacity property, be sure to also set a backgroundImage or backgroundColor property as well, unless you want the window to be completely transparent.

Default: 1.0 (opaque)

Overrides: Titanium.UI.View.opacity

Titanium.UI.Window

orientation : Numberreadonly

Current orientation of the window.

To determine the current orientation of the device, see Gesture.orientation, instead.

See the discussion of the orientationModes property for more information on how the screen orientation is determined.

This API can be assigned the following constants:

0.9
3.0.0
3.0.0

Titanium.UI.Window

orientationModes : Number[]

Array of supported orientation modes, specified using the orientation constants defined in Titanium.UI. ...

Array of supported orientation modes, specified using the orientation constants defined in Titanium.UI.

Note: Using the orientationModes property to force the orientation of non-modal windows is considered a bad practice and will not be supported, including forcing the orientation of windows inside a NavigationWindow or TabGroup.

To restrict this window to a certain set of orientations, specify one or more of the orientation constants LANDSCAPE_LEFT, LANDSCAPE_RIGHT, PORTRAIT, UPSIDE_PORTRAIT.

orientationModes must be set before opening the window.

To determine the current orientation of the window, see Window.orientation. To determine the current orientation of the device, see Gesture.orientation. To be notified when the device's current orientation changes, add a listener for the Titanium.Gesture.orientationchange event.

Android Orientation Modes

On Android, orientationModes only takes effect when specified on a heavyweight window.

On Android, orientation behavior is dependent on the Android SDK level of the device itself. Devices running Android 2.3 and above support "sensor portait mode" and "sensor landscape mode," in these modes, the device is locked into either a portrait or landscape orientation, but can switch between the normal and reverse orientations (for example, between PORTRAIT and UPSIDE_PORTRAIT).

In addition, the definition of portrait or landscape mode can vary based on the physical design of the device. For example, on some devices Titanium.UI.LANDSCAPE_LEFT represents the top of the device being at the 270 degree position but other devices may (based on camera position for example) treat this position as Titanium.UI.LANDSCAPE_RIGHT. In general, applications for Android that need to be aware of orientation should try and limit their orientation logic to handling either portrait or landscape rather than worrying about the reverse modes. This approach will allow the orientation modes to adopt a more natural feel for the specific device.

The following list breaks down the orientation behavior on Android based on the contents of the orientationModes array:

Empty array. Enables orientation to be fully controlled by the device sensor.
Array includes one or both portrait modes and one or both landscape modes. Enables full sensor control (identical to an empty array).
Array contains PORTRAIT and UPSIDE_PORTRAIT. On Android 2.3 and above, enables sensor portrait mode. This means the screen will shift between both portrait modes according to the sensor inside the device.

On Android versions below 2.3, locks screen orientation in normal portrait mode.
Array contains LANDSCAPE_LEFT and LANDSCAPE_RIGHT. On Android 2.3 and above, enables sensor landscape mode. This means the screen will shift between both landscape modes according to the sensor inside the device.

On Android versions below 2.3, locks screen orientation in normal landscape mode.
Array contains only PORTRAIT. Locks screen orientation to normal portrait mode.
Array contains only LANDSCAPE_LEFT. Locks screen orientation to normal landscape mode.
Array contains only UPSIDE_PORTRAIT. On Android 2.3 and above, locks screen in reverse portrait mode.

On Android versions below 2.3, results are undefined.
Array contains only LANDSCAPE_RIGHT. On Android 2.3 and above, locks screen in reverse landscape mode.

On Android versions below 2.3, results are undefined.

This API can be assigned the following constants:

Default: empty array

Titanium.UI.View

overrideCurrentAnimation : BooleanCreation-Only

When on, animate call overrides current animation if applicable. ...

When on, animate call overrides current animation if applicable.

If this property is set to false, the animate call is ignored if the view is currently being animated.

Default: undefined but behaves as false

3.3.0

Titanium.UI.View

previewContext : Titanium.UI.iOS.PreviewContext

The preview context used in the 3D-Touch feature "Peek and Pop". ...

The preview context used in the 3D-Touch feature "Peek and Pop".

Requires: iOS 9.0 and later

Preview context to present the "Peek and Pop" of a view. Use an configured instance of Titanium.UI.iOS.PreviewContext here.

Note: This property can only be used on devices running iOS9 or later and supporting 3D-Touch. It is ignored on older devices and can manually be checked using Titanium.UI.iOS.forceTouchSupported.

5.1.0

Titanium.UI.View

pullBackgroundColor : String

Background color of the wrapper view when this view is used as either Titanium.UI.ListView.pullView or Titanium.UI.Ta...

Background color of the wrapper view when this view is used as either Titanium.UI.ListView.pullView or Titanium.UI.TableView.headerPullView.

Default: Undefined. Results in a light grey background color on the wrapper view.

3.3.0
3.3.0

Titanium.UI.View

rect : Dimensionreadonly

The bounding box of the view relative to its parent, in system units.

The view's bounding box is defined by its size and position.

The view's size is rect.width x rect.height. The view's top-left position relative to its parent is (rect.x , rect.y).

On Android it will also return rect.absoluteX and 'rect.absoluteY' which are relative to the main window.

The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.

2.0.0
2.0.0
2.0.0

Titanium.UI.Window

right : Number/String

Window's right position, in platform-specific units.

On Android, this property only works with lightweight windows. See "Android Heavyweight and Lightweight Windows" in the main description of Titanium.UI.Window for more information.

Overrides: Titanium.UI.View.right

Titanium.UI.Window

rightNavButton : Titanium.UI.View

View to show in the right nav bar area.

In an Alloy application you can specify this property with a <RightNavButton> element in the <Window> element, for example:

<Alloy>
    <TabGroup>
        <Tab>
            <Window class="container">
                <RightNavButton platform=ios>
                    <Button title="Back" onClick="closeWindow" />
                </RightNavButton>
            </Window>
        </Tab>
    </TabGroup>
</Alloy>

Titanium.UI.Window

rightNavButtons : Titanium.UI.View[]

An Array of views to show in the right nav bar area.

3.3.0
3.3.0

Titanium.UI.View

rotation : Number

Clockwise 2D rotation of the view in degrees.

Translation values are applied to the static post layout value.

5.4.0

Titanium.UI.View

rotationX : Number

Clockwise rotation of the view in degrees (x-axis).

Translation values are applied to the static post layout value.

5.4.0

Titanium.UI.View

rotationY : Number

Clockwise rotation of the view in degrees (y-axis).

Translation values are applied to the static post layout value.

5.4.0

Titanium.UI.View

scaleX : Number

Scaling of the view in x-axis in pixels.

Translation values are applied to the static post layout value.

5.4.0

Titanium.UI.View

scaleY : Number

Scaling of the view in y-axis in pixels.

Translation values are applied to the static post layout value.

5.4.0

Titanium.UI.Window

shadowImage : String

Shadow image for the navigation bar, specified as a URL to a local image..

This property is only honored if a valid value is specified for the barImage property.

3.2.0
3.2.0

Titanium.UI.View

size : Dimensionreadonly

The size of the view in system units.

Although property returns a Dimension dictionary, only the width and height properties are valid. The position properties--x and y--are always 0.

To find the position and size of the view, use the rect property instead.

The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.

Titanium.UI.View

softKeyboardOnFocus : Number

Determines keyboard behavior when this view is focused. ...

Determines keyboard behavior when this view is focused.

This API can be assigned the following constants:

Default: Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS

Titanium.UI.Window

splitActionBar : BooleandeprecatedCreation-Only

Boolean value to enable split action bar. ...

Boolean value to enable split action bar.

deprecated since 6.2.0

Deprecated in AppCompat theme. The same behaviour can be achived by using Toolbar.

splitActionBar must be set before opening the window. This property indicates if the window should use a split action bar

3.6.0

Titanium.UI.Window

statusBarStyle : Number

The status bar style associated with this window.

Sets the status bar style when this window has focus. This is now the recommended way to control the status bar style on the application.

If this value is undefined, the value is set to UIStatusBarStyle defined in tiapp.xml. If that is not defined it defaults to Titanium.UI.iOS.StatusBar.DEFAULT.

This API can be assigned the following constants:

3.1.3
3.1.3

Titanium.UI.Window

sustainedPerformanceMode : Boolean

Maintain a sustainable level of performance. ...

Maintain a sustainable level of performance.

Requires: Android 7.0 and later

Performance can fluctuate dramatically for long-running apps, because the system throttles system-on-chip engines as device components reach their temperature limits. This fluctuation presents a moving target for app developers creating high-performance, long-running apps.

Setting this feature to true will set sustained performance mode for the corresponding window. If property is undefined then it defaults to false.

Note: This feature is only available on supported devices. The functionality is experimental and subject to change in future releases. See Android docs and Google VR docs for further info.

7.0.0

Titanium.UI.Window

swipeToClose : Boolean

Boolean value indicating if the user should be able to close a window using a swipe gesture. ...

Boolean value indicating if the user should be able to close a window using a swipe gesture.

If false the user will not be able to swipe from the left edge of the window to close it. Note: This property is only used for a window being embedded in a Ti.UI.Tab or Ti.UI.iOS.NavigationWindow. It is enabled by default.

Default: true

5.2.0
5.2.0

Titanium.UI.Window

tabBarHidden : Boolean

Boolean value indicating if the tab bar should be hidden.

tabBarHidden must be set before opening the window.

This property is only valid when the window is the child of a tab.

Titanium.UI.Window

theme : StringCreation-Only

Name of the theme to apply to the window.

Set the theme of the window. It can be either a built-in theme or a custom theme.

3.4.0

Titanium.UI.View

tintColor : String

The view's tintColor. ...

The view's tintColor. This property is applicable on iOS 7 and greater.

Requires: iOS 7.0 and later

This property is a direct correspondant of the tintColor property of UIView on iOS. If no value is specified, the tintColor of the View is inherited from its superview.

Default:

3.1.3
3.1.3

Titanium.UI.Window

title : String

Title of the window.

Titanium.UI.Window

titleAttributes : titleAttributesParams

Title text attributes of the window.

Use this property to specify the color, font and shadow attributes of the title.

3.2.0
3.2.0

Titanium.UI.Window

titleControl : Titanium.UI.View

View to show in the title area of the nav bar.

In an Alloy application you can specify this property using a <TitleControl> element inside <Window>, for example:

<Alloy>
    <Window>
        <RightNavButton>
            <Button title="Back" />
        </RightNavButton>
        <LeftNavButton>
            <Button title="Back" />
        </LeftNavButton>
        <TitleControl>
            <View backgroundColor="blue" height="100%" width="100%"></View>
        </TitleControl>
    </Window>
</Alloy>

Titanium.UI.Window

titleImage : String

Image to show in the title area of the nav bar, specified as a local file path or URL.

Titanium.UI.Window

titlePrompt : String

Title prompt for the window.

Titanium.UI.Window

titleid : String

Key identifying a string from the locale file to use for the window title.

Only one of title or titleid should be specified.

Titanium.UI.Window

titlepromptid : String

Key identifying a string from the locale file to use for the window title prompt.

Only one of titlePrompt or titlepromptid should be specified.

Titanium.UI.Window

toolbar : Object[]

Array of button objects to show in the window's toolbar.

The toolbar is only shown when the window is inside a Titanium.UI.iOS.NavigationWindow. To display a toolbar when a window is not inside a NavigationWindow, add an instance of a Titanium.UI.iOS.Toolbar to the window.

To customize the toolbar, use the setToolbar() method.

Since Alloy 1.6.0, you can specify this property using the <WindowToolbar> element as a child of a <Window> element, for example:

<Alloy>
    <NavigationWindow>
        <Window>
            <WindowToolbar>
                <Button id="send" title="Send" style="Ti.UI.iOS.SystemButtonStyle.DONE" />
                <FlexSpace/>
                <Button id="camera" systemButton="Ti.UI.iOS.SystemButton.CAMERA" />
                <FlexSpace/>
                <Button id="cancel" systemButton="Ti.UI.iOS.SystemButton.CANCEL" />
            </WindowToolbar>
        </Window>
    </NavigationWindow>
</Alloy>

Titanium.UI.Window

top : Number/String

Window's top position, in platform-specific units.

On Android, this property only works with lightweight windows. See "Android Heavyweight and Lightweight Windows" in the main description of Titanium.UI.Window for more information.

Overrides: Titanium.UI.View.top

Titanium.UI.View

touchEnabled : Boolean

Determines whether view should receive touch events. ...

Determines whether view should receive touch events.

If false, will forward the events to peers.

Default: true

Titanium.UI.View

touchFeedback : Boolean

A material design visual construct that provides an instantaneous visual confirmation of touch point. ...

A material design visual construct that provides an instantaneous visual confirmation of touch point.

Requires: Android 5.0 and later

This is an opt-in feature available from Android Lollipop. Touch feedback is applied only if the backgroundColor is a solid color.

Default: false

6.1.0

Titanium.UI.View

touchFeedbackColor : String

Optional touch feedback ripple color. ...

Optional touch feedback ripple color. This has no effect unless touchFeedback is true.

Requires: Android 5.0 and later

Default: Theme provided color.

6.1.0

Titanium.UI.View

transform : Titanium.UI.2DMatrix/Titanium.UI.3DMatrix

Transformation matrix to apply to the view. ...

Transformation matrix to apply to the view.

Android only supports 2DMatrix transforms.

Default: Identity matrix

Titanium.UI.Window

transitionAnimation : Titanium.Proxy

Use a transition animation when opening or closing windows in a Titanium.UI.iOS.NavigationWindow or Titanium.UI.Tab. ...

Use a transition animation when opening or closing windows in a Titanium.UI.iOS.NavigationWindow or Titanium.UI.Tab.

Requires: iOS 7.0 and later

Create the transition animation using the Titanium.UI.iOS.createTransitionAnimation method.

Supported on iOS 7 and later.

3.2.0
3.2.0

Titanium.UI.View

transitionName : String

A name to identify this view in activity transition. ...

A name to identify this view in activity transition.

Requires: Android 5 and later

Name should be unique in the View hierarchy.

5.0.2

Titanium.UI.View

translationX : Number

Horizontal location of the view relative to its left position in pixels.

Translation values are applied to the static post layout value.

5.0.0

Titanium.UI.View

translationY : Number

Vertical location of the view relative to its top position in pixels.

Translation values are applied to the static post layout value.

5.0.0

Titanium.UI.View

translationZ : Number

Depth of the view relative to its elevation in pixels. ...

Depth of the view relative to its elevation in pixels.

Requires: Android 5 and later

Translation values are applied to the static post layout value.

5.0.0

Titanium.UI.Window

translucent : Boolean

Boolean value indicating if the nav bar is translucent. ...

Boolean value indicating if the nav bar is translucent.

Default: true on iOS7 and above, false otherwise.

Titanium.UI.Window

url : StringremovedCreation-Only

Loads a JavaScript file from a local URL.

This property has been removed since 6.0.0

Note: The recommended way of creating windows with their own context is to either use the Alloy Framework or a CommonJS module than using this property. One benefit of using a CommonJS module is that it consumes less resources.

Use this property to have Windows load a JavaScript file in its own subcontext and thread, separate from the app.js global context. Reference a file relative to your project's Resources folder for classic Titanium projects or app/lib folder for Alloy projects.

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.

When loading JavaScript files using this property, the special property Titanium.UI.currentWindow is available inside a multi-context application that points to the JavaScript instance by reference in the global context.

Titanium.UI.View

viewShadowColor : String

Determines the color of the shadow. ...

Determines the color of the shadow.

Default: Undefined. Behaves as if transparent.

3.3.0
3.3.0

Titanium.UI.View

viewShadowOffset : Point

Determines the offset for the shadow of the view. ...

Determines the offset for the shadow of the view.

Default: Undefined. Behaves as if set to (0,-3)

3.3.0
3.3.0

Titanium.UI.View

viewShadowRadius : Number

Determines the blur radius used to create the shadow. ...

Determines the blur radius used to create the shadow.

Default: Undefined. Behaves as if set to 3.

3.3.0
3.3.0

Titanium.UI.View

visible : Boolean

Determines whether the view is visible. ...

Determines whether the view is visible.

Default: true

Titanium.UI.View

width : Number/String

View's width, in platform-specific units.

Defaults to: If undefined, defaults to either Titanium.UI.FILL or Titanium.UI.SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.

Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:

Titanium.UI.SIZE. The view should size itself to fit its contents.
Titanium.UI.FILL. The view should size itself to fill its parent.
'auto'. Represents the default sizing behavior for a given type of view. The use of 'auto' is deprecated, and should be replaced with the SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

This is an input property for specifying the view's width dimension. To determine the view's size once rendered, use the rect or size properties.

This API can be assigned the following constants:

Titanium.UI.Window

windowFlags : NumberCreation-Only

Additional flags to set on the Activity Window.

Set the flags of the window, as per the WindowManager.LayoutParams flags. See WindowManager.LayoutParams for a list of supported flags. Setting fullscreen to true automatically sets the WindowManager.LayoutParams.FLAG_FULLSCREEN flag. Setting flagSecure to true automatically sets the WindowManager.LayoutParams.FLAG_SECURE flag.

3.3.0

Titanium.UI.Window

windowPixelFormat : Number

Set the pixel format for the Activity's Window.

For more information on pixel formats, see Android SDK Window.setFormat

This API can be assigned the following constants:

1.8.0

Titanium.UI.Window

windowSoftInputMode : NumberCreation-Only

Determines whether a heavyweight window's soft input area (ie software keyboard) is visible as it receives focus and ...

Determines whether a heavyweight window's soft input area (ie software keyboard) is visible as it receives focus and how the window behaves in order to accomodate it while keeping its contents in view.

In order for this property to take effect on an emulator, its Android Virtual Device (AVD) must be configured with the Keyboard Support setting set to No. Note that it is always recommended to test an application on a physical device to understand its true behavior.

Setting this property forces the creation of a heavyweight window before Titanium 3.2.0. See "Android Heavyweight and Lightweight Windows" in the main description of this class for more information.

This property is capable of representing two settings from the soft input visibility constatns and soft input adjustment constants using the bitwise OR operation.

Note that in JavaScript, bitwise OR is achieved using the single pipe operand. See the example for a demonstration.

For more information, see the official Android Developers website API Reference for Window.setSoftInputMode.

This API can be assigned the following constants:

Examples

Soft Input Visibility and Adjustment

Create a white window and respond to a click of it to open a red window containing a text area. Show the software keyboard automatically as the red window opens.

var win1 = Ti.UI.createWindow({
  backgroundColor: 'white',
  exitOnClose: true,
  fullscreen: false,
  title: 'Click window to test'
});

// use bitwise OR to combine two settings for the windowSoftInputMode property
var softInput = Ti.UI.Android.SOFT_INPUT_STATE_ALWAYS_VISIBLE | Ti.UI.Android.SOFT_INPUT_ADJUST_PAN;

win1.addEventListener('click', function(){
var win2 = Ti.UI.createWindow({
  backgroundColor: 'red',
  fullscreen: false,
  windowSoftInputMode: softInput
});

var textArea = Ti.UI.createTextArea({
  value : 'I am a textarea',
  height : 200,
  width : 300,
  top : 200
});
win2.add(textArea);
win2.open();
});

win1.open();

Titanium.UI.View

zIndex : Number

Z-index stack order position, relative to other sibling views.

A view does not have a default z-index value, meaning that it is undefined by default. When this property is explicitly set, regardless of its value, it causes the view to be positioned in front of any sibling that has an undefined z-index.

Defined By

Methods

Titanium.UI.View

add( view )

Adds a child to this view's hierarchy. ...

Adds a child to this view's hierarchy.

The child view is added as the last child in this view's hierarchy.

Although all views inherit from Titanium.UI.View, not all views are capable of containing other views. In particular:

Some views are not designed to be containers at all.
Some views are special-purpose containers that can only contain certain other views.
Some views are top-level containers that cannot (or should not) be added to other views.

Non-Container Views

The following views are not intended to act as containers that can hold other views:

Adding children to the these views may be supported on some platforms, but is not guaranteed to work across platforms. Where it is supported, it may not work as expected.

For maximum portability, these views should be treated as if they do not support children. Instead of adding children to these views, applications can positon other views as siblings. For example, instead of adding a button as a child of a WebView, you can add the button to the web view's parent such that it appears on top of the web view.

Special-Purpose Containers

A few view objects act as special-purpose containers--that is, they only manage certain types of children, and many of them support a special means of adding these children, instead of the general add method. These containers include:

ButtonBar and TabbedBar are designed to hold their own internally-created buttons, assigned by adding strings to the "labels" array. Views added using the add method are displayed on top of these buttons.
Picker. Can only hold PickerRows and PickerColumns, which are added using the add method. Adding other types of views to a Picker is not supported.
TableView is a specialized container for TableViewSection and TableViewRow objects. These objects must be added using the properties and methods that TableView provides for adding and removing sectons and rows.

On some platforms, it is possible to add arbitrary child views to a table view using the add method. However, this is not guaranteed to work on all platforms, and in general, should be avoided.
TableViewSection is a specialized container for TableViewRow objects, which are added using the add method. The add method on TableViewSection can only be used to add TableViewRow objects.
Toolbar is designed to hold buttons and certain other controls, added to its items array. Views added using the add method are displayed on top of the controls in the items array.
The Tab, TabGroup, NavigationWindow and SplitWindow objects are special containers that manage windows. These are discussed in the "Top-Level Containers" section.

Top-Level Containers

There are certain top-level containers that are not intended to be added as the children of other views. These top-level containers include Titanium.UI.Window, Titanium.UI.iPad.SplitWindow, Titanium.UI.iOS.NavigationWindow, and Titanium.UI.TabGroup. Other types of views must be added to a top-level container in order to be displayed on screen.

The special containers Titanium.UI.iOS.NavigationWindow, Titanium.UI.iPad.SplitWindow, Titanium.UI.Tab, and Titanium.UI.TabGroup manage windows. These managed windows may be referred to as children of the container, but they are not added using the add method.

Tab is another kind of special container: it is not itself a top-level container, but can only be used within a TabGroup. You cannot add a Tab to an arbitrary container.

Parameters

view : Titanium.UI.View/Array<Titanium.UI.View>
View to add to this view's hierarchy.

You may pass an array of views, e.g. view.add([subview1, subview2].

Returns

void

Titanium.Proxy

addEventListener( name, callback )

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

Titanium.UI.Window

addSharedElement( view, transitionName )

Adds a common UI element to participate in window transition animation. ...

Adds a common UI element to participate in window transition animation.

Requires: Android 5 and later

Available from Android 5.0. Use the current window's UI element that is contextually shared with the other window.

5.2.0

Parameters

view : Titanium.UI.View
The shared view from the current window.
transitionName : String
The assigned common transition name of UI elements in both windows.

Returns

void

Titanium.UI.View

animate( animation, callback )

Animates this view. ...

Animates this view.

The Animation object or dictionary passed to this method defines the end state for the animation, the duration of the animation, and other properties.

Note that if you use animate to move a view, the view's actual position is changed, but its layout properties, such as top, left, center and so on are not changed--these reflect the original values set by the user, not the actual position of the view.

The rect property can be used to determine the actual size and position of the view.

Parameters

animation : Titanium.UI.Animation/Dictionary<Titanium.UI.Animation>
Either a dictionary of animation properties or an Animation object.
callback : Callback<Object>
Function to be invoked upon completion of the animation.

Returns

void

Titanium.Proxy

applyProperties( props )

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

Titanium.UI.Window

close( [params] )

Closes the window. ...

Closes the window.

Android only supports the argument type closeWindowParams.

Parameters

params : Dictionary<Titanium.UI.Animation>/closeWindowParams (optional)
Animation or display properties to use when closing the window.

Returns

void

Titanium.UI.View

convertPointToView( point, destinationView ) : Point

Translates a point from this view's coordinate system to another view's coordinate system. ...

Translates a point from this view's coordinate system to another view's coordinate system.

Returns null if either view is not in the view hierarchy.

Keep in mind that views may be removed from the view hierarchy if their window is blurred or if the view is offscreen (such as in some situations with Titanium.UI.ScrollableView).

If this view is a Titanium.UI.ScrollView, the view's x and y offsets are subtracted from the return value.

Parameters

point : Point
A point in this view's coordinate system.

If this argument is missing an x or y property, or the properties can not be converted into numbers, an exception will be raised.
destinationView : Titanium.UI.View
View that specifies the destination coordinate system to convert to. If this argument is not a view, an exception will be raised.

Returns

Point

Titanium.UI.View

finishLayout( )deprecated

Finishes a batch update of the View's layout properties and schedules a layout pass of the view tree. ...

Finishes a batch update of the View's layout properties and schedules a layout pass of the view tree.

deprecated since 3.0.0

Use the <Titanium.Proxy.applyProperties> method to batch-update layout properties.

Since the layout pass scheduled is asynchronous, the rect and size values may not be available immediately after finishLayout is called.

To be notified when the layout pass completes, add a listener for the postlayout event.

2.0.0
2.0.0
2.0.0

Returns

void

Titanium.Proxy

fireEvent( name, event )

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

Titanium.UI.View

getAccessibilityHidden( ) : Boolean

Gets the value of the accessibilityHidden property. ...

Gets the value of the accessibilityHidden property.

3.0.0
3.0.0
3.0.0

Returns

Boolean

Titanium.UI.View

getAccessibilityHint( ) : String

Gets the value of the accessibilityHint property. ...

Gets the value of the accessibilityHint property.

3.0.0
3.0.0
3.0.0

Returns

String

Titanium.UI.View

getAccessibilityLabel( ) : String

Gets the value of the accessibilityLabel property. ...

Gets the value of the accessibilityLabel property.

3.0.0
3.0.0
3.0.0

Returns

String

Titanium.UI.View

getAccessibilityValue( ) : String

Gets the value of the accessibilityValue property. ...

Gets the value of the accessibilityValue property.

3.0.0
3.0.0
3.0.0

Returns

String

Titanium.UI.Window

getActivity( ) : Titanium.Android.Activity

Gets the value of the activity property. ...

Gets the value of the activity property.

Returns

Titanium.Android.Activity

Titanium.UI.Window

getActivityEnterTransition( ) : Number

Gets the value of the activityEnterTransition property. ...

Gets the value of the activityEnterTransition property.

5.2.0

Returns

Number

Titanium.UI.Window

getActivityExitTransition( ) : Number

Gets the value of the activityExitTransition property. ...

Gets the value of the activityExitTransition property.

5.2.0

Returns

Number

Titanium.UI.Window

getActivityReenterTransition( ) : Number

Gets the value of the activityReenterTransition property. ...

Gets the value of the activityReenterTransition property.

5.2.0

Returns

Number

Titanium.UI.Window

getActivityReturnTransition( ) : Number

Gets the value of the activityReturnTransition property. ...

Gets the value of the activityReturnTransition property.

5.2.0

Returns

Number

Titanium.UI.Window

getActivitySharedElementEnterTransition( ) : Number

Gets the value of the activitySharedElementEnterTransition property. ...

Gets the value of the activitySharedElementEnterTransition property.

5.2.0

Returns

Number

Titanium.UI.Window

getActivitySharedElementExitTransition( ) : Number

Gets the value of the activitySharedElementExitTransition property. ...

Gets the value of the activitySharedElementExitTransition property.

5.2.0

Returns

Number

Titanium.UI.Window

getActivitySharedElementReenterTransition( ) : Number

Gets the value of the activitySharedElementReenterTransition property. ...

Gets the value of the activitySharedElementReenterTransition property.

5.2.0

Returns

Number

Titanium.UI.Window

getActivitySharedElementReturnTransition( ) : Number

Gets the value of the activitySharedElementReturnTransition property. ...

Gets the value of the activitySharedElementReturnTransition property.

5.2.0

Returns

Number

Titanium.UI.View

getAnchorPoint( ) : Point

Gets the value of the anchorPoint property. ...

Gets the value of the anchorPoint property.

Returns

Point

Titanium.UI.View

getAnimatedCenter( ) : Point

Gets the value of the animatedCenter property. ...

Gets the value of the animatedCenter property.

Returns

Point

Titanium.Proxy

getApiName( ) : String

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

Titanium.UI.Window

getAutoAdjustScrollViewInsets( ) : Boolean

Gets the value of the autoAdjustScrollViewInsets property. ...

Gets the value of the autoAdjustScrollViewInsets property.

3.1.3
3.1.3

Returns

Boolean

Titanium.UI.Window

getBackButtonTitle( ) : String

Gets the value of the backButtonTitle property. ...

Gets the value of the backButtonTitle property.

Returns

String

Titanium.UI.Window

getBackButtonTitleImage( ) : String/Titanium.Blob

Gets the value of the backButtonTitleImage property. ...

Gets the value of the backButtonTitleImage property.

Returns

String/Titanium.Blob

Titanium.UI.Window

getBackgroundColor( ) : String

Gets the value of the backgroundColor property. ...

Gets the value of the backgroundColor property.

Returns

String

Overrides: Titanium.UI.View.getBackgroundColor

Titanium.UI.View

getBackgroundDisabledColor( ) : String

Gets the value of the backgroundDisabledColor property. ...

Gets the value of the backgroundDisabledColor property.

Returns

String

Titanium.UI.View

getBackgroundDisabledImage( ) : String

Gets the value of the backgroundDisabledImage property. ...

Gets the value of the backgroundDisabledImage property.

Returns

String

Titanium.UI.View

getBackgroundFocusedColor( ) : String

Gets the value of the backgroundFocusedColor property. ...

Gets the value of the backgroundFocusedColor property.

Returns

String

Titanium.UI.View

getBackgroundFocusedImage( ) : String

Gets the value of the backgroundFocusedImage property. ...

Gets the value of the backgroundFocusedImage property.

Returns

String

Titanium.UI.View

getBackgroundGradient( ) : Gradient

Gets the value of the backgroundGradient property. ...

Gets the value of the backgroundGradient property.

Returns

Gradient

Titanium.UI.View

getBackgroundImage( ) : String

Gets the value of the backgroundImage property. ...

Gets the value of the backgroundImage property.

Returns

String

Titanium.UI.View

getBackgroundLeftCap( ) : Number

Gets the value of the backgroundLeftCap property. ...

Gets the value of the backgroundLeftCap property.

Returns

Number

Titanium.UI.View

getBackgroundRepeat( ) : Boolean

Gets the value of the backgroundRepeat property. ...

Gets the value of the backgroundRepeat property.

Returns

Boolean

Titanium.UI.View

getBackgroundSelectedColor( ) : String

Gets the value of the backgroundSelectedColor property. ...

Gets the value of the backgroundSelectedColor property.

Returns

String

Titanium.UI.View

getBackgroundSelectedImage( ) : String

Gets the value of the backgroundSelectedImage property. ...

Gets the value of the backgroundSelectedImage property.

Returns

String

Titanium.UI.View

getBackgroundTopCap( ) : Number

Gets the value of the backgroundTopCap property. ...

Gets the value of the backgroundTopCap property.

Returns

Number

Titanium.UI.Window

getBarColor( ) : String

Gets the value of the barColor property. ...

Gets the value of the barColor property.

Returns

String

Titanium.UI.Window

getBarImage( ) : String

Gets the value of the barImage property. ...

Gets the value of the barImage property.

Returns

String

Titanium.UI.View

getBorderColor( ) : String

Gets the value of the borderColor property. ...

Gets the value of the borderColor property.

Returns

String

Titanium.UI.View

getBorderRadius( ) : Number

Gets the value of the borderRadius property. ...

Gets the value of the borderRadius property.

Returns

Number

Titanium.UI.View

getBorderWidth( ) : Number

Gets the value of the borderWidth property. ...

Gets the value of the borderWidth property.

Returns

Number

Titanium.UI.Window

getBottom( ) : Number/String

Gets the value of the bottom property. ...

Gets the value of the bottom property.

Returns

Number/String

Overrides: Titanium.UI.View.getBottom

Titanium.Proxy

getBubbleParent( ) : Boolean

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

Titanium.UI.View

getCenter( ) : Point

Gets the value of the center property. ...

Gets the value of the center property.

Returns

Point

Titanium.UI.View

getChildren( ) : Titanium.UI.View[]

Gets the value of the children property. ...

Gets the value of the children property.

Returns

Titanium.UI.View[]

Titanium.UI.View

getClipMode( ) : Number

Gets the value of the clipMode property. ...

Gets the value of the clipMode property.

3.3.0
3.3.0

Returns

Number

Titanium.UI.View

getElevation( ) : Number

Gets the value of the elevation property. ...

Gets the value of the elevation property.

5.0.0

Returns

Number

Titanium.UI.Window

getExitOnClose( ) : Boolean

Gets the value of the exitOnClose property. ...

Gets the value of the exitOnClose property.

Returns

Boolean

Titanium.UI.Window

getExtendEdges( ) : Number[]

Gets the value of the extendEdges property. ...

Gets the value of the extendEdges property.

3.1.3
3.1.3

Returns

Number[]

Titanium.UI.Window

getExtendSafeArea( ) : Boolean

Gets the value of the extendSafeArea property. ...

Gets the value of the extendSafeArea property.

6.3.0
6.3.0

Returns

Boolean

Titanium.UI.Window

getFlagSecure( ) : Boolean

Gets the value of the flagSecure property. ...

Gets the value of the flagSecure property.

3.3.0

Returns

Boolean

Titanium.UI.View

getFocusable( ) : Boolean

Gets the value of the focusable property. ...

Gets the value of the focusable property.

Returns

Boolean

Titanium.UI.Window

getFullscreen( ) : Boolean

Gets the value of the fullscreen property. ...

Gets the value of the fullscreen property.

Returns

Boolean

Titanium.UI.View

getHeight( ) : Number/String

Gets the value of the height property. ...

Gets the value of the height property.

Returns

Number/String

Titanium.UI.View

getHiddenBehavior( ) : Number

Gets the value of the hiddenBehavior property. ...

Gets the value of the hiddenBehavior property.

6.1.0

Returns

Number

Titanium.UI.Window

getHideShadow( ) : Boolean

Gets the value of the hideShadow property. ...

Gets the value of the hideShadow property.

3.2.0
3.2.0

Returns

Boolean

Titanium.UI.Window

getHidesBarsOnSwipe( ) : Boolean

Gets the value of the hidesBarsOnSwipe property. ...

Gets the value of the hidesBarsOnSwipe property.

6.0.0
6.0.0

Returns

Boolean

Titanium.UI.Window

getHidesBarsOnTap( ) : Boolean

Gets the value of the hidesBarsOnTap property. ...

Gets the value of the hidesBarsOnTap property.

6.0.0
6.0.0

Returns

Boolean

Titanium.UI.Window

getHidesBarsWhenKeyboardAppears( ) : Boolean

Gets the value of the hidesBarsWhenKeyboardAppears property. ...

Gets the value of the hidesBarsWhenKeyboardAppears property.

6.0.0
6.0.0

Returns

Boolean

Titanium.UI.View

getHorizontalWrap( ) : Boolean

Gets the value of the horizontalWrap property. ...

Gets the value of the horizontalWrap property.

2.1.0
2.1.0
2.1.0

Returns

Boolean

Titanium.UI.Window

getIncludeOpaqueBars( ) : Boolean

Gets the value of the includeOpaqueBars property. ...

Gets the value of the includeOpaqueBars property.

3.1.3
3.1.3

Returns

Boolean

Titanium.UI.View

getKeepScreenOn( ) : Boolean

Gets the value of the keepScreenOn property. ...

Gets the value of the keepScreenOn property.

Returns

Boolean

Titanium.UI.Window

getLargeTitleDisplayMode( ) : Number

Gets the value of the largeTitleDisplayMode property. ...

Gets the value of the largeTitleDisplayMode property.

6.3.0
6.3.0

Returns

Number

Titanium.UI.Window

getLargeTitleEnabled( ) : String

Gets the value of the largeTitleEnabled property. ...

Gets the value of the largeTitleEnabled property.

6.3.0
6.3.0

Returns

String

Titanium.UI.View

getLayout( ) : String

Gets the value of the layout property. ...

Gets the value of the layout property.

Returns

String

Titanium.UI.Window

getLeft( ) : Number/String

Gets the value of the left property. ...

Gets the value of the left property.

Returns

Number/String

Overrides: Titanium.UI.View.getLeft

Titanium.UI.Window

getLeftNavButton( ) : Titanium.UI.View

Gets the value of the leftNavButton property. ...

Gets the value of the leftNavButton property.

Returns

Titanium.UI.View

Titanium.UI.Window

getLeftNavButtons( ) : Titanium.UI.View[]

Gets the value of the leftNavButtons property. ...

Gets the value of the leftNavButtons property.

3.3.0
3.3.0

Returns

Titanium.UI.View[]

Titanium.Proxy

getLifecycleContainer( ) : Titanium.UI.Window/Titanium.UI.TabGroup

Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

3.6.0

Returns

Titanium.UI.Window/Titanium.UI.TabGroup

Titanium.UI.Window

getModal( ) : Boolean

Gets the value of the modal property. ...

Gets the value of the modal property.

Returns

Boolean

Titanium.UI.Window

getNavBarHidden( ) : Boolean

Gets the value of the navBarHidden property. ...

Gets the value of the navBarHidden property.

Returns

Boolean

Titanium.UI.Window

getNavTintColor( ) : String

Gets the value of the navTintColor property. ...

Gets the value of the navTintColor property.

3.1.3
3.1.3

Returns

String

Titanium.UI.Window

getOnBack( ) : Callback<Object>

Gets the value of the onBack property. ...

Gets the value of the onBack property.

Returns

Callback<Object>

Titanium.UI.Window

getOpacity( ) : Number

Gets the value of the opacity property. ...

Gets the value of the opacity property.

Returns

Number

Overrides: Titanium.UI.View.getOpacity

Titanium.UI.Window

getOrientation( ) : Number

Gets the value of the orientation property. ...

Gets the value of the orientation property.

0.9
3.0.0
3.0.0

Returns

Number

Titanium.UI.Window

getOrientationModes( ) : Number[]

Gets the value of the orientationModes property. ...

Gets the value of the orientationModes property.

Returns

Number[]

Titanium.UI.View

getOverrideCurrentAnimation( ) : Boolean

Gets the value of the overrideCurrentAnimation property. ...

Gets the value of the overrideCurrentAnimation property.

3.3.0

Returns

Boolean

Titanium.UI.View

getPreviewContext( ) : Titanium.UI.iOS.PreviewContext

Gets the value of the previewContext property. ...

Gets the value of the previewContext property.

5.1.0

Returns

Titanium.UI.iOS.PreviewContext

Titanium.UI.View

getPullBackgroundColor( ) : String

Gets the value of the pullBackgroundColor property. ...

Gets the value of the pullBackgroundColor property.

3.3.0
3.3.0

Returns

String

Titanium.UI.View

getRect( ) : Dimension

Gets the value of the rect property. ...

Gets the value of the rect property.

2.0.0
2.0.0
2.0.0

Returns

Dimension

Titanium.UI.Window

getRight( ) : Number/String

Gets the value of the right property. ...

Gets the value of the right property.

Returns

Number/String

Overrides: Titanium.UI.View.getRight

Titanium.UI.Window

getRightNavButton( ) : Titanium.UI.View

Gets the value of the rightNavButton property. ...

Gets the value of the rightNavButton property.

Returns

Titanium.UI.View

Titanium.UI.Window

getRightNavButtons( ) : Titanium.UI.View[]

Gets the value of the rightNavButtons property. ...

Gets the value of the rightNavButtons property.

3.3.0
3.3.0

Returns

Titanium.UI.View[]

Titanium.UI.View

getRotation( ) : Number

Gets the value of the rotation property. ...

Gets the value of the rotation property.

5.4.0

Returns

Number

Titanium.UI.View

getRotationX( ) : Number

Gets the value of the rotationX property. ...

Gets the value of the rotationX property.

5.4.0

Returns

Number

Titanium.UI.View

getRotationY( ) : Number

Gets the value of the rotationY property. ...

Gets the value of the rotationY property.

5.4.0

Returns

Number

Titanium.UI.View

getScaleX( ) : Number

Gets the value of the scaleX property. ...

Gets the value of the scaleX property.

5.4.0

Returns

Number

Titanium.UI.View

getScaleY( ) : Number

Gets the value of the scaleY property. ...

Gets the value of the scaleY property.

5.4.0

Returns

Number

Titanium.UI.Window

getShadowImage( ) : String

Gets the value of the shadowImage property. ...

Gets the value of the shadowImage property.

3.2.0
3.2.0

Returns

String

Titanium.UI.View

getSize( ) : Dimension

Gets the value of the size property. ...

Gets the value of the size property.

Returns

Dimension

Titanium.UI.View

getSoftKeyboardOnFocus( ) : Number

Gets the value of the softKeyboardOnFocus property. ...

Gets the value of the softKeyboardOnFocus property.

Returns

Number

Titanium.UI.Window

getSplitActionBar( ) : Booleandeprecated

Gets the value of the splitActionBar property. ...

Gets the value of the splitActionBar property.

deprecated since 6.2.0

Deprecated in AppCompat theme. The same behaviour can be achived by using Toolbar.

3.6.0

Returns

Boolean

Titanium.UI.Window

getStatusBarStyle( ) : Number

Gets the value of the statusBarStyle property. ...

Gets the value of the statusBarStyle property.

3.1.3
3.1.3

Returns

Number

Titanium.UI.Window

getSustainedPerformanceMode( ) : Boolean

Gets the value of the sustainedPerformanceMode property. ...

Gets the value of the sustainedPerformanceMode property.

7.0.0

Returns

Boolean

Titanium.UI.Window

getSwipeToClose( ) : Boolean

Gets the value of the swipeToClose property. ...

Gets the value of the swipeToClose property.

5.2.0
5.2.0

Returns

Boolean

Titanium.UI.Window

getTabBarHidden( ) : Boolean

Gets the value of the tabBarHidden property. ...

Gets the value of the tabBarHidden property.

Returns

Boolean

Titanium.UI.Window

getTheme( ) : String

Gets the value of the theme property. ...

Gets the value of the theme property.

3.4.0

Returns

String

Titanium.UI.View

getTintColor( ) : String

Gets the value of the tintColor property. ...

Gets the value of the tintColor property.

3.1.3
3.1.3

Returns

String

Titanium.UI.Window

getTitle( ) : String

Gets the value of the title property. ...

Gets the value of the title property.

Returns

String

Titanium.UI.Window

getTitleAttributes( ) : titleAttributesParams

Gets the value of the titleAttributes property. ...

Gets the value of the titleAttributes property.

3.2.0
3.2.0

Returns

titleAttributesParams

Titanium.UI.Window

getTitleControl( ) : Titanium.UI.View

Gets the value of the titleControl property. ...

Gets the value of the titleControl property.

Returns

Titanium.UI.View

Titanium.UI.Window

getTitleImage( ) : String

Gets the value of the titleImage property. ...

Gets the value of the titleImage property.

Returns

String

Titanium.UI.Window

getTitlePrompt( ) : String

Gets the value of the titlePrompt property. ...

Gets the value of the titlePrompt property.

Returns

String

Titanium.UI.Window

getTitleid( ) : String

Gets the value of the titleid property. ...

Gets the value of the titleid property.

Returns

String

Titanium.UI.Window

getTitlepromptid( ) : String

Gets the value of the titlepromptid property. ...

Gets the value of the titlepromptid property.

Returns

String

Titanium.UI.Window

getToolbar( ) : Object[]

Gets the value of the toolbar property. ...

Gets the value of the toolbar property.

Returns

Object[]

Titanium.UI.Window

getTop( ) : Number/String

Gets the value of the top property. ...

Gets the value of the top property.

Returns

Number/String

Overrides: Titanium.UI.View.getTop

Titanium.UI.View

getTouchEnabled( ) : Boolean

Gets the value of the touchEnabled property. ...

Gets the value of the touchEnabled property.

Returns

Boolean

Titanium.UI.View

getTouchFeedback( ) : Boolean

Gets the value of the touchFeedback property. ...

Gets the value of the touchFeedback property.

6.1.0

Returns

Boolean

Titanium.UI.View

getTouchFeedbackColor( ) : String

Gets the value of the touchFeedbackColor property. ...

Gets the value of the touchFeedbackColor property.

6.1.0

Returns

String

Titanium.UI.View

getTransform( ) : Titanium.UI.2DMatrix/Titanium.UI.3DMatrix

Gets the value of the transform property. ...

Gets the value of the transform property.

Returns

Titanium.UI.2DMatrix/Titanium.UI.3DMatrix

Titanium.UI.Window

getTransitionAnimation( ) : Titanium.Proxy

Gets the value of the transitionAnimation property. ...

Gets the value of the transitionAnimation property.

3.2.0
3.2.0

Returns

Titanium.Proxy

Titanium.UI.View

getTransitionName( ) : String

Gets the value of the transitionName property. ...

Gets the value of the transitionName property.

5.0.2

Returns

String

Titanium.UI.View

getTranslationX( ) : Number

Gets the value of the translationX property. ...

Gets the value of the translationX property.

5.0.0

Returns

Number

Titanium.UI.View

getTranslationY( ) : Number

Gets the value of the translationY property. ...

Gets the value of the translationY property.

5.0.0

Returns

Number

Titanium.UI.View

getTranslationZ( ) : Number

Gets the value of the translationZ property. ...

Gets the value of the translationZ property.

5.0.0

Returns

Number

Titanium.UI.Window

getTranslucent( ) : Boolean

Gets the value of the translucent property. ...

Gets the value of the translucent property.

Returns

Boolean

Titanium.UI.Window

getUrl( ) : Stringremoved

Gets the value of the url property. ...

Gets the value of the url property.

This method has been removed since 6.0.0

Returns

String

Titanium.UI.View

getViewById( id ) : Titanium.UI.View

Returns the matching view of a given view ID. ...

Returns the matching view of a given view ID.

6.1.0
6.1.0
6.1.0

Parameters

id : String
The ID of the view that should be returned. Use the id property in your views to enable it for indexing in this method.

Returns

Titanium.UI.View

Titanium.UI.View

getViewShadowColor( ) : String

Gets the value of the viewShadowColor property. ...

Gets the value of the viewShadowColor property.

3.3.0
3.3.0

Returns

String

Titanium.UI.View

getViewShadowOffset( ) : Point

Gets the value of the viewShadowOffset property. ...

Gets the value of the viewShadowOffset property.

3.3.0
3.3.0

Returns

Point

Titanium.UI.View

getViewShadowRadius( ) : Number

Gets the value of the viewShadowRadius property. ...

Gets the value of the viewShadowRadius property.

3.3.0
3.3.0

Returns

Number

Titanium.UI.View

getVisible( ) : Boolean

Gets the value of the visible property. ...

Gets the value of the visible property.

Returns

Boolean

Titanium.UI.View

getWidth( ) : Number/String

Gets the value of the width property. ...

Gets the value of the width property.

Returns

Number/String

Titanium.UI.Window

getWindowFlags( ) : Number

Gets the value of the windowFlags property. ...

Gets the value of the windowFlags property.

3.3.0

Returns

Number

Titanium.UI.Window

getWindowPixelFormat( ) : Number

Gets the value of the windowPixelFormat property. ...

Gets the value of the windowPixelFormat property.

1.8.0

Returns

Number

Titanium.UI.Window

getWindowSoftInputMode( ) : Number

Gets the value of the windowSoftInputMode property. ...

Gets the value of the windowSoftInputMode property.

Returns

Number

Titanium.UI.View

getZIndex( ) : Number

Gets the value of the zIndex property. ...

Gets the value of the zIndex property.

Returns

Number

Titanium.UI.View

hide( [options] )

Hides this view. ...

Hides this view.

Parameters

options : AnimationOption (optional)
Animation options for Android. Since Release 5.1.0.

Returns

void

Titanium.UI.Window

hideNavBar( [options] )

Hides the navigation bar. ...

Hides the navigation bar.

If the window is not displayed in a Titanium.UI.iOS.NavigationWindow, this method has no effect.

Parameters

options : Dictionary (optional)
Options dictionary supporting a single animated boolean property to determine whether the navigation bar will be animated (default) while being hidden.

Returns

void

Titanium.UI.Window

hideTabBar( )

Hides the tab bar. ...

Hides the tab bar. Must be called before opening the window.

To hide the tab bar when opening a window as a child of a tab, call hideTabBar or set tabBarHidden to true before opening the window.

If the window is not a child of a tab, this method has no effect.

Returns

void

Titanium.UI.Window

hideToolbar( [options] )

Makes the bottom toolbar invisible. ...

Makes the bottom toolbar invisible.

If the window is not displayed in a Titanium.UI.iOS.NavigationWindow, this method has no effect. Note: This method is only intended to work with toolbars that are created using setToolbar. It will not have any effect on toolbars added manually to the window.

5.4.0
5.4.0

Parameters

options : Dictionary (optional)
Options dictionary supporting a single animated boolean property to determine whether the toolbar will be animated (default) while being hidden.

Returns

void

Titanium.UI.View

insertAt( params )

Inserts a view at the specified position in the children array. ...

Inserts a view at the specified position in the children array.

Useful if the layout property is set to horizontal or vertical.

3.3.0
3.3.0
3.3.0

Parameters

params : Dictionary
Pass an object with the following key-value pairs:
- view (Titanium.UI.View): View to insert
- position (Number): Position in the children array to insert the view. If omitted, inserts the view to the end of the array.

Returns

void

Titanium.UI.Window

open( [params] )

Opens the window. ...

Opens the window.

Parameters

params : openWindowParams (optional)
Animation or display properties to use when opening the window.

Returns

void

Titanium.UI.View

remove( view )

Removes a child view from this view's hierarchy. ...

Removes a child view from this view's hierarchy.

Parameters

view : Titanium.UI.View
View to remove from this view's hierarchy.

Returns

void

Titanium.UI.Window

removeAllSharedElements( )

Clears all added shared elements. ...

Clears all added shared elements.

Requires: Android 5 and later

Available from Android 5.0. Use this method to clear all shared elements. This will not remove the views from view hierarchy.

5.2.0

Returns

void

Titanium.Proxy

removeEventListener( name, callback )

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

Titanium.UI.View

replaceAt( params )

Replaces a view at the specified position in the children array. ...

Replaces a view at the specified position in the children array.

Useful if the layout property is set to horizontal or vertical.

3.3.0
3.3.0
3.3.0

Parameters

params : Dictionary
Pass an object with the following key-value pairs:
- view (Titanium.UI.View): View to insert
- position (Number): Position in the children array of the view elment to replace.

Returns

void

Titanium.UI.View

setAccessibilityHidden( accessibilityHidden )

Sets the value of the accessibilityHidden property. ...

Sets the value of the accessibilityHidden property.

3.0.0
3.0.0
3.0.0

Parameters

accessibilityHidden : Boolean
New value for the property.

Returns

void

Titanium.UI.View

setAccessibilityHint( accessibilityHint )

Sets the value of the accessibilityHint property. ...

Sets the value of the accessibilityHint property.

3.0.0
3.0.0
3.0.0

Parameters

accessibilityHint : String
New value for the property.

Returns

void

Titanium.UI.View

setAccessibilityLabel( accessibilityLabel )

Sets the value of the accessibilityLabel property. ...

Sets the value of the accessibilityLabel property.

3.0.0
3.0.0
3.0.0

Parameters

accessibilityLabel : String
New value for the property.

Returns

void

Titanium.UI.View

setAccessibilityValue( accessibilityValue )

Sets the value of the accessibilityValue property. ...

Sets the value of the accessibilityValue property.

3.0.0
3.0.0
3.0.0

Parameters

accessibilityValue : String
New value for the property.

Returns

void

Titanium.UI.Window

setActivityEnterTransition( activityEnterTransition )

Sets the value of the activityEnterTransition property. ...

Sets the value of the activityEnterTransition property.

5.2.0

Parameters

activityEnterTransition : Number
New value for the property.

Returns

void

Titanium.UI.Window

setActivityExitTransition( activityExitTransition )

Sets the value of the activityExitTransition property. ...

Sets the value of the activityExitTransition property.

5.2.0

Parameters

activityExitTransition : Number
New value for the property.

Returns

void

Titanium.UI.Window

setActivityReenterTransition( activityReenterTransition )

Sets the value of the activityReenterTransition property. ...

Sets the value of the activityReenterTransition property.

5.2.0

Parameters

activityReenterTransition : Number
New value for the property.

Returns

void

Titanium.UI.Window

setActivityReturnTransition( activityReturnTransition )

Sets the value of the activityReturnTransition property. ...

Sets the value of the activityReturnTransition property.

5.2.0

Parameters

activityReturnTransition : Number
New value for the property.

Returns

void

Titanium.UI.Window

setActivitySharedElementEnterTransition( activitySharedElementEnterTransition )

Sets the value of the activitySharedElementEnterTransition property. ...

Sets the value of the activitySharedElementEnterTransition property.

5.2.0

Parameters

activitySharedElementEnterTransition : Number
New value for the property.

Returns

void

Titanium.UI.Window

setActivitySharedElementExitTransition( activitySharedElementExitTransition )

Sets the value of the activitySharedElementExitTransition property. ...

Sets the value of the activitySharedElementExitTransition property.

5.2.0

Parameters

activitySharedElementExitTransition : Number
New value for the property.

Returns

void

Titanium.UI.Window

setActivitySharedElementReenterTransition( activitySharedElementReenterTransition )

Sets the value of the activitySharedElementReenterTransition property. ...

Sets the value of the activitySharedElementReenterTransition property.

5.2.0

Parameters

activitySharedElementReenterTransition : Number
New value for the property.

Returns

void

Titanium.UI.Window

setActivitySharedElementReturnTransition( activitySharedElementReturnTransition )

Sets the value of the activitySharedElementReturnTransition property. ...

Sets the value of the activitySharedElementReturnTransition property.

5.2.0

Parameters

activitySharedElementReturnTransition : Number
New value for the property.

Returns

void

Titanium.UI.View

setAnchorPoint( anchorPoint )

Sets the value of the anchorPoint property. ...

Sets the value of the anchorPoint property.

Parameters

anchorPoint : Point
New value for the property.

Returns

void

Titanium.UI.Window

setAutoAdjustScrollViewInsets( autoAdjustScrollViewInsets )

Sets the value of the autoAdjustScrollViewInsets property. ...

Sets the value of the autoAdjustScrollViewInsets property.

3.1.3
3.1.3

Parameters

autoAdjustScrollViewInsets : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setBackButtonTitle( backButtonTitle )

Sets the value of the backButtonTitle property. ...

Sets the value of the backButtonTitle property.

Parameters

backButtonTitle : String
New value for the property.

Returns

void

Titanium.UI.Window

setBackButtonTitleImage( backButtonTitleImage )

Sets the value of the backButtonTitleImage property. ...

Sets the value of the backButtonTitleImage property.

Parameters

backButtonTitleImage : String/Titanium.Blob
New value for the property.

Returns

void

Titanium.UI.Window

setBackgroundColor( backgroundColor )

Sets the value of the backgroundColor property. ...

Sets the value of the backgroundColor property.

Parameters

backgroundColor : String
New value for the property.

Returns

void

Overrides: Titanium.UI.View.setBackgroundColor

Titanium.UI.View

setBackgroundDisabledColor( backgroundDisabledColor )

Sets the value of the backgroundDisabledColor property. ...

Sets the value of the backgroundDisabledColor property.

Parameters

backgroundDisabledColor : String
New value for the property.

Returns

void

Titanium.UI.View

setBackgroundDisabledImage( backgroundDisabledImage )

Sets the value of the backgroundDisabledImage property. ...

Sets the value of the backgroundDisabledImage property.

Parameters

backgroundDisabledImage : String
New value for the property.

Returns

void

Titanium.UI.View

setBackgroundFocusedColor( backgroundFocusedColor )

Sets the value of the backgroundFocusedColor property. ...

Sets the value of the backgroundFocusedColor property.

Parameters

backgroundFocusedColor : String
New value for the property.

Returns

void

Titanium.UI.View

setBackgroundFocusedImage( backgroundFocusedImage )

Sets the value of the backgroundFocusedImage property. ...

Sets the value of the backgroundFocusedImage property.

Parameters

backgroundFocusedImage : String
New value for the property.

Returns

void

Titanium.UI.View

setBackgroundGradient( backgroundGradient )

Sets the value of the backgroundGradient property. ...

Sets the value of the backgroundGradient property.

Parameters

backgroundGradient : Gradient
New value for the property.

Returns

void

Titanium.UI.View

setBackgroundImage( backgroundImage )

Sets the value of the backgroundImage property. ...

Sets the value of the backgroundImage property.

Parameters

backgroundImage : String
New value for the property.

Returns

void

Titanium.UI.View

setBackgroundLeftCap( backgroundLeftCap )

Sets the value of the backgroundLeftCap property. ...

Sets the value of the backgroundLeftCap property.

Parameters

backgroundLeftCap : Number
New value for the property.

Returns

void

Titanium.UI.View

setBackgroundRepeat( backgroundRepeat )

Sets the value of the backgroundRepeat property. ...

Sets the value of the backgroundRepeat property.

Parameters

backgroundRepeat : Boolean
New value for the property.

Returns

void

Titanium.UI.View

setBackgroundSelectedColor( backgroundSelectedColor )

Sets the value of the backgroundSelectedColor property. ...

Sets the value of the backgroundSelectedColor property.

Parameters

backgroundSelectedColor : String
New value for the property.

Returns

void

Titanium.UI.View

setBackgroundSelectedImage( backgroundSelectedImage )

Sets the value of the backgroundSelectedImage property. ...

Sets the value of the backgroundSelectedImage property.

Parameters

backgroundSelectedImage : String
New value for the property.

Returns

void

Titanium.UI.View

setBackgroundTopCap( backgroundTopCap )

Sets the value of the backgroundTopCap property. ...

Sets the value of the backgroundTopCap property.

Parameters

backgroundTopCap : Number
New value for the property.

Returns

void

Titanium.UI.Window

setBarColor( barColor )

Sets the value of the barColor property. ...

Sets the value of the barColor property.

Parameters

barColor : String
New value for the property.

Returns

void

Titanium.UI.Window

setBarImage( barImage )

Sets the value of the barImage property. ...

Sets the value of the barImage property.

Parameters

barImage : String
New value for the property.

Returns

void

Titanium.UI.View

setBorderColor( borderColor )

Sets the value of the borderColor property. ...

Sets the value of the borderColor property.

Parameters

borderColor : String
New value for the property.

Returns

void

Titanium.UI.View

setBorderRadius( borderRadius )

Sets the value of the borderRadius property. ...

Sets the value of the borderRadius property.

Parameters

borderRadius : Number
New value for the property.

Returns

void

Titanium.UI.View

setBorderWidth( borderWidth )

Sets the value of the borderWidth property. ...

Sets the value of the borderWidth property.

Parameters

borderWidth : Number
New value for the property.

Returns

void

Titanium.UI.Window

setBottom( bottom )

Sets the value of the bottom property. ...

Sets the value of the bottom property.

Parameters

bottom : Number/String
New value for the property.

Returns

void

Overrides: Titanium.UI.View.setBottom

Titanium.Proxy

setBubbleParent( bubbleParent )

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

Titanium.UI.View

setCenter( center )

Sets the value of the center property. ...

Sets the value of the center property.

Parameters

center : Point
New value for the property.

Returns

void

Titanium.UI.View

setClipMode( clipMode )

Sets the value of the clipMode property. ...

Sets the value of the clipMode property.

3.3.0
3.3.0

Parameters

clipMode : Number
New value for the property.

Returns

void

Titanium.UI.View

setElevation( elevation )

Sets the value of the elevation property. ...

Sets the value of the elevation property.

5.0.0

Parameters

elevation : Number
New value for the property.

Returns

void

Titanium.UI.Window

setExitOnClose( exitOnClose )

Sets the value of the exitOnClose property. ...

Sets the value of the exitOnClose property.

Parameters

exitOnClose : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setExtendEdges( extendEdges )

Sets the value of the extendEdges property. ...

Sets the value of the extendEdges property.

3.1.3
3.1.3

Parameters

extendEdges : Array<Number>
New value for the property.

Returns

void

Titanium.UI.Window

setExtendSafeArea( extendSafeArea )

Sets the value of the extendSafeArea property. ...

Sets the value of the extendSafeArea property.

6.3.0
6.3.0

Parameters

extendSafeArea : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setFlagSecure( flagSecure )

Sets the value of the flagSecure property. ...

Sets the value of the flagSecure property.

3.3.0

Parameters

flagSecure : Boolean
New value for the property.

Returns

void

Titanium.UI.View

setFocusable( focusable )

Sets the value of the focusable property. ...

Sets the value of the focusable property.

Parameters

focusable : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setFullscreen( fullscreen )

Sets the value of the fullscreen property. ...

Sets the value of the fullscreen property.

Parameters

fullscreen : Boolean
New value for the property.

Returns

void

Titanium.UI.View

setHeight( height )

Sets the value of the height property. ...

Sets the value of the height property.

Parameters

height : Number/String
New value for the property.

Returns

void

Titanium.UI.View

setHiddenBehavior( hiddenBehavior )

Sets the value of the hiddenBehavior property. ...

Sets the value of the hiddenBehavior property.

6.1.0

Parameters

hiddenBehavior : Number
New value for the property.

Returns

void

Titanium.UI.Window

setHideShadow( hideShadow )

Sets the value of the hideShadow property. ...

Sets the value of the hideShadow property.

3.2.0
3.2.0

Parameters

hideShadow : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setHidesBarsOnSwipe( hidesBarsOnSwipe )

Sets the value of the hidesBarsOnSwipe property. ...

Sets the value of the hidesBarsOnSwipe property.

6.0.0
6.0.0

Parameters

hidesBarsOnSwipe : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setHidesBarsOnTap( hidesBarsOnTap )

Sets the value of the hidesBarsOnTap property. ...

Sets the value of the hidesBarsOnTap property.

6.0.0
6.0.0

Parameters

hidesBarsOnTap : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setHidesBarsWhenKeyboardAppears( hidesBarsWhenKeyboardAppears )

Sets the value of the hidesBarsWhenKeyboardAppears property. ...

Sets the value of the hidesBarsWhenKeyboardAppears property.

6.0.0
6.0.0

Parameters

hidesBarsWhenKeyboardAppears : Boolean
New value for the property.

Returns

void

Titanium.UI.View

setHorizontalWrap( horizontalWrap )

Sets the value of the horizontalWrap property. ...

Sets the value of the horizontalWrap property.

2.1.0
2.1.0
2.1.0

Parameters

horizontalWrap : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setIncludeOpaqueBars( includeOpaqueBars )

Sets the value of the includeOpaqueBars property. ...

Sets the value of the includeOpaqueBars property.

3.1.3
3.1.3

Parameters

includeOpaqueBars : Boolean
New value for the property.

Returns

void

Titanium.UI.View

setKeepScreenOn( keepScreenOn )

Sets the value of the keepScreenOn property. ...

Sets the value of the keepScreenOn property.

Parameters

keepScreenOn : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setLargeTitleDisplayMode( largeTitleDisplayMode )

Sets the value of the largeTitleDisplayMode property. ...

Sets the value of the largeTitleDisplayMode property.

6.3.0
6.3.0

Parameters

largeTitleDisplayMode : Number
New value for the property.

Returns

void

Titanium.UI.Window

setLargeTitleEnabled( largeTitleEnabled )

Sets the value of the largeTitleEnabled property. ...

Sets the value of the largeTitleEnabled property.

6.3.0
6.3.0

Parameters

largeTitleEnabled : String
New value for the property.

Returns

void

Titanium.UI.View

setLayout( layout )

Sets the value of the layout property. ...

Sets the value of the layout property.

Parameters

layout : String
New value for the property.

Returns

void

Titanium.UI.Window

setLeft( left )

Sets the value of the left property. ...

Sets the value of the left property.

Parameters

left : Number/String
New value for the property.

Returns

void

Overrides: Titanium.UI.View.setLeft

Titanium.UI.Window

setLeftNavButton( leftNavButton )

Sets the value of the leftNavButton property. ...

Sets the value of the leftNavButton property.

Parameters

leftNavButton : Titanium.UI.View
New value for the property.

Returns

void

Titanium.UI.Window

setLeftNavButtons( leftNavButtons )

Sets the value of the leftNavButtons property. ...

Sets the value of the leftNavButtons property.

3.3.0
3.3.0

Parameters

leftNavButtons : Array<Titanium.UI.View>
New value for the property.

Returns

void

Titanium.Proxy

setLifecycleContainer( lifecycleContainer )

Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

3.6.0

Parameters

lifecycleContainer : Titanium.UI.Window/Titanium.UI.TabGroup
New value for the property.

Returns

void

Titanium.UI.Window

setModal( modal )

Sets the value of the modal property. ...

Sets the value of the modal property.

Parameters

modal : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setNavBarHidden( navBarHidden )

Sets the value of the navBarHidden property. ...

Sets the value of the navBarHidden property.

Parameters

navBarHidden : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setNavTintColor( navTintColor )

Sets the value of the navTintColor property. ...

Sets the value of the navTintColor property.

3.1.3
3.1.3

Parameters

navTintColor : String
New value for the property.

Returns

void

Titanium.UI.Window

setOnBack( onBack )

Sets the value of the onBack property. ...

Sets the value of the onBack property.

Parameters

onBack : Callback<Object>
New value for the property.

Returns

void

Titanium.UI.Window

setOpacity( opacity )

Sets the value of the opacity property. ...

Sets the value of the opacity property.

Parameters

opacity : Number
New value for the property.

Returns

void

Overrides: Titanium.UI.View.setOpacity

Titanium.UI.Window

setOrientationModes( orientationModes )

Sets the value of the orientationModes property. ...

Sets the value of the orientationModes property.

Parameters

orientationModes : Array<Number>
New value for the property.

Returns

void

Titanium.UI.View

setOverrideCurrentAnimation( overrideCurrentAnimation )

Sets the value of the overrideCurrentAnimation property. ...

Sets the value of the overrideCurrentAnimation property.

3.3.0

Parameters

overrideCurrentAnimation : Boolean
New value for the property.

Returns

void

Titanium.UI.View

setPreviewContext( previewContext )

Sets the value of the previewContext property. ...

Sets the value of the previewContext property.

5.1.0

Parameters

previewContext : Titanium.UI.iOS.PreviewContext
New value for the property.

Returns

void

Titanium.UI.View

setPullBackgroundColor( pullBackgroundColor )

Sets the value of the pullBackgroundColor property. ...

Sets the value of the pullBackgroundColor property.

3.3.0
3.3.0

Parameters

pullBackgroundColor : String
New value for the property.

Returns

void

Titanium.UI.Window

setRight( right )

Sets the value of the right property. ...

Sets the value of the right property.

Parameters

right : Number/String
New value for the property.

Returns

void

Overrides: Titanium.UI.View.setRight

Titanium.UI.Window

setRightNavButton( rightNavButton )

Sets the value of the rightNavButton property. ...

Sets the value of the rightNavButton property.

Parameters

rightNavButton : Titanium.UI.View
New value for the property.

Returns

void

Titanium.UI.Window

setRightNavButtons( rightNavButtons )

Sets the value of the rightNavButtons property. ...

Sets the value of the rightNavButtons property.

3.3.0
3.3.0

Parameters

rightNavButtons : Array<Titanium.UI.View>
New value for the property.

Returns

void

Titanium.UI.View

setRotation( rotation )

Sets the value of the rotation property. ...

Sets the value of the rotation property.

5.4.0

Parameters

rotation : Number
New value for the property.

Returns

void

Titanium.UI.View

setRotationX( rotationX )

Sets the value of the rotationX property. ...

Sets the value of the rotationX property.

5.4.0

Parameters

rotationX : Number
New value for the property.

Returns

void

Titanium.UI.View

setRotationY( rotationY )

Sets the value of the rotationY property. ...

Sets the value of the rotationY property.

5.4.0

Parameters

rotationY : Number
New value for the property.

Returns

void

Titanium.UI.View

setScaleX( scaleX )

Sets the value of the scaleX property. ...

Sets the value of the scaleX property.

5.4.0

Parameters

scaleX : Number
New value for the property.

Returns

void

Titanium.UI.View

setScaleY( scaleY )

Sets the value of the scaleY property. ...

Sets the value of the scaleY property.

5.4.0

Parameters

scaleY : Number
New value for the property.

Returns

void

Titanium.UI.Window

setShadowImage( shadowImage )

Sets the value of the shadowImage property. ...

Sets the value of the shadowImage property.

3.2.0
3.2.0

Parameters

shadowImage : String
New value for the property.

Returns

void

Titanium.UI.View

setSoftKeyboardOnFocus( softKeyboardOnFocus )

Sets the value of the softKeyboardOnFocus property. ...

Sets the value of the softKeyboardOnFocus property.

Parameters

softKeyboardOnFocus : Number
New value for the property.

Returns

void

Titanium.UI.Window

setSplitActionBar( splitActionBar )deprecated

Sets the value of the splitActionBar property. ...

Sets the value of the splitActionBar property.

deprecated since 6.2.0

Deprecated in AppCompat theme. The same behaviour can be achived by using Toolbar.

3.6.0

Parameters

splitActionBar : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setStatusBarStyle( statusBarStyle )

Sets the value of the statusBarStyle property. ...

Sets the value of the statusBarStyle property.

3.1.3
3.1.3

Parameters

statusBarStyle : Number
New value for the property.

Returns

void

Titanium.UI.Window

setSustainedPerformanceMode( sustainedPerformanceMode )

Sets the value of the sustainedPerformanceMode property. ...

Sets the value of the sustainedPerformanceMode property.

7.0.0

Parameters

sustainedPerformanceMode : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setSwipeToClose( swipeToClose )

Sets the value of the swipeToClose property. ...

Sets the value of the swipeToClose property.

5.2.0
5.2.0

Parameters

swipeToClose : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setTabBarHidden( tabBarHidden )

Sets the value of the tabBarHidden property. ...

Sets the value of the tabBarHidden property.

Parameters

tabBarHidden : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setTheme( theme )

Sets the value of the theme property. ...

Sets the value of the theme property.

3.4.0

Parameters

theme : String
New value for the property.

Returns

void

Titanium.UI.View

setTintColor( tintColor )

Sets the value of the tintColor property. ...

Sets the value of the tintColor property.

3.1.3
3.1.3

Parameters

tintColor : String
New value for the property.

Returns

void

Titanium.UI.Window

setTitle( title )

Sets the value of the title property. ...

Sets the value of the title property.

Parameters

title : String
New value for the property.

Returns

void

Titanium.UI.Window

setTitleAttributes( titleAttributes )

Sets the value of the titleAttributes property. ...

Sets the value of the titleAttributes property.

3.2.0
3.2.0

Parameters

titleAttributes : titleAttributesParams
New value for the property.

Returns

void

Titanium.UI.Window

setTitleControl( titleControl )

Sets the value of the titleControl property. ...

Sets the value of the titleControl property.

Parameters

titleControl : Titanium.UI.View
New value for the property.

Returns

void

Titanium.UI.Window

setTitleImage( titleImage )

Sets the value of the titleImage property. ...

Sets the value of the titleImage property.

Parameters

titleImage : String
New value for the property.

Returns

void

Titanium.UI.Window

setTitlePrompt( titlePrompt )

Sets the value of the titlePrompt property. ...

Sets the value of the titlePrompt property.

Parameters

titlePrompt : String
New value for the property.

Returns

void

Titanium.UI.Window

setTitleid( titleid )

Sets the value of the titleid property. ...

Sets the value of the titleid property.

Parameters

titleid : String
New value for the property.

Returns

void

Titanium.UI.Window

setTitlepromptid( titlepromptid )

Sets the value of the titlepromptid property. ...

Sets the value of the titlepromptid property.

Parameters

titlepromptid : String
New value for the property.

Returns

void

Titanium.UI.Window

setToolbar( toolbar )

Sets the value of the toolbar property. ...

Sets the value of the toolbar property.

Parameters

toolbar : Array<Object>
New value for the property.

Returns

void

Titanium.UI.Window

setTop( top )

Sets the value of the top property. ...

Sets the value of the top property.

Parameters

top : Number/String
New value for the property.

Returns

void

Overrides: Titanium.UI.View.setTop

Titanium.UI.View

setTouchEnabled( touchEnabled )

Sets the value of the touchEnabled property. ...

Sets the value of the touchEnabled property.

Parameters

touchEnabled : Boolean
New value for the property.

Returns

void

Titanium.UI.View

setTouchFeedback( touchFeedback )

Sets the value of the touchFeedback property. ...

Sets the value of the touchFeedback property.

6.1.0

Parameters

touchFeedback : Boolean
New value for the property.

Returns

void

Titanium.UI.View

setTouchFeedbackColor( touchFeedbackColor )

Sets the value of the touchFeedbackColor property. ...

Sets the value of the touchFeedbackColor property.

6.1.0

Parameters

touchFeedbackColor : String
New value for the property.

Returns

void

Titanium.UI.View

setTransform( transform )

Sets the value of the transform property. ...

Sets the value of the transform property.

Parameters

transform : Titanium.UI.2DMatrix/Titanium.UI.3DMatrix
New value for the property.

Returns

void

Titanium.UI.Window

setTransitionAnimation( transitionAnimation )

Sets the value of the transitionAnimation property. ...

Sets the value of the transitionAnimation property.

3.2.0
3.2.0

Parameters

transitionAnimation : Titanium.Proxy
New value for the property.

Returns

void

Titanium.UI.View

setTransitionName( transitionName )

Sets the value of the transitionName property. ...

Sets the value of the transitionName property.

5.0.2

Parameters

transitionName : String
New value for the property.

Returns

void

Titanium.UI.View

setTranslationX( translationX )

Sets the value of the translationX property. ...

Sets the value of the translationX property.

5.0.0

Parameters

translationX : Number
New value for the property.

Returns

void

Titanium.UI.View

setTranslationY( translationY )

Sets the value of the translationY property. ...

Sets the value of the translationY property.

5.0.0

Parameters

translationY : Number
New value for the property.

Returns

void

Titanium.UI.View

setTranslationZ( translationZ )

Sets the value of the translationZ property. ...

Sets the value of the translationZ property.

5.0.0

Parameters

translationZ : Number
New value for the property.

Returns

void

Titanium.UI.Window

setTranslucent( translucent )

Sets the value of the translucent property. ...

Sets the value of the translucent property.

Parameters

translucent : Boolean
New value for the property.

Returns

void

Titanium.UI.Window

setUrl( url )removed

Sets the value of the url property. ...

Sets the value of the url property.

This method has been removed since 6.0.0

Parameters

url : String
New value for the property.

Returns

void

Titanium.UI.View

setViewShadowColor( viewShadowColor )

Sets the value of the viewShadowColor property. ...

Sets the value of the viewShadowColor property.

3.3.0
3.3.0

Parameters

viewShadowColor : String
New value for the property.

Returns

void

Titanium.UI.View

setViewShadowOffset( viewShadowOffset )

Sets the value of the viewShadowOffset property. ...

Sets the value of the viewShadowOffset property.

3.3.0
3.3.0

Parameters

viewShadowOffset : Point
New value for the property.

Returns

void

Titanium.UI.View

setViewShadowRadius( viewShadowRadius )

Sets the value of the viewShadowRadius property. ...

Sets the value of the viewShadowRadius property.

3.3.0
3.3.0

Parameters

viewShadowRadius : Number
New value for the property.

Returns

void

Titanium.UI.View

setVisible( visible )

Sets the value of the visible property. ...

Sets the value of the visible property.

Parameters

visible : Boolean
New value for the property.

Returns

void

Titanium.UI.View

setWidth( width )

Sets the value of the width property. ...

Sets the value of the width property.

Parameters

width : Number/String
New value for the property.

Returns

void

Titanium.UI.Window

setWindowFlags( windowFlags )

Sets the value of the windowFlags property. ...

Sets the value of the windowFlags property.

3.3.0

Parameters

windowFlags : Number
New value for the property.

Returns

void

Titanium.UI.Window

setWindowPixelFormat( windowPixelFormat )

Sets the value of the windowPixelFormat property. ...

Sets the value of the windowPixelFormat property.

1.8.0

Parameters

windowPixelFormat : Number
New value for the property.

Returns

void

Titanium.UI.Window

setWindowSoftInputMode( windowSoftInputMode )

Sets the value of the windowSoftInputMode property. ...

Sets the value of the windowSoftInputMode property.

Parameters

windowSoftInputMode : Number
New value for the property.

Returns

void

Titanium.UI.View

setZIndex( zIndex )

Sets the value of the zIndex property. ...

Sets the value of the zIndex property.

Parameters

zIndex : Number
New value for the property.

Returns

void

Titanium.UI.View

show( [options] )

Makes this view visible. ...

Makes this view visible.

Parameters

options : AnimationOption (optional)
Animation options for Android. Since Release 5.1.0.

Returns

void

Titanium.UI.Window

showNavBar( [options] )

Makes the navigation bar visible. ...

Makes the navigation bar visible.

If the window is not displayed in a Titanium.UI.iOS.NavigationWindow, this method has no effect.

Parameters

options : Dictionary (optional)
Options dictionary supporting a single animated boolean property to determine whether the navigation bar will be animated (default) while being shown.

Returns

void

Titanium.UI.Window

showToolbar( [options] )

Makes the bottom toolbar visible. ...

Makes the bottom toolbar visible.

5.4.0
5.4.0

Parameters

options : Dictionary (optional)
Options dictionary supporting a single animated boolean property to determine whether the toolbar will be animated (default) while being shown.

Returns

void

Titanium.UI.View

startLayout( )deprecated

Starts a batch update of this view's layout properties. ...

Starts a batch update of this view's layout properties.

deprecated since 3.0.0

Use the <Titanium.Proxy.applyProperties> method to batch-update layout properties.

To prevent a layout pass each time a property is modified, call startLayout before changing any properties that may change this view's layout. This initiates a batch update mode where layout changes are deferred.

Call finishLayout to end batch update mode and trigger a layout pass. For example:

view.startLayout();
view.top = 50;
view.left = 50;
view.finishLayout();

Note that any property changes made during the batch update may be deferred until finishLayout is called. This may vary somewhat by platform. For example, changing the text of a label may trigger a layout pass. In iOS, updating the label text is deferred.

See also: updateLayout, finishLayout, postlayout event.

2.0.0
2.0.0
2.0.0

Returns

void

Titanium.UI.View

toImage( [callback], [honorScaleFactor] ) : Titanium.Blob

Returns an image of the rendered view, as a Blob. ...

Returns an image of the rendered view, as a Blob.

The honorScaleFactor method is only supported on iOS.

Parameters

callback : Callback<Titanium.Blob> (optional)
Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately.
honorScaleFactor : Boolean (optional)
Determines whether the image is scaled based on scale factor of main screen. (iOS only)

When set to true, image is scale factor is honored. When set to false, the image in the blob has the same dimensions for retina and non-retina devices.

Returns

Titanium.Blob

Titanium.UI.View

updateLayout( params )deprecated

Performs a batch update of all supplied layout properties and schedules a layout pass after they have been updated. ...

Performs a batch update of all supplied layout properties and schedules a layout pass after they have been updated.

deprecated since 3.0.0

Use the <Titanium.Proxy.applyProperties> method to batch-update layout properties.

This is another way to perform a batch update. The updateLayout method is called with a dictionary of layout properties to perform the batch update. For example:

view.updateLayout({top:50, left:50});

This is equivalent to the following:

view.startLayout();
view.top = 50;
view.left = 50;
view.finishLayout();

See also: startLayout, finishLayout, postlayout event.

2.0.0
2.0.0
2.0.0

Parameters

params : Dictionary
Layout properties to be updated.

Returns

void

Defined By

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.

Titanium.UI.Window

androidback

Fired when the back button is pressed by the user. ...

Fired when the back button is pressed by the user.

This event is fired when the current window's activity detects a back button press by the user to navigate back.

By default this event would trigger the current activity to be finished and removed from the task stack. Subscribing to this event with a listener will prevent the default behavior. To finish the activity from your listener just call the close method of the window.

This event replaces the android:back event. Some behavior changes may exist such as the event no longer firing when the user dismisses the keyboard with the back button or when the user closes a full-screen video which is embedded in a web view with the back button.

As of 5.0.0, you can create an event that can prevent accidental closure of the app due to hitting the back button to many times.

var win = Ti.UI.createWindow(
    { // some code... }
);
// more code
win.addEventListener("windows:back", function()
    { alert("Back pressed"); }
);

3.0.0

Properties

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.

Titanium.UI.Window

androidcamera

Fired when the Camera button is released. ...

Fired when the Camera button is released.

Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.

3.0.0

Properties

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.

Titanium.UI.Window

androidfocus

Fired when the Camera button is half-pressed then released. ...

Fired when the Camera button is half-pressed then released.

Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.

3.0.0

Properties

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.

Titanium.UI.Window

androidsearch

Fired when the Search button is released. ...

Fired when the Search button is released.

Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.

3.0.0

Properties

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.

Titanium.UI.Window

androidvoldown

Fired when the volume down button is released. ...

Fired when the volume down button is released.

Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.

3.0.0

Properties

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.

Titanium.UI.Window

androidvolup

Fired when the volume up button is released. ...

Fired when the volume up button is released.

Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.

3.0.0

Properties

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.

Titanium.UI.Window

blur

Fired when the window loses focus. ...

Fired when the window loses focus.

On Android, this event also fires before putting the activity in the background (before the activity enters the pause state).

On iOS, this event does not fire before putting the application in the background. The application needs to monitor the Titanium.App.pause event. See Titanium.App for more information on the iOS application lifecycle.

Properties

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.

Titanium.UI.View

click

Fired when the device detects a click against the view. ...

Fired when the device detects a click against the view.

There is a subtle difference between singletap and click events.

A singletap event is generated when the user taps the screen briefly without moving their finger. This gesture will also generate a click event.

However, a click event can also be generated when the user touches, moves their finger, and then removes it from the screen.

On Android, a click event can also be generated by a trackball click.

Properties

x : Number
X coordinate of the event from the source view's coordinate system.
y : Number
Y coordinate of the event from the source view's coordinate system.
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.

Titanium.UI.Window

Fired when the window is closed. ...

Fired when the window is closed.

Properties

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.

Titanium.UI.View

dblclick

Fired when the device detects a double click against the view. ...

Fired when the device detects a double click against the view.

Properties

x : Number
X coordinate of the event from the source view's coordinate system.
y : Number
Y coordinate of the event from the source view's coordinate system.
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.

Titanium.UI.View

doubletap

Fired when the device detects a double tap against the view. ...

Fired when the device detects a double tap against the view.

Properties

x : Number
X coordinate of the event from the source view's coordinate system.
y : Number
Y coordinate of the event from the source view's coordinate system.
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.

Titanium.UI.Window

focus

Fired when the window gains focus. ...

Fired when the window gains focus.

The listener for this event must be defined before this window is opened.

On Android, this event also fires when the activity enters the foreground (after the activity enters the resume state).

On iOS, this event does not fire after the application returns to the foreground if it was previously backgrounded. The application needs to monitor the Titanium.App.resumed event. See Titanium.App for more information on the iOS application lifecycle.

Properties

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.

Overrides: Titanium.UI.View.focus

Titanium.UI.View

keypressed

Fired when a hardware key is pressed in the view. ...

Fired when a hardware key is pressed in the view.

A keypressed event is generated by pressing a hardware key. On Android, this event can only be fired when the property focusable is set to true. On iOS the event is generated only when using Ti.UI.TextArea, Ti.UI.TextField and Ti.UI.SearchBar.

3.1.0

Properties

keyCode : Number
The code for the physical key that was pressed. For more details, see KeyEvent. This API is experimental and subject to change.
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.

Titanium.UI.View

longclick

Fired when the device detects a long click. ...

Fired when the device detects a long click.

A long click is generated by touching and holding on the touchscreen or holding down the trackball button.

The event occurs before the finger/button is lifted.

A longpress and a longclick can occur together.

As the trackball can fire this event, it is not intended to return the x and y coordinates of the touch, even when it is generated by the touchscreen.

A longclick blocks a click, meaning that a click event will not fire when a longclick listener exists.

Properties

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.

Titanium.UI.View

longpress

Fired when the device detects a long press. ...

Fired when the device detects a long press.

A long press is generated by touching and holding on the touchscreen. Unlike a longclick, it does not respond to the trackball button.

The event occurs before the finger is lifted.

A longpress and a longclick can occur together.

In contrast to a longclick, this event returns the x and y coordinates of the touch.

Properties

x : Number
X coordinate of the event from the source view's coordinate system.
y : Number
Y coordinate of the event from the source view's coordinate system.
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.

Titanium.UI.Window

open

Fired when the window is opened. ...

Fired when the window is opened.

The listener for this event must be defined before this window is opened.

Properties

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.

Titanium.UI.View

pinch

Fired when the device detects a pinch gesture. ...

Fired when the device detects a pinch gesture.

A pinch is a touch and expand or contract with two fingers. The event occurs continuously until a finger is lifted again.

1.8.0
1.8.0

Properties

scale : Number
The scale factor relative to the points of the two touches in screen coordinates.
velocity : Number
The velocity of the pinch in scale factor per second.
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.

Titanium.UI.View

postlayout

Fired when a layout cycle is finished. ...

Fired when a layout cycle is finished.

This event is fired when the view and its ancestors have been laid out. The rect and size values should be usable when this event is fired.

This event is typically triggered by either changing layout properties or by changing the orientation of the device. Note that changing the layout of child views or ancestors can also trigger a relayout of this view.

Note that altering any properties that affect layout from the postlayout callback may result in an endless loop.

2.0.0
2.0.0
2.0.0

Properties

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.

Titanium.UI.View

singletap

Fired when the device detects a single tap against the view. ...

Fired when the device detects a single tap against the view.

Properties

x : Number
X coordinate of the event from the source view's coordinate system.
y : Number
Y coordinate of the event from the source view's coordinate system.
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.

Titanium.UI.View

swipe

Fired when the device detects a swipe gesture against the view. ...

Fired when the device detects a swipe gesture against the view.

Properties

direction : String
Direction of the swipe--either 'left', 'right', 'up', or 'down'.
x : Number
X coordinate of the event's endpoint from the source view's coordinate system.
y : Number
Y coordinate of the event's endpoint from the source view's coordinate system.
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.

Titanium.UI.View

touchcancel

Fired when a touch event is interrupted by the device. ...

Fired when a touch event is interrupted by the device.

A touchcancel can happen in circumstances such as an incoming call to allow the UI to clean up state.

Properties

x : Number
X coordinate of the event from the source view's coordinate system.
y : Number
Y coordinate of the event from the source view's coordinate system.
force : Number
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
size : Number
The current size of the touch area. Note: This property is only available on some Android devices.
maximumPossibleForce : Number
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
altitudeAngle : Number
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
timestamp : Number
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
azimuthUnitVectorInViewX : Number
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
azimuthUnitVectorInViewY : Number
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
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.

Titanium.UI.View

touchend

Fired when a touch event is completed. ...

Fired when a touch event is completed.

On the Android platform, other gesture events, such as longpress or swipe, cancel touch events, so this event may not be triggered after a touchstart event.

Properties

x : Number
X coordinate of the event from the source view's coordinate system.
y : Number
Y coordinate of the event from the source view's coordinate system.
force : Number
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
size : Number
The current size of the touch area. Note: This property is only available on some Android devices.
maximumPossibleForce : Number
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
altitudeAngle : Number
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
timestamp : Number
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
azimuthUnitVectorInViewX : Number
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
azimuthUnitVectorInViewY : Number
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Penciland are 9.1 or later.
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.

Titanium.UI.View

touchmove

Fired as soon as the device detects movement of a touch. ...

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

Properties

x : Number
X coordinate of the event from the source view's coordinate system.
y : Number
Y coordinate of the event from the source view's coordinate system.
force : Number
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
size : Number
The current size of the touch area. Note: This property is only available on some Android devices.
maximumPossibleForce : Number
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
altitudeAngle : Number
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
timestamp : Number
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
azimuthUnitVectorInViewX : Number
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
azimuthUnitVectorInViewY : Number
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
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.

Titanium.UI.View

touchstart

Fired as soon as the device detects a touch gesture. ...

Fired as soon as the device detects a touch gesture.

Properties

x : Number
X coordinate of the event from the source view's coordinate system.
y : Number
Y coordinate of the event from the source view's coordinate system.
force : Number
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
size : Number
The current size of the touch area. Note: This property is only available on some Android devices.
maximumPossibleForce : Number
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
altitudeAngle : Number
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
timestamp : Number
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
azimuthUnitVectorInViewX : Number
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
azimuthUnitVectorInViewY : Number
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
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.

Titanium.UI.View

twofingertap

Fired when the device detects a two-finger tap against the view. ...

Fired when the device detects a two-finger tap against the view.

3.0.0
0.9
0.9

Properties

x : Number
X coordinate of the event from the source view's coordinate system.
y : Number
Y coordinate of the event from the source view's coordinate system.
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.