Titanium SDK

# Titanium.UI.Window

The Window is an empty drawing surface or container.

Availability
0.9
0.9
9.2.0
Extends
Titanium.UI.View

# Overview

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 (opens new window) 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 $.args 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.
// $.label.text = $.args.foobar;

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 has the concept of a modal window but instead uses modal dialogs. You are probably looking for a Titanium.UI.AlertDialog or Titanium.UI.OptionDialog and the androidView property rather than a modal window.

However, if you know what you are doing and use modal, Titanium creates a window with a translucent background (if the background properties are not set).

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.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 Titanium.UI.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.createMatrix2D().scale(0);
$.index.open();

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

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

Note that to animate an Android window while you open it, you need to follow a specific procedure which is explained below in "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.

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 Titanium.UI.Window.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.createMatrix2D()
    },
    // The hide transition makes the window transparent and rotates it upside down
    transitionFrom: {
        opacity: 0,
        duration: 300 / 2,
        transform: Ti.UI.createMatrix2D().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.createMatrix2D()
    },
    // The hide transition makes the window transparent and rotates it upside down
    transitionFrom: {
        opacity: 0,
        duration: 300 / 2,
        transform: Ti.UI.createMatrix2D().rotate(180),
    }
});

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

# Android Platform Notes

# Window Transitions in Android

A window is associated with a new Android Titanium.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 Titanium.UI.Window.open or Titanium.UI.Window.close will have no effect.

Instead, in the parameter dictionary you pass to Titanium.UI.Window.open or Titanium.UI.Window.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();
win2.open({
    activityEnterAnimation: Ti.Android.R.anim.fade_in,
    activityExitAnimation: Ti.Android.R.anim.fade_out
});

See the official Android R.anim (opens new window) documentation for information about built-in animations.

For information on creating your own animation resource XML files, see "View Animation (opens new window)" 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 preview ImageView in window A to a full-width ImageView in window B.

const windowA = Ti.UI.createWindow({
  title: "overview"
});

// Create an item in window A with a unique transitionName.
const viewA = Ti.UI.createImageView({
  top: 10,
  left: 10,
  scalingMode: Titanium.Media.IMAGE_SCALING_ASPECT_FILL,
  image: "https://api.lorem.space/image/shoes?w=500&h=500",
  height: 100,
  width: 100,
  transitionName: 'title'
});

const btn = Ti.UI.createButton({
  bottom: 10,
  title: "open new window"
})

btn.addEventListener("click", function() {
  // Before opening window B specify the common UI elements.
  windowB.addSharedElement(viewA, "title");
  windowB.open();

  windowB.activity.onCreate = () => {
    const actionBar = windowB.activity.actionBar;
    if (actionBar) {
      actionBar.displayHomeAsUp = true;
      actionBar.title = "New Title";
      actionBar.onHomeIconItemSelected = () => {
        windowB.close();
      };
    }
  };
})
windowA.add([viewA, btn]);
windowA.open();

// Creating an item in window B, note that the same transitionName is used.
const windowB = Ti.UI.createWindow({});
const viewB = Ti.UI.createImageView({
  scalingMode: Titanium.Media.IMAGE_SCALING_ASPECT_FILL,
  top: 0,
  left: 0,
  image: "https://api.lorem.space/image/shoes?w=500&h=500",
  height: 200,
  width: Ti.UI.FILL,
  transitionName: 'title'
});
const labelB = Ti.UI.createLabel({
  top: 210,
  left: 10,
  text: "Detail window"
})
windowB.add([viewB, labelB]);

Further you can use activityEnterTransition, activityExitTransition, activityReenterTransition and activityReturnTransition to customize the way activities transition into the scene. These are intended to be used with views set up as "shared elements" via the addSharedElement() method where these views will be moved from window to the other. As of Titanium 8.0.1, you don't have to add views as shared elements to use these transition animations, while in older version of Titanium that was required.

See the official Android Activity Transitions (opens new window) 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>

# Properties

# accessibilityDisableLongPress CREATION ONLY

Availability
12.4.0
accessibilityDisableLongPress :Boolean

Boolean value to remove the long press notification for the device's accessibility service.

Will disable the "double tap and hold for long press" message when selecting an item.

Default: true

# accessibilityHidden

Availability
3.0.0
3.0.0
9.2.0
accessibilityHidden :Boolean

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

On iOS this is a direct analog of the accessibilityElementsHidden property defined in the UIAccessibility Protocol.

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

# accessibilityHint

Availability
3.0.0
3.0.0
9.2.0
accessibilityHint :String

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

# accessibilityLabel

Availability
3.0.0
3.0.0
9.2.0
accessibilityLabel :String

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. Defaults to Title or label of the control.

# accessibilityValue

Availability
3.0.0
3.0.0
9.2.0
accessibilityValue :String

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. Defaults to State or value of the control.

# activity READONLY

Availability
0.9
activity :Titanium.Android.Activity

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.

# activityEnterTransition CREATION ONLY

Availability
5.2.0
activityEnterTransition :Number

The type of transition used when activity is entering.

Activity B's enter transition determines how views in B are animated when A starts B. Applicable for Android 5.0 and above. This transition property will be ignored if animated is set to false. Will also be ignored unless at least 1 view has been assigned to the addSharedElement() method, except on Titanium 8.0.1 and higher where shared elements are no longer required to do transitions.

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.

# activityExitTransition CREATION ONLY

Availability
5.2.0
activityExitTransition :Number

The type of transition used when activity is exiting.

Activity A's exit transition determines how views in A are animated when A starts B. Applicable for Android 5.0 and above. This transition property will be ignored if animated is set to false. Will also be ignored unless at least 1 view has been assigned to the addSharedElement() method, except on Titanium 8.0.1 and higher where shared elements are no longer required to do transitions.

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.

# activityReenterTransition CREATION ONLY

Availability
5.2.0
activityReenterTransition :Number

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

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 transition property will be ignored if animated is set to false. Will also be ignored unless at least 1 view has been assigned to the addSharedElement() method, except on Titanium 8.0.1 and higher where shared elements are no longer required to do transitions.

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

# activityReturnTransition CREATION ONLY

Availability
5.2.0
activityReturnTransition :Number

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

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 transition property will be ignored if animated is set to false. Will also be ignored unless at least 1 view has been assigned to the addSharedElement() method, except on Titanium 8.0.1 and higher where shared elements are no longer required to do transitions.

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

# activitySharedElementEnterTransition CREATION ONLY

Availability
5.2.0
activitySharedElementEnterTransition :Number

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

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](https://github.com/android/platform_frameworks_base/blob/lollipop-release/core/res/res/transition/move.xml) transition.

# activitySharedElementExitTransition CREATION ONLY

Availability
5.2.0
activitySharedElementExitTransition :Number

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

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](https://github.com/android/platform_frameworks_base/blob/lollipop-release/core/res/res/transition/move.xml) transition.

# activitySharedElementReenterTransition CREATION ONLY

Availability
5.2.0
activitySharedElementReenterTransition :Number

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

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](https://github.com/android/platform_frameworks_base/blob/lollipop-release/core/res/res/transition/move.xml) transition.

# activitySharedElementReturnTransition CREATION ONLY

Availability
5.2.0
activitySharedElementReturnTransition :Number

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

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](https://github.com/android/platform_frameworks_base/blob/lollipop-release/core/res/res/transition/move.xml) transition.

# anchorPoint

Availability
7.5.0
2.1.0
9.2.0
anchorPoint :Point

Coordinate of the view about which to pivot an animation.

Used on iOS only. For Android, use 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. The default is center of this view.

# animatedCenter READONLY

Availability
0.9
9.2.0
animatedCenter :Point

Current position of the view during an animation.

# apiName READONLY

Availability
3.2.0
3.2.0
9.2.0
apiName :String

The name of the API that this proxy corresponds to.

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

# autoAdjustScrollViewInsets

Availability
3.1.3
9.2.0
autoAdjustScrollViewInsets :Boolean

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

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.

# backButtonTitle

Availability
0.9
9.2.0
backButtonTitle :String

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

# backButtonTitleImage

Availability
0.9
9.2.0
backButtonTitleImage :String | Titanium.Blob

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

# backgroundColor

Availability
0.9
0.9
9.2.0
backgroundColor :String | Titanium.UI.Color

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

# backgroundDisabledColor

Availability
0.9
backgroundDisabledColor :String

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. Defaults to the normal background color of this view.

# backgroundDisabledImage

Availability
0.9
backgroundDisabledImage :String

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

If backgroundDisabledImage is undefined, and the normal background imagebackgroundImage is set, the normal image is used when this view is disabled.

# backgroundFocusedColor

Availability
0.9
backgroundFocusedColor :String

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. Defaults to the normal background color of this view.

# backgroundFocusedImage

Availability
0.9
backgroundFocusedImage :String

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. If backgroundFocusedImage is undefined, and the normal background image backgroundImage is set, the normal image is used when this view is focused.

# backgroundGradient

Availability
0.9
0.9
9.2.0
backgroundGradient :Gradient

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 points, 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. Defaults to no gradient.

# backgroundImage

Availability
0.9
0.9
9.2.0
backgroundImage :String

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

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, textfields, and so on), platform-specific default images are used.

# backgroundLeftCap

Availability
0.9
9.2.0
backgroundLeftCap :Number

Size of the left end cap.

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

Default: 0

# backgroundRepeat

Availability
0.9
0.9
9.2.0
backgroundRepeat :Boolean

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

# backgroundSelectedColor

Availability
0.9
backgroundSelectedColor :String | Titanium.UI.Color

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.

Defaults to background color of this view.

# backgroundSelectedImage

Availability
0.9
backgroundSelectedImage :String

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.

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

# backgroundTopCap

Availability
0.9
9.2.0
backgroundTopCap :Number

Size of the top end cap.

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

Default: 0

# barColor

Availability
8.0.1
0.9
9.2.0
barColor :String | Titanium.UI.Color

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.

# barImage

Availability
0.9
9.2.0
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.

# borderColor

Availability
0.9
0.9
9.2.0
borderColor :String | Titanium.UI.Color

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

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

Defaults to the normal background color of this view (Android), black (iOS).

# borderRadius

Availability
0.9
0.9
9.2.0
borderRadius :Number | String | Array<Number> | Array<String>

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

Each corner is rounded using an arc of a circle. Values for each corner can be specified. For example, '20px 20px' will set both left and right corners to 20px. Specifying '20px 20px 20px 20px' will set top-left, top-right, bottom-right and bottom-left corners in that order.

If you have issues with dark artifacts on Android you can try to disable Hardware acceleration by setting a backgroundColor with a small amount of transparency: backgroundColor:"rgba(255,255,255,254)".

Default: 0

# borderWidth

Availability
0.9
0.9
9.2.0
borderWidth :Number

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

# bottom

Availability
0.9
0.9
9.2.0
bottom :Number | String

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

On Android, this property has no effect.

Default: 0

# bubbleParent

Availability
3.0.0
3.0.0
9.2.0
bubbleParent :Boolean

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

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

Default: true

# center

Availability
0.9
0.9
9.2.0
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.

Defaults to undefined.

# children READONLY

Availability
0.9
0.9
9.2.0
children :Array<Titanium.UI.View>

Array of this view's child views.

# clipMode

Availability
3.3.0
9.2.0
clipMode :Number

View's clipping behavior.

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

Defaults to undefined. Behaves as if set to CLIP_MODE_DEFAULT.

# closed READONLY

Availability
9.1.0
9.1.0
9.2.0
closed :Boolean

Determines whether this Window is closed.

Default: true

# elevation

Availability
5.0.0
elevation :Number

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

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.

# exitOnClose

Availability
0.9
exitOnClose :Boolean

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.

# extendEdges

Availability
3.1.3
9.2.0
extendEdges :Array<Number>

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

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:

# extendSafeArea CREATION ONLY

Availability
7.5.0
6.3.0
9.2.0
extendSafeArea :Boolean

Specifies whether the screen insets/notches are allowed to overlap the window's content or not.

If set true, then the contents of the window will be extended to fill the whole screen and allow the system's UI elements (such as a translucent status-bar) and physical obstructions (such as the iPhone X rounded corners and top sensor housing) to overlap the window's content. In this case, it is the app developer's responsibility to position views so that they're unobstructed. On Android, you can use the safeAreaPadding property after the window has been opened to layout your content within the insets.

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: `false` on Android, `true` on iOS.

# filterTouchesWhenObscured

Availability
9.3.0
filterTouchesWhenObscured :Boolean

Discards touch related events if another app's system overlay covers the view.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

Setting this property to true causes touch related events (including "click") to not be fired if a system overlay overlaps the view.

Default: false

# flagSecure CREATION ONLY

Availability
3.3.0
flagSecure :Boolean

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

# focusable

Availability
0.9
focusable :Boolean

Whether view should be focusable while navigating with the trackball.

Default: false

# focused READONLY

Availability
9.1.0
9.1.0
9.2.0
focused :Boolean

Determines whether this TextArea has focus.

Default: false

# fullscreen

Availability
0.9
0.9
9.2.0
fullscreen :Boolean

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

Default: false

# height

Availability
0.9
0.9
9.2.0
height :Number | String

View height, in platform-specific units.

Defaults to: If undefined, defaults to either FILL or 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:

  • SIZE. The view should size itself to fit its contents.
  • 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:

# hiddenBehavior

Availability
6.1.0
hiddenBehavior :Number

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

If setting hiddenBehavior to 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.

Defaults to Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE.

This API can be assigned the following constants:

# hidesBackButton

Availability
8.0.0
7.5.0
9.2.0
hidesBackButton :Boolean

Set this to true to hide the back button of navigation bar.

When this property is set to true, the navigation window hides its back button.

Default: false

# hidesBarsOnSwipe CREATION ONLY

Availability
6.0.0
9.2.0
hidesBarsOnSwipe :Boolean

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

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

# hidesBarsOnTap CREATION ONLY

Availability
6.0.0
9.2.0
hidesBarsOnTap :Boolean

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

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

# hidesBarsWhenKeyboardAppears CREATION ONLY

Availability
6.0.0
9.2.0
hidesBarsWhenKeyboardAppears :Boolean

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

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

# hideShadow

Availability
3.2.0
9.2.0
hideShadow :Boolean

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

# hidesSearchBarWhenScrolling

Availability
8.1.0
9.2.0
hidesSearchBarWhenScrolling :Boolean

A Boolean value indicating whether the integrated search bar is hidden when scrolling any underlying content.

When the value of this property is true, the search bar is visible only when the scroll position equals the top of your content view. When the user scrolls down, the search bar collapses into the navigation bar. Scrolling back to the top reveals the search bar again. When the value of this property is false, the search bar remains regardless of the current scroll position. You must set showSearchBarInNavBar or showSearchBarInNavBar property for this property to have any effect.

Default: true

# homeIndicatorAutoHidden

Availability
7.3.0
9.2.0
homeIndicatorAutoHidden :Boolean

Boolean value indicating whether the system is allowed to hide the visual indicator for returning to the Home screen.

Set this value true, if you want the system to determine when to hide the indicator. Set this value false, if you want the indicator shown at all times. The system takes your preference into account, but setting true is no guarantee that the indicator will be hidden.

Default: false

# horizontalMotionEffect

Availability
7.3.0
9.2.0
horizontalMotionEffect :MinMaxOptions

Adds a horizontal parallax effect to the view

Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator. To clear all motion effects, use the <Titanium.UI.clearMotionEffects> method.

# horizontalWrap

Availability
2.1.0
2.1.0
9.2.0
horizontalWrap :Boolean

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

# id

Availability
0.9
0.9
9.2.0
id :String

View's identifier.

The id property of the Ti.UI.View represents the view's identifier. The identifier string does not have to be unique. You can use this property with getViewById method.

# includeOpaqueBars

Availability
3.1.3
9.2.0
includeOpaqueBars :Boolean

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

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.

# keepScreenOn

Availability
0.9
keepScreenOn :Boolean

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. For iOS look at idleTimerDisabled.

Default: false

# largeTitleDisplayMode

Availability
6.3.0
9.2.0
largeTitleDisplayMode :Number

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

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

# largeTitleEnabled

Availability
6.3.0
9.2.0
largeTitleEnabled :Boolean

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

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

# layout

Availability
0.9
0.9
9.2.0
layout :String

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

    Defaults to Composite layout.

# left

Availability
0.9
0.9
9.2.0
left :Number | String

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

On Android, this property has no effect.

Default: 0

# leftNavButton

Availability
0.9
9.2.0
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>

# leftNavButtons

Availability
3.3.0
9.2.0
leftNavButtons :Array<Titanium.UI.View>

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

# lifecycleContainer

Availability
3.6.0
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.

modal :Boolean

Indicates to open a modal window or not.

Set to true to create a modal window.

Must be specified at creation time or in the dictionary passed to the open method.

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.

See the "Modal Windows" section for platform-specific information.

Default: false

navBarHidden :Boolean

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

navigationWindow :Titanium.UI.NavigationWindow

The Titanium.UI.NavigationWindow instance hosting this window.

Returns the navigation window that hosts this window. Returns null if the window is not hosted by a navigation window.

navTintColor :String | Titanium.UI.Color

The tintColor to apply to the navigation bar.

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

Default: null

# onBack

Availability
0.9
onBack :Callback<void>

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

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

# opacity

Availability
0.9
0.9
9.2.0
opacity :Number

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.

# orientation READONLY

Availability
0.9
3.0.0
9.2.0
orientation :Number

Current orientation of the window.

To determine the current orientation of the device, see 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:

# orientationModes

Availability
0.9
0.9
9.2.0
orientationModes :Array<Number>

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 orientation. To determine the current orientation of the device, see orientation. To be notified when the device's current orientation changes, add a listener for the orientationchange event.

# Android Orientation Modes

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

  1. Empty array. Enables orientation to be fully controlled by the device sensor.

  2. Array includes one or both portrait modes and one or both landscape modes. Enables full sensor control (identical to an empty array).

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

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

  5. Array contains only PORTRAIT. Locks screen orientation to normal portrait mode.

  6. Array contains only LANDSCAPE_LEFT. Locks screen orientation to normal landscape mode.

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

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

# overrideCurrentAnimation CREATION ONLY

Availability
3.3.0
overrideCurrentAnimation :Boolean

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.

Defaults to undefined but behaves as false

# previewContext

Availability
5.1.0
previewContext :Titanium.UI.iOS.PreviewContext

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

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

# pullBackgroundColor

Availability
3.3.0
9.2.0
pullBackgroundColor :String | Titanium.UI.Color

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

Defaults to undefined. Results in a light grey background color on the wrapper view.

# rect READONLY

Availability
2.0.0
2.0.0
9.2.0
rect :DimensionWithAbsolutes

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.

right :Number | String

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

On Android, this property has no effect.

Default: 0

# rightNavButton

Availability
0.9
9.2.0
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>

# rightNavButtons

Availability
3.3.0
9.2.0
rightNavButtons :Array<Titanium.UI.View>

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

# rotation

Availability
5.4.0
12.3.0
rotation :Number

Clockwise 2D rotation of the view in degrees.

Translation values are applied to the static post layout value.

# rotationX

Availability
5.4.0
rotationX :Number

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

Translation values are applied to the static post layout value.

# rotationY

Availability
5.4.0
rotationY :Number

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

Translation values are applied to the static post layout value.

# safeAreaPadding READONLY

Availability
7.5.0
8.0.0
9.2.0
safeAreaPadding :Padding

The padding needed to safely display content without it being overlapped by the screen insets and notches.

When setting extendSafeArea to true, the system's insets such as a translucent status bar, translucent navigation bar, and/or camera notches will be allowed to overlay on top of the window's content. In this case, it is the app developer's responsibility to prevent these insets from overlapping key content such as buttons. This property provides the amount of space needed to be added to the left, top, right, and bottom edges of the window root view to do this.

This property won't return values greater than zero until the window has been opened. It is recommended that you read this property via a postlayout event listener since the padding values can change when when the app's orientation changes or when showing/hiding the action bar.

If the extendSafeArea property is set false, then the returned padding will be all zeros since the root content will be positioned between all insets.

Below is an example on how to set up a safe-area view container using this property.

// Set up a window with a translucent top status bar and translucent nav bar.
// This will only work on Android 4.4 and newer OS versions.
var win = Ti.UI.createWindow({
    extendSafeArea: true,
    theme: 'Theme.Titanium.NoTitleBar',
    windowFlags: Ti.UI.Android.FLAG_TRANSLUCENT_NAVIGATION | Ti.UI.Android.FLAG_TRANSLUCENT_STATUS
});

// Set up a safe-area view to be layed out between the system insets.
// You should use this as a container for child views.
var safeAreaView = Ti.UI.createView({
    backgroundColor: 'green'
});
win.add(safeAreaView);
win.addEventListener('postlayout', function() {
    // Update the safe-area view's dimensions after every 'postlayout' event.
    safeAreaView.applyProperties(win.safeAreaPadding);
});

// Open the window.
win.open();

# scaleX

Availability
5.4.0
scaleX :Number

Scaling of the view in x-axis in pixels.

Translation values are applied to the static post layout value.

# scaleY

Availability
5.4.0
scaleY :Number

Scaling of the view in y-axis in pixels.

Translation values are applied to the static post layout value.

# shadowImage

Availability
3.2.0
9.2.0
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.

# size READONLY

Availability
0.9
0.9
9.2.0
size :Dimension

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.

# softKeyboardOnFocus

Availability
0.9
softKeyboardOnFocus :Number

Determines keyboard behavior when this view is focused. Defaults to SOFT_KEYBOARD_DEFAULT_ON_FOCUS.

This API can be assigned the following constants:

# splitActionBar CREATION ONLYDEPRECATED

Availability
3.6.0
splitActionBar :Boolean

DEPRECATED SINCE 6.2.0

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

Boolean value to enable split action bar.

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

# statusBarColor

Availability
12.5.0
statusBarColor :Number

The color of the status bar (top bar) for this window.

# statusBarStyle

Availability
3.1.3
9.2.0
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 DEFAULT.

This API can be assigned the following constants:

# sustainedPerformanceMode

Availability
7.0.0
sustainedPerformanceMode :Boolean

Maintain a sustainable level of performance.

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 for further info.

# swipeToClose

Availability
5.2.0
9.2.0
swipeToClose :Boolean

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 Titanium.UI.Tab or Titanium.UI.NavigationWindow. It is enabled by default.

Default: true

# tabBarHidden

Availability
0.9
9.2.0
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.

# theme CREATION ONLY

Availability
3.4.0
theme :String

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.

# tintColor

Availability
3.1.3
9.2.0
tintColor :String | Titanium.UI.Color

The view's tintColor

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

# title

Availability
0.9
0.9
9.2.0
title :String

Title of the window.

# titleAttributes

Availability
12.3.0
3.2.0
9.2.0
titleAttributes :titleAttributesParams

Title text attributes of the window.

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

# titleControl

Availability
0.9
9.2.0
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>

# titleid

Availability
0.9
0.9
9.2.0
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.

# titleImage

Availability
0.9
9.2.0
titleImage :String

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

# titlePrompt

Availability
0.9
9.2.0
titlePrompt :String

Title prompt for the window.

# titlepromptid

Availability
0.9
9.2.0
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.

# toolbar

Availability
0.9
9.2.0
toolbar :Array<Titanium.UI.View>

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

The toolbar is only shown when the window is inside a Titanium.UI.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>

# tooltip

Availability
12.1.0
12.1.0
12.1.0
tooltip :String

The default text to display in the control's tooltip.

Assigning a value to this property causes the tool tip to be displayed for the view. Setting the property to null cancels the display of the tool tip for the view. Note: This property is only used for apps targeting macOS Catalyst.

# top

Availability
0.9
0.9
9.2.0
top :Number | String

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

On Android, this property has no effect.

Default: 0

# touchEnabled

Availability
0.9
0.9
9.2.0
touchEnabled :Boolean

Determines whether view should receive touch events.

If false, will forward the events to peers.

Default: true

# touchFeedback

Availability
6.1.0
touchFeedback :Boolean

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

Touch feedback is only applied to a view's background. It is never applied to the view's foreground content such as a Titanium.UI.ImageView's image.

For Titanium versions older than 9.1.0, touch feedback only works if you set the backgroundColor property to a non-transparent color.

Default: false

# touchFeedbackColor

Availability
6.1.0
touchFeedbackColor :String

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

Defaults to provided theme color.

# transform

Availability
0.9
0.9
9.2.0
transform :Titanium.UI.Matrix2D | Titanium.UI.Matrix3D

Transformation matrix to apply to the view.

Android only supports Matrix2D transforms.

Default: Identity matrix

# transitionAnimation

Availability
3.2.0
9.2.0
transitionAnimation :Titanium.Proxy

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

Create the transition animation using the createTransitionAnimation method.

# transitionName

Availability
5.0.2
transitionName :String

A name to identify this view in activity transition.

Name should be unique in the View hierarchy.

# translationX

Availability
5.0.0
translationX :Number

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

Translation values are applied to the static post layout value.

# translationY

Availability
5.0.0
translationY :Number

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

Translation values are applied to the static post layout value.

# translationZ

Availability
5.0.0
translationZ :Number

Depth of the view relative to its elevation in pixels.

Translation values are applied to the static post layout value.

# translucent

Availability
0.9
9.2.0
translucent :Boolean

Boolean value indicating if the nav bar is translucent.

Default: true on iOS7 and above, false otherwise.

# uiFlags

Availability
12.7.0
uiFlags :Number

Additional UI flags to set on the Activity Window.

See WindowManager.LayoutParams for a list of additional flags that can be assigned to this property. For example, you can use 8192 (SYSTEM_UI_FLAG_LIGHT_STATUS_BAR) to set the status bar text color to a dark color.

# verticalMotionEffect

Availability
7.3.0
9.2.0
verticalMotionEffect :MinMaxOptions

Adds a vertical parallax effect to the view

Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator. To clear all motion effects, use the <Titanium.UI.clearMotionEffects> method.

# viewShadowColor

Availability
11.1.0
3.3.0
9.2.0
viewShadowColor :String | Titanium.UI.Color

Determines the color of the shadow.

iOS Defaults to undefined. Behaves as if transparent. Android default is black. On Android you can set <item name="android:ambientShadowAlpha">0.5</item> and <item name="android:spotShadowAlpha">0.5</item> in your theme to change the opacity.

# viewShadowOffset

Availability
3.3.0
9.2.0
viewShadowOffset :Point

Determines the offset for the shadow of the view.

Defaults to undefined. Behaves as if set to (0,-3)

# viewShadowRadius

Availability
3.3.0
9.2.0
viewShadowRadius :Number | String

Determines the blur radius used to create the shadow.

Defaults to undefined. Behaves as if set to 3. Accepts density units as of 10.0.1.

# visible

Availability
0.9
0.9
9.2.0
visible :Boolean

Determines whether the view is visible.

Default: true

# width

Availability
0.9
0.9
9.2.0
width :Number | String

View's width, in platform-specific units.

Defaults to: If undefined, defaults to either FILL or 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:

  • SIZE. The view should size itself to fit its contents.
  • 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:

# windowFlags CREATION ONLY

Availability
3.3.0
windowFlags :Number

Additional flags to set on the Activity Window.

Sets flags such as FLAG_TRANSLUCENT_NAVIGATION and FLAG_TRANSLUCENT_STATUS. When using multiple flags, you must bitwise-or them together.

See WindowManager.LayoutParams for list of additional flags that you can assign to this property. You can assign these Java flags to this property by using their numeric constant.

Setting fullscreen to true automatically sets the WindowManager.LayoutParams.FLAG_FULLSCREEN flag. Setting flagSecure to true automatically sets the WindowManager.LayoutParams.FLAG_SECURE flag.

Use STATUS_BAR_LIGHT to set the status bar text color to light mode.

# windowPixelFormat

Availability
1.8.0
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:

# windowSoftInputMode CREATION ONLY

Availability
0.9
windowSoftInputMode :Number

Determines whether a 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.

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:

# zIndex

Availability
0.9
0.9
9.2.0
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.

Defaults to undefined.

# Methods

# add

Availability
0.9
0.9
9.2.0
add(view) → void

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:

  • Titanium.UI.ButtonBar and Titanium.UI.iOS.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.

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

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

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

  • Titanium.UI.iOS.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.iOS.SplitWindow, Titanium.UI.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.NavigationWindow, Titanium.UI.iOS.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

Name Type Description
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

Type
void

# addEventListener

Availability
0.9
0.9
9.2.0
addEventListener(name, callback) → void

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

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to invoke when the event is fired.

Returns

Type
void

# addSharedElement

Availability
5.2.0
addSharedElement(view, transitionName) → void

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

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

Parameters

Name Type Description
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

Type
void

# animate

Availability
0.9
0.9
9.2.0
animate(animation[, callback]) → void

Animates this view.

The Titanium.UI.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 on SDKs older than 9.1.0 - 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.

As of SDK 9.1.0, the final values of the animation will be set on the view just before the complete event and/or the callback is fired.

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

Parameters

Name Type Description
animation Titanium.UI.Animation | Dictionary<Titanium.UI.Animation>

Either a dictionary of animation properties or an Titanium.UI.Animation object.

callback Callback<Object>

Function to be invoked upon completion of the animation.

Returns

Type
void

# applyProperties

Availability
3.0.0
3.0.0
9.2.0
applyProperties(props) → void

Applies the properties to the proxy.

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

Parameters

Name Type Description
props Dictionary

A dictionary of properties to apply.

Returns

Type
void

# clearMotionEffects

Availability
8.2.0
9.2.0
clearMotionEffects() → void

Removes all previously added motion effects.

Use this method together with <Titanium.UI.horizontalMotionEffect> and <Titanium.UI.verticalMotionEffect>.

Returns

Type
void

# close

Availability
0.9
0.9
9.2.0
close([params]) → Promise<any>

Closes the window.

Android only supports the argument type closeWindowParams.

Parameters

Name Type Description
params Titanium.UI.Animation | Dictionary<Titanium.UI.Animation> | closeWindowParams

Animation or display properties to use when closing the window.

Returns

Starting in SDK 10.0.0, this method returns a Promise that will be resolved once the window is closed, akin to adding a one-time listener for the close event. If the window fails to close (for example, because it was not yet open) the Promise will be rejected.

Type
Promise<any>

# convertPointToView

Availability
1.8
1.8
9.2.0
convertPointToView(point, destinationView) → Point

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

Name Type Description
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

Type
Point

# fireEvent

Availability
0.9
0.9
9.2.0
fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name Type Description
name String

Name of the event.

event Dictionary

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

Returns

Type
void

# getViewById

Availability
6.1.0
6.1.0
9.2.0
getViewById(id) → Titanium.UI.View

Returns the matching view of a given view ID.

Parameters

Name Type Description
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

Type
Titanium.UI.View

# hide

Availability
0.9
0.9
9.2.0
hide([options]) → void

Hides this view.

Parameters

Name Type Description
options AnimatedOptions

Animation options for Android only. Since SDK 5.1.0 and used only on Android 5.0+

Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in { animated: false }

Returns

Type
void

# hideNavBar

Availability
0.9
9.2.0
hideNavBar([options]) → void

Hides the navigation bar.

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

Parameters

Name Type Description
options AnimatedOptions

Options dictionary supporting a single animated boolean property to determine whether the navigation bar will be animated (default) while being hidden. Note that the default here is equivalent to { animated: true }

Returns

Type
void

# hideTabBar

Availability
0.9
9.2.0
hideTabBar() → void

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

Type
void

# hideToolbar

Availability
5.4.0
9.2.0
hideToolbar([options]) → void

Makes the bottom toolbar invisible.

If the window is not displayed in a Titanium.UI.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.

Parameters

Name Type Description
options AnimatedOptions

Options dictionary supporting a single animated boolean property to determine whether the toolbar will be animated (default) while being hidden. Note that the default here is equivalent to { animated: true }

Returns

Type
void

# insertAt

Availability
3.3.0
3.3.0
9.2.0
insertAt(params) → void

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

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

Parameters

Name Type Description
params ViewPositionOptions

Pass an object that specifies the view to insert and optionally at which position (defaults to end)

Returns

Type
void

# open

Availability
0.9
0.9
9.2.0
open([params]) → Promise<any>

Opens the window.

Parameters

Name Type Description
params openWindowParams

Animation or display properties to use when opening the window.

Returns

Starting in SDK 10.0.0, this method returns a Promise that will be resolved once the window is opened, akin to adding a one-time listener for the open event. If the window fails to open (for example, because it is already opened or opening) the Promise will be rejected.

Type
Promise<any>

# remove

Availability
0.9
0.9
9.2.0
remove(view) → void

Removes a child view from this view's hierarchy.

Parameters

Name Type Description
view Titanium.UI.View

View to remove from this view's hierarchy.

Returns

Type
void

# removeAllSharedElements

Availability
5.2.0
removeAllSharedElements() → void

Clears all added shared elements.

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

Returns

Type
void

# removeEventListener

Availability
0.9
0.9
9.2.0
removeEventListener(name, callback) → void

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

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

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

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

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

window.removeEventListener('click', listener);

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

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

Returns

Type
void

# replaceAt

Availability
3.3.0
3.3.0
9.2.0
replaceAt(params) → void

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

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

Parameters

Name Type Description
params ViewPositionOptions

Pass an object with the view to insert and the position of the view to replace. In this case the position property is required.

Returns

Type
void

# setToolbar

Availability
0.9
9.2.0
setToolbar(items[, params]) → void

Sets the array of items to show in the window's toolbar.

Parameters

Name Type Description
items Array<Object>

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

params windowToolbarParam

Parameters to control the toolbar appearance.

Returns

Type
void

# show

Availability
0.9
0.9
9.2.0
show([options]) → void

Makes this view visible.

Parameters

Name Type Description
options AnimatedOptions

Animation options for Android only. Since SDK 5.1.0 and only used on Android 5.0+

Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in { animated: false }

Returns

Type
void

# showNavBar

Availability
0.9
9.2.0
showNavBar([options]) → void

Makes the navigation bar visible.

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

Parameters

Name Type Description
options AnimatedOptions

Options dictionary supporting a single animated boolean property to determine whether the navigation bar will be animated (default) while being shown. Note that the default here is equivalent to { animated: true }

Returns

Type
void

# showToolbar

Availability
5.4.0
9.2.0
showToolbar([options]) → void

Makes the bottom toolbar visible.

If the window is not displayed in a Titanium.UI.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.

Parameters

Name Type Description
options AnimatedOptions

Options dictionary supporting a single animated boolean property to determine whether the toolbar will be animated (default) while being shown. Note that the default here is equivalent to { animated: true }

Returns

Type
void

# stopAnimation

Availability
12.1.0
stopAnimation() → void

Stops a running animation.

Stops a running view Titanium.UI.Animation.

Returns

Type
void

# toImage

Availability
0.9
0.9
9.2.0
toImage([callback[, honorScaleFactor]]) → Titanium.Blob

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

The honorScaleFactor argument is only supported on iOS.

Parameters

Name Type Description
callback Callback<Titanium.Blob>

Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately.

honorScaleFactor Boolean

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

Type
Titanium.Blob

# Events

# click

Availability
0.9
0.9
9.2.0

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

Name Type Description
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.

obscured Boolean

Returns true if the click passed through an overlapping window belonging to another app.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

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.

# dblclick

Availability
0.9
0.9
9.2.0

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

Properties

Name Type Description
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.

obscured Boolean

Returns true if the double click passed through an overlapping window belonging to another app.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

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.

# doubletap

Availability
0.9
0.9
9.2.0

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

Properties

Name Type Description
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.

obscured Boolean

Returns true if the double tap passed through an overlapping window belonging to another app.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

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.

# focus

Availability
0.9
0.9
9.2.0

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 resumed event. See Titanium.App for more information on the iOS application lifecycle.

# keypressed

Availability
3.1.0
5.4.0
9.2.0

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 Titanium.UI.TextArea, Titanium.UI.TextField and Titanium.UI.SearchBar.

Properties

Name Type Description
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.

# longclick

Availability
0.9

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.

# longpress

Availability
0.9
0.9
9.2.0

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

Name Type Description
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.

obscured Boolean

Returns true if the long press passed through an overlapping window belonging to another app.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

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.

# pinch

Availability
1.8.0
1.8.0
9.2.0

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.

Properties

Name Type Description
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.

time Number

The event time of the current event being processed.

timeDelta Number

The time difference in milliseconds between the previous accepted scaling event and the current scaling event.

currentSpan Number

The average distance between each of the pointers forming the gesture in progress through the focal point.

currentSpanX Number

The average X distance between each of the pointers forming the gesture in progress through the focal point.

currentSpanY Number

The average Y distance between each of the pointers forming the gesture in progress through the focal point.

previousSpan Number

The previous average distance between each of the pointers forming the gesture in progress through the focal point.

previousSpanX Number

The previous average X distance between each of the pointers forming the gesture in progress through the focal point.

previousSpanY Number

The previous average Y distance between each of the pointers forming the gesture in progress through the focal point.

focusX Number

The X coordinate of the current gesture's focal point.

focusY Number

The Y coordinate of the current gesture's focal point.

inProgress Boolean

Returns true if a scale gesture is in progress, false otherwise.

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.

# postlayout

Availability
2.0.0
2.0.0
9.2.0

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.

# singletap

Availability
0.9
0.9
9.2.0

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

Properties

Name Type Description
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.

obscured Boolean

Returns true if the single tap passed through an overlapping window belonging to another app.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

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.

# swipe

Availability
0.9
0.9
9.2.0

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

Properties

Name Type Description
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.

obscured Boolean

Returns true if the swipe passed through an overlapping window belonging to another app.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

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.

# touchcancel

Availability
0.9
0.9
9.2.0

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

Name Type Description
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.

obscured Boolean

Returns true if the touch passed through an overlapping window belonging to another app.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

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.

# touchend

Availability
0.9
0.9
9.2.0

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

Name Type Description
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.

obscured Boolean

Returns true if the touch passed through an overlapping window belonging to another app.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

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.

# touchmove

Availability
0.9
0.9
9.2.0

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

Name Type Description
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.

obscured Boolean

Returns true if the touch passed through an overlapping window belonging to another app.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

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.

# touchstart

Availability
0.9
0.9
9.2.0

Fired as soon as the device detects a touch gesture.

Properties

Name Type Description
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.

obscured Boolean

Returns true if the touch passed through an overlapping window belonging to another app.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

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.

# twofingertap

Availability
3.0.0
0.9
9.2.0

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

Properties

Name Type Description
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.

obscured Boolean

Returns true if the tap passed through an overlapping window belonging to another app.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

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.

# androidback

Availability
3.0.0

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.

# androidcamera

Availability
3.0.0

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

# androidfocus

Availability
3.0.0

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

# androidsearch

Availability
3.0.0

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

# androidvoldown

Availability
3.0.0

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

# androidvolup

Availability
3.0.0

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

# blur

Availability
0.9
0.9
9.2.0

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 pause event. See Titanium.App for more information on the iOS application lifecycle.

# close

Availability
0.9
0.9
9.2.0

Fired when the window is closed.

# open

Availability
0.9
0.9
9.2.0

Fired when the window is opened.

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

Contents