Titanium.UI.TabGroup
> Titanium.UI.TabGroup

A tabbed group of windows.

A tab group can contain one or more Tab objects, each of which has an associated tab control that is used to bring it into focus.

Use the Titanium.UI.createTabGroup method or <TabGroup> Alloy element to create a tab group that, in turn, contains one or more <Tab> elements.

You can add tabs to the group using addTab, and programmatically switch to a specific tab using setActiveTab.

Platform Implementation Notes

When using a tab group, note the following differences between platforms:

  • The tab group controls are positioned at the top of the display on Android and at the bottom on iOS.

  • On Android, only one tab group may exist at one time. A tab group may be closed to allow a new one to be opened later, but the root of the application must be a heavyweight window to prevent it exiting. Tabs cannot be removed from the tab group once added, and tabs cannot be reordered.

  • On iOS, more than one tab group may exist, and may be opened and closed as required. Each tab can contain a stack of windows, and the user can switch between them by tapping the tab's associated control. Tabs can be removed, and the user may (optionally) be allowed to reorder tabs.

  • On iOS, it is also possible to add tabs by updating the tabs property, and to switch active tabs by setting the active property on one of the tabs to true. Since these mechanisms are platform-specific, it is recommended that you use addTab and setActiveTab instead.

  • If you use the iOS-specific mechanisms, it is possible to add multiple active tabs to a tab group. In this case, the result of which tab is initially selected is undefined.

Further Reading

If using tab groups on iOS, see iOS UI Element Usage Guidelines.

Examples

Alloy XML Markup

Default Titanium project as an Alloy view.

    <Alloy>
        <TabGroup backgroundColor="white" >
            <Tab id="tab1" title="Tab 1" icon="KS_nav_views.png">
                <Window id="win1" title="Tab 1">
                   <Label id="label1" color="#999">I am Window 1</Label>
                </Window>
            </Tab>
            <Tab id="tab2" title="Tab 2" icon="KS_nav_views.png">
                <Window id="win2" title="Tab 2">
                    <Label id="label2" color="#999">I am Window 2</Label>
                </Window>
            </Tab>
            <!-- Use the Require tag to include external Ti.UI.Tab views -->
        </TabGroup>
    </Alloy>

Classic Titanium Example

Simple two-tabbed app.

var win1 = Ti.UI.createWindow({
    backgroundColor: 'blue',
    title: 'Blue'
});
win1.add(Ti.UI.createLabel({text: 'I am a blue window.'}));

var win2 = Ti.UI.createWindow({
    backgroundColor: 'red',
    title: 'Red'
});
win2.add(Ti.UI.createLabel({text: 'I am a red window.'}));

var tab1 = Ti.UI.createTab({
    window: win1,
    title: 'Blue'
}),
tab2 = Ti.UI.createTab({
    window: win2,
    title: 'Red'
}),
tabGroup = Ti.UI.createTabGroup({
    tabs: [tab1, tab2]
});
tabGroup.open();
  • 0.9
  • 0.9
  • 0.9
Defined By

Properties

Titanium.UI.TabGroup
activeTab : Titanium.UI.Tab

Active tab.

Active tab.

Titanium.UI.TabGroup
: String
Default background image for the active tab. ...

Default background image for the active tab.

Requires: iOS 5.0 and later

  • 3.1.0
  • 3.1.0
Titanium.UI.TabGroup
: String
Color applied to active tabs icons, as a color name or hex triplet, where the tab's activeIcon was not defined. ...

Color applied to active tabs icons, as a color name or hex triplet, where the tab's activeIcon was not defined.

Requires: iOS 5.0 and later

For information about color values, see the "Colors" section of Titanium.UI. On iOS, requires iOS 5.0 or later; ignored on earlier versions.

  • 3.1.0
  • 3.1.0
Titanium.UI.TabGroup
activity : Titanium.Android.Activityreadonly

Reference to the Android Activity object associated with this tab group.

Reference to the Android Activity object associated with this tab group.

An Activity object is not created until the tab group opens. Before the tab group opens, activity refers to an empty JavaScript object. You can set properties on this object but cannot invoke any Activity methods on it. Once the tab group opens, 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.

Prior to Release 3.4.0, you can only set properties on the activity after the tab group opens.

  • 3.0.0
Titanium.UI.TabGroup
: Boolean
Allow the user to reorder tabs in the tab group using the Edit button on the More tab. ...

Allow the user to reorder tabs in the tab group using the Edit button on the More tab.

Set to false to prevent tab reordering.

Default: true

  • 0.9
  • 0.9
apiName : Stringreadonly

The name of the API that this proxy corresponds to.

The name of the API that this proxy corresponds to.

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

  • 3.2.0
  • 3.2.0
  • 3.2.0
Titanium.UI.TabGroup
barColor : String

Default navigation bar color (typically for the More tab), as a color name or hex triplet.

Default navigation bar color (typically for the More tab), as a color name or hex triplet.

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

A value of transparent results in a semi-opaque black bar style.

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

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

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

Default: true

  • 3.0.0
  • 3.0.0
  • 3.0.0

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

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.

View's clipping behavior. ...

View's clipping behavior.

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

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

  • 3.3.0
  • 3.3.0
Titanium.UI.TabGroup
editButtonTitle : String

Title for the edit button on the More tab.

Title for the edit button on the More tab.

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

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

Requires: Android 5 and later

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

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

  • 5.0.0
Titanium.UI.TabGroup
: Boolean
Boolean value indicating if the application should exit when closing the tab group, whether via Android back button o...

Boolean value indicating if the application should exit when closing the tab group, whether via Android back button or the close method.

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

Default: True if tab group is opened on top of the root activity. False otherwise.

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

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

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

This API can be assigned the following constants:

Default: Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE

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

Determines whether to keep the device screen on.

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

Default: false

  • 0.9

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

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

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

  • 3.6.0
Titanium.UI.TabGroup
: String
The tintColor to apply to the navigation bar (typically for the More tab). ...

The tintColor to apply to the navigation bar (typically for the More tab).

Requires: iOS 7.0 and later

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

Default:

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

When on, animate call overrides current animation if applicable.

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

Default: undefined but behaves as false

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

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

Requires: iOS 9.0 and later

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

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

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

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

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

  • 3.3.0
  • 3.3.0

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

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

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

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

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

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

  • 2.0.0
  • 2.0.0
  • 2.0.0

Clockwise 2D rotation of the view in degrees.

Clockwise 2D rotation of the view in degrees.

Translation values are applied to the static post layout value.

  • 5.4.0

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

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

Translation values are applied to the static post layout value.

  • 5.4.0

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

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

Translation values are applied to the static post layout value.

  • 5.4.0

Scaling of the view in x-axis in pixels.

Scaling of the view in x-axis in pixels.

Translation values are applied to the static post layout value.

  • 5.4.0

Scaling of the view in y-axis in pixels.

Scaling of the view in y-axis in pixels.

Translation values are applied to the static post layout value.

  • 5.4.0
Titanium.UI.TabGroup
: String
Image of the shadow placed between the tab bar and the content area. ...

Image of the shadow placed between the tab bar and the content area.

Requires: iOS 6.0 and later

On iOS, requires iOS 6.0 or later; ignored on earlier versions. TabsBackgroundImage must also be set in order for this to take effect.

  • 3.1.0
  • 3.1.0

The size of the view in system units.

The size of the view in system units.

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

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

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

Titanium.UI.TabGroup
: Boolean
Boolean value indicating if changing pages by tab clicks is animated. ...

Boolean value indicating if changing pages by tab clicks is animated.

If true, when clicking the tab the page transition is animated, false otherwise.

Default: true

  • 3.6.0
Titanium.UI.TabGroup
: Boolean
Boolean value indicating if tab navigation can be done by swipes, in addition to tab clicks. ...

Boolean value indicating if tab navigation can be done by swipes, in addition to tab clicks.

On Android, the tabs may be selected by swipes, in addition to clicks. This property may be set at tab group creation, or any time later as long as the tab navigation is not disabled.

Default: true

  • 3.6.0
Titanium.UI.TabGroup
tabs : Titanium.UI.Tab[]

Tabs managed by the tab group.

Tabs managed by the tab group.

Titanium.UI.TabGroup
tabsBackgroundColor : String

Default background color for inactive tabs, as a color name or hex triplet.

Default background color for inactive tabs, as a color name or hex triplet.

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

A tab's backgroundColor property takes precedence if set.

On iOS 5.0 or later, this property applies to all states and tabs, not just inactive tabs. Furthermore, the inactive tab icons without activeIcon will be tinted this color; property is ignored on earlier versions of iOS.

  • 3.0.0
  • 3.0.0
  • 3.0.0
Titanium.UI.TabGroup
: String
Default background image for tabs. ...

Default background image for tabs.

Requires: iOS 5.0 and later

On iOS, requires iOS 5.0 or later; ignored on earlier versions.

  • 3.1.0
  • 3.1.0
Titanium.UI.TabGroup
tabsBackgroundSelectedColor : String

Default background selected color for tabs, as a color name or hex triplet.

Default background selected color for tabs, as a color name or hex triplet.

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

A tab's backgroundSelectedColor property takes precedence if set.

  • 3.0.0
Titanium.UI.TabGroup
: String
The tintColor to apply to the tabs. ...

The tintColor to apply to the tabs.

This property is a direct correspondant of the tintColor property of UITabBar on iOS. This effects the title and icons rendered in the active tab. When not specified the active icons are tinted with a bright blue.

Default:

  • 3.1.3
  • 3.1.3
Titanium.UI.TabGroup
: Boolean
A Boolean value that indicates whether the tab bar is translucent. ...

A Boolean value that indicates whether the tab bar is translucent.

When the value of this property is true, the tab group adds a translucent effect to its background image or tint color. When translucency is enabled, part of the tab bar's underlying content is able to show through, although the amount that shows through depends on the rest of the tab bar configuration. For example, a background image can wholly or partially obscure the background content. Setting this property to NO causes the tab bar to render its bar tint color or background image on top of an opaque backdrop.

The default value of this property is dependent on the configuration of the tab bar: The default value is true when the tab bar does not have a custom background image. The default value is true when a custom background image contains any transparency - that is, at least one pixel has an alpha value of less than 1.0. The default value is false when the custom background image is completely opaque - that is, all pixels have an alpha value of 1.0.

Default: true

  • 6.2.0
  • 6.2.0
The view's tintColor. ...

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

Requires: iOS 7.0 and later

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

Default:

  • 3.1.3
  • 3.1.3
Titanium.UI.TabGroup
title : String

Title for this tabGroup.

Title for this tabGroup.

  • 3.3.0

Title text attributes of the window to be applied on the More tab.

Title text attributes of the window to be applied on the More tab.

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

  • 3.3.0
  • 3.3.0
Determines whether view should receive touch events. ...

Determines whether view should receive touch events.

If false, will forward the events to peers.

Default: true

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

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

Requires: Android 5.0 and later

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

Default: false

  • 6.1.0
Optional touch feedback ripple color. ...

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

Requires: Android 5.0 and later

Default: Theme provided color.

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

A name to identify this view in activity transition.

Requires: Android 5 and later

Name should be unique in the View hierarchy.

  • 5.0.2

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

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

Translation values are applied to the static post layout value.

  • 5.0.0

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

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

Translation values are applied to the static post layout value.

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

Depth of the view relative to its elevation in pixels.

Requires: Android 5 and later

Translation values are applied to the static post layout value.

  • 5.0.0
Titanium.UI.TabGroup
: Boolean
Boolean value indicating if the nav bar (typically for the More tab), is translucent. ...

Boolean value indicating if the nav bar (typically for the More tab), is translucent.

Default: true on iOS7 and above, false otherwise.

  • 3.3.0
  • 3.3.0
Titanium.UI.TabGroup
: String
Unselected items in this tab group will be tinted with this color. ...

Unselected items in this tab group will be tinted with this color. Setting this value to null indicates that the tab group should use its default value instead.

Requires: iOS 10.0 and later

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

  • 6.1.0
  • 6.1.0
Determines the color of the shadow. ...

Determines the color of the shadow.

Default: Undefined. Behaves as if transparent.

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

Determines the offset for the shadow of the view.

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

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

Determines the blur radius used to create the shadow.

Default: Undefined. Behaves as if set to 3.

  • 3.3.0
  • 3.3.0
Determines whether the view is visible. ...

Determines whether the view is visible.

Default: true

Titanium.UI.TabGroup
windowSoftInputMode : NumberCreation-Only

Determines how the tab group is treated when a soft input method (such as a virtual keyboard) is displayed.

Determines how the tab group is treated when a soft input method (such as a virtual keyboard) is displayed.

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

This API can be assigned the following constants:

  • 0.9
Defined By

Methods

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

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Titanium.UI.TabGroup
( tab )
Adds a tab to the tab group. ...

Adds a tab to the tab group.

Parameters

Returns

  • void
( animation, callback )
Animates this view. ...

Animates this view.

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

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

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

Parameters

Returns

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

Applies the properties to the proxy.

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

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Titanium.UI.TabGroup
( )
Closes the tab group and removes it from the UI. ...

Closes the tab group and removes it from the UI.

Returns

  • void
( point, destinationView ) : Point
Translates a point from this view's coordinate system to another view's coordinate system. ...

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

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

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

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

  • 1.8
  • 1.8
  • 1.8

Parameters

  • point : Point

    A point in this view's coordinate system.

    If this argument is missing an x or y property, or the properties can not be converted into numbers, an exception will be raised.

  • destinationView : Titanium.UI.View

    View that specifies the destination coordinate system to convert to. If this argument is not a view, an exception will be raised.

Returns

Titanium.UI.TabGroup
( disable )
Disable (or re-enable) tab navigation. ...

Disable (or re-enable) tab navigation. If tab navigation is disabled, the tabs are hidden and the last selected tab window is shown.

  • 3.6.0

Parameters

  • disable : Boolean

    True to disable tab navigation, false to re-enable the tabs.

Returns

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

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

deprecated since 3.0.0

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

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

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

  • 2.0.0
  • 2.0.0
  • 2.0.0

Returns

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

Fires a synthesized event to any registered listeners.

Parameters

  • name : String

    Name of the event.

  • event : Dictionary

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

Returns

  • void
Titanium.UI.TabGroup
( ) : Titanium.UI.Tab
Gets the value of the activeTab property. ...

Gets the value of the activeTab property.

Returns

Titanium.UI.TabGroup
( ) : String
Gets the value of the activeTabBackgroundImage property. ...

Gets the value of the activeTabBackgroundImage property.

  • 3.1.0
  • 3.1.0

Returns

  • String
Titanium.UI.TabGroup
( ) : String
Gets the value of the activeTabIconTint property. ...

Gets the value of the activeTabIconTint property.

  • 3.1.0
  • 3.1.0

Returns

  • String
Titanium.UI.TabGroup
( ) : Titanium.Android.Activity
Gets the value of the activity property. ...

Gets the value of the activity property.

  • 3.0.0

Returns

Titanium.UI.TabGroup
( ) : Boolean
Gets the value of the allowUserCustomization property. ...

Gets the value of the allowUserCustomization property.

  • 0.9
  • 0.9

Returns

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

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Titanium.UI.TabGroup
( ) : String
Gets the value of the barColor property. ...

Gets the value of the barColor property.

  • 0.9
  • 0.9

Returns

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

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

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

Gets the value of the center property.

Returns

Gets the value of the clipMode property. ...

Gets the value of the clipMode property.

  • 3.3.0
  • 3.3.0

Returns

  • Number
Titanium.UI.TabGroup
( ) : String
Gets the value of the editButtonTitle property. ...

Gets the value of the editButtonTitle property.

  • 0.9
  • 0.9

Returns

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

Gets the value of the elevation property.

  • 5.0.0

Returns

  • Number
Titanium.UI.TabGroup
( ) : Boolean
Gets the value of the exitOnClose property. ...

Gets the value of the exitOnClose property.

  • 0.9

Returns

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

Gets the value of the hiddenBehavior property.

  • 6.1.0

Returns

  • Number
Gets the value of the keepScreenOn property. ...

Gets the value of the keepScreenOn property.

  • 0.9

Returns

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

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.UI.TabGroup
( ) : String
Gets the value of the navTintColor property. ...

Gets the value of the navTintColor property.

  • 3.3.0
  • 3.3.0

Returns

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

Gets the value of the overrideCurrentAnimation property.

  • 3.3.0

Returns

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

Gets the value of the previewContext property.

  • 5.1.0

Returns

Gets the value of the pullBackgroundColor property. ...

Gets the value of the pullBackgroundColor property.

  • 3.3.0
  • 3.3.0

Returns

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

Gets the value of the rect property.

  • 2.0.0
  • 2.0.0
  • 2.0.0

Returns

Gets the value of the rotation property. ...

Gets the value of the rotation property.

  • 5.4.0

Returns

  • Number
Gets the value of the rotationX property. ...

Gets the value of the rotationX property.

  • 5.4.0

Returns

  • Number
Gets the value of the rotationY property. ...

Gets the value of the rotationY property.

  • 5.4.0

Returns

  • Number
Gets the value of the scaleX property. ...

Gets the value of the scaleX property.

  • 5.4.0

Returns

  • Number
Gets the value of the scaleY property. ...

Gets the value of the scaleY property.

  • 5.4.0

Returns

  • Number
Titanium.UI.TabGroup
( ) : String
Gets the value of the shadowImage property. ...

Gets the value of the shadowImage property.

  • 3.1.0
  • 3.1.0

Returns

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

Gets the value of the size property.

Returns

Titanium.UI.TabGroup
( ) : Boolean
Gets the value of the smoothScrollOnTabClick property. ...

Gets the value of the smoothScrollOnTabClick property.

  • 3.6.0

Returns

  • Boolean
Titanium.UI.TabGroup
( ) : Boolean
Gets the value of the swipeable property. ...

Gets the value of the swipeable property.

  • 3.6.0

Returns

  • Boolean
Titanium.UI.TabGroup
( ) : Titanium.UI.Tab[]
Gets the value of the tabs property. ...

Gets the value of the tabs property.

Returns

Titanium.UI.TabGroup
( ) : String
Gets the value of the tabsBackgroundColor property. ...

Gets the value of the tabsBackgroundColor property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • String
Titanium.UI.TabGroup
( ) : String
Gets the value of the tabsBackgroundImage property. ...

Gets the value of the tabsBackgroundImage property.

  • 3.1.0
  • 3.1.0

Returns

  • String
Titanium.UI.TabGroup
( ) : String
Gets the value of the tabsBackgroundSelectedColor property. ...

Gets the value of the tabsBackgroundSelectedColor property.

  • 3.0.0

Returns

  • String
Titanium.UI.TabGroup
( ) : String
Gets the value of the tabsTintColor property. ...

Gets the value of the tabsTintColor property.

  • 3.1.3
  • 3.1.3

Returns

  • String
Titanium.UI.TabGroup
( ) : Boolean
Gets the value of the tabsTranslucent property. ...

Gets the value of the tabsTranslucent property.

  • 6.2.0
  • 6.2.0

Returns

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

Gets the value of the tintColor property.

  • 3.1.3
  • 3.1.3

Returns

  • String
Titanium.UI.TabGroup
( ) : String
Gets the value of the title property. ...

Gets the value of the title property.

  • 3.3.0

Returns

  • String
Titanium.UI.TabGroup
( ) : titleAttributesParams
Gets the value of the titleAttributes property. ...

Gets the value of the titleAttributes property.

  • 3.3.0
  • 3.3.0

Returns

Gets the value of the touchEnabled property. ...

Gets the value of the touchEnabled property.

Returns

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

Gets the value of the touchFeedback property.

  • 6.1.0

Returns

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

Gets the value of the touchFeedbackColor property.

  • 6.1.0

Returns

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

Gets the value of the transitionName property.

  • 5.0.2

Returns

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

Gets the value of the translationX property.

  • 5.0.0

Returns

  • Number
Gets the value of the translationY property. ...

Gets the value of the translationY property.

  • 5.0.0

Returns

  • Number
Gets the value of the translationZ property. ...

Gets the value of the translationZ property.

  • 5.0.0

Returns

  • Number
Titanium.UI.TabGroup
( ) : Boolean
Gets the value of the translucent property. ...

Gets the value of the translucent property.

  • 3.3.0
  • 3.3.0

Returns

  • Boolean
Titanium.UI.TabGroup
( ) : String
Gets the value of the unselectedItemTintColor property. ...

Gets the value of the unselectedItemTintColor property.

  • 6.1.0
  • 6.1.0

Returns

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

Returns the matching view of a given view ID.

  • 6.1.0
  • 6.1.0
  • 6.1.0

Parameters

  • id : String

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

Returns

Gets the value of the viewShadowColor property. ...

Gets the value of the viewShadowColor property.

  • 3.3.0
  • 3.3.0

Returns

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

Gets the value of the viewShadowOffset property.

  • 3.3.0
  • 3.3.0

Returns

Gets the value of the viewShadowRadius property. ...

Gets the value of the viewShadowRadius property.

  • 3.3.0
  • 3.3.0

Returns

  • Number
Gets the value of the visible property. ...

Gets the value of the visible property.

Returns

  • Boolean
Titanium.UI.TabGroup
( ) : Number
Gets the value of the windowSoftInputMode property. ...

Gets the value of the windowSoftInputMode property.

  • 0.9

Returns

  • Number
Hides this view. ...

Hides this view.

Parameters

  • options : AnimationOption (optional)

    Animation options for Android. Since Release 5.1.0.

Returns

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

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

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

  • 3.3.0
  • 3.3.0
  • 3.3.0

Parameters

  • params : Dictionary

    Pass an object with the following key-value pairs:

    • view (Titanium.UI.View): View to insert
    • position (Number): Position in the children array to insert the view. If omitted, inserts the view to the end of the array.

Returns

  • void
Titanium.UI.TabGroup
( )
Opens the tab group and makes it visible. ...

Opens the tab group and makes it visible.

Returns

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

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

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

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

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

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

window.removeEventListener('click', listener);

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

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

Returns

  • void
Titanium.UI.TabGroup
( tab )
Removes a tab from the tab group. ...

Removes a tab from the tab group.

  • 0.9
  • 0.9

Parameters

Returns

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

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

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

  • 3.3.0
  • 3.3.0
  • 3.3.0

Parameters

  • params : Dictionary

    Pass an object with the following key-value pairs:

    • view (Titanium.UI.View): View to insert
    • position (Number): Position in the children array of the view elment to replace.

Returns

  • void
Titanium.UI.TabGroup
( activeTab )
Sets the value of the activeTab property. ...

Sets the value of the activeTab property.

Parameters

Returns

  • void
Titanium.UI.TabGroup
( activeTabBackgroundImage )
Sets the value of the activeTabBackgroundImage property. ...

Sets the value of the activeTabBackgroundImage property.

  • 3.1.0
  • 3.1.0

Parameters

  • activeTabBackgroundImage : String

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( activeTabIconTint )
Sets the value of the activeTabIconTint property. ...

Sets the value of the activeTabIconTint property.

  • 3.1.0
  • 3.1.0

Parameters

  • activeTabIconTint : String

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( allowUserCustomization )
Sets the value of the allowUserCustomization property. ...

Sets the value of the allowUserCustomization property.

  • 0.9
  • 0.9

Parameters

  • allowUserCustomization : Boolean

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( barColor )
Sets the value of the barColor property. ...

Sets the value of the barColor property.

  • 0.9
  • 0.9

Parameters

  • barColor : String

    New value for the property.

Returns

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

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

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

Sets the value of the center property.

Parameters

  • center : Point

    New value for the property.

Returns

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

Sets the value of the clipMode property.

  • 3.3.0
  • 3.3.0

Parameters

  • clipMode : Number

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( editButtonTitle )
Sets the value of the editButtonTitle property. ...

Sets the value of the editButtonTitle property.

  • 0.9
  • 0.9

Parameters

  • editButtonTitle : String

    New value for the property.

Returns

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

Sets the value of the elevation property.

  • 5.0.0

Parameters

  • elevation : Number

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( exitOnClose )
Sets the value of the exitOnClose property. ...

Sets the value of the exitOnClose property.

  • 0.9

Parameters

  • exitOnClose : Boolean

    New value for the property.

Returns

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

Sets the value of the hiddenBehavior property.

  • 6.1.0

Parameters

  • hiddenBehavior : Number

    New value for the property.

Returns

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

Sets the value of the keepScreenOn property.

  • 0.9

Parameters

  • keepScreenOn : Boolean

    New value for the property.

Returns

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

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Titanium.UI.TabGroup
( navTintColor )
Sets the value of the navTintColor property. ...

Sets the value of the navTintColor property.

  • 3.3.0
  • 3.3.0

Parameters

  • navTintColor : String

    New value for the property.

Returns

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

Sets the value of the overrideCurrentAnimation property.

  • 3.3.0

Parameters

  • overrideCurrentAnimation : Boolean

    New value for the property.

Returns

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

Sets the value of the previewContext property.

  • 5.1.0

Parameters

Returns

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

Sets the value of the pullBackgroundColor property.

  • 3.3.0
  • 3.3.0

Parameters

  • pullBackgroundColor : String

    New value for the property.

Returns

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

Sets the value of the rotation property.

  • 5.4.0

Parameters

  • rotation : Number

    New value for the property.

Returns

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

Sets the value of the rotationX property.

  • 5.4.0

Parameters

  • rotationX : Number

    New value for the property.

Returns

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

Sets the value of the rotationY property.

  • 5.4.0

Parameters

  • rotationY : Number

    New value for the property.

Returns

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

Sets the value of the scaleX property.

  • 5.4.0

Parameters

  • scaleX : Number

    New value for the property.

Returns

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

Sets the value of the scaleY property.

  • 5.4.0

Parameters

  • scaleY : Number

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( shadowImage )
Sets the value of the shadowImage property. ...

Sets the value of the shadowImage property.

  • 3.1.0
  • 3.1.0

Parameters

  • shadowImage : String

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( smoothScrollOnTabClick )
Sets the value of the smoothScrollOnTabClick property. ...

Sets the value of the smoothScrollOnTabClick property.

  • 3.6.0

Parameters

  • smoothScrollOnTabClick : Boolean

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( swipeable )
Sets the value of the swipeable property. ...

Sets the value of the swipeable property.

  • 3.6.0

Parameters

  • swipeable : Boolean

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( tabs )
Sets the value of the tabs property. ...

Sets the value of the tabs property.

Parameters

Returns

  • void
Titanium.UI.TabGroup
( tabsBackgroundColor )
Sets the value of the tabsBackgroundColor property. ...

Sets the value of the tabsBackgroundColor property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • tabsBackgroundColor : String

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( tabsBackgroundImage )
Sets the value of the tabsBackgroundImage property. ...

Sets the value of the tabsBackgroundImage property.

  • 3.1.0
  • 3.1.0

Parameters

  • tabsBackgroundImage : String

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( tabsBackgroundSelectedColor )
Sets the value of the tabsBackgroundSelectedColor property. ...

Sets the value of the tabsBackgroundSelectedColor property.

  • 3.0.0

Parameters

  • tabsBackgroundSelectedColor : String

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( tabsTintColor )
Sets the value of the tabsTintColor property. ...

Sets the value of the tabsTintColor property.

  • 3.1.3
  • 3.1.3

Parameters

  • tabsTintColor : String

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( tabsTranslucent )
Sets the value of the tabsTranslucent property. ...

Sets the value of the tabsTranslucent property.

  • 6.2.0
  • 6.2.0

Parameters

  • tabsTranslucent : Boolean

    New value for the property.

Returns

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

Sets the value of the tintColor property.

  • 3.1.3
  • 3.1.3

Parameters

  • tintColor : String

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( title )
Sets the value of the title property. ...

Sets the value of the title property.

  • 3.3.0

Parameters

  • title : String

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( titleAttributes )
Sets the value of the titleAttributes property. ...

Sets the value of the titleAttributes property.

  • 3.3.0
  • 3.3.0

Parameters

Returns

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

Sets the value of the touchEnabled property.

Parameters

  • touchEnabled : Boolean

    New value for the property.

Returns

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

Sets the value of the touchFeedback property.

  • 6.1.0

Parameters

  • touchFeedback : Boolean

    New value for the property.

Returns

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

Sets the value of the touchFeedbackColor property.

  • 6.1.0

Parameters

  • touchFeedbackColor : String

    New value for the property.

Returns

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

Sets the value of the transitionName property.

  • 5.0.2

Parameters

  • transitionName : String

    New value for the property.

Returns

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

Sets the value of the translationX property.

  • 5.0.0

Parameters

  • translationX : Number

    New value for the property.

Returns

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

Sets the value of the translationY property.

  • 5.0.0

Parameters

  • translationY : Number

    New value for the property.

Returns

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

Sets the value of the translationZ property.

  • 5.0.0

Parameters

  • translationZ : Number

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( translucent )
Sets the value of the translucent property. ...

Sets the value of the translucent property.

  • 3.3.0
  • 3.3.0

Parameters

  • translucent : Boolean

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( unselectedItemTintColor )
Sets the value of the unselectedItemTintColor property. ...

Sets the value of the unselectedItemTintColor property.

  • 6.1.0
  • 6.1.0

Parameters

  • unselectedItemTintColor : String

    New value for the property.

Returns

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

Sets the value of the viewShadowColor property.

  • 3.3.0
  • 3.3.0

Parameters

  • viewShadowColor : String

    New value for the property.

Returns

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

Sets the value of the viewShadowOffset property.

  • 3.3.0
  • 3.3.0

Parameters

  • viewShadowOffset : Point

    New value for the property.

Returns

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

Sets the value of the viewShadowRadius property.

  • 3.3.0
  • 3.3.0

Parameters

  • viewShadowRadius : Number

    New value for the property.

Returns

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

Sets the value of the visible property.

Parameters

  • visible : Boolean

    New value for the property.

Returns

  • void
Titanium.UI.TabGroup
( windowSoftInputMode )
Sets the value of the windowSoftInputMode property. ...

Sets the value of the windowSoftInputMode property.

  • 0.9

Parameters

  • windowSoftInputMode : Number

    New value for the property.

Returns

  • void
Makes this view visible. ...

Makes this view visible.

Parameters

  • options : AnimationOption (optional)

    Animation options for Android. Since Release 5.1.0.

Returns

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

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

deprecated since 3.0.0

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

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

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

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

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

See also: updateLayout, finishLayout, postlayout event.

  • 2.0.0
  • 2.0.0
  • 2.0.0

Returns

  • void
( [callback], [honorScaleFactor] ) : Titanium.Blob
Returns an image of the rendered view, as a Blob. ...

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

The honorScaleFactor method is only supported on iOS.

Parameters

  • callback : Callback<Titanium.Blob> (optional)

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

  • honorScaleFactor : Boolean (optional)

    Determines whether the image is scaled based on scale factor of main screen. (iOS only)

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

Returns

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

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

deprecated since 3.0.0

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

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

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

This is equivalent to the following:

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

See also: startLayout, finishLayout, postlayout event.

  • 2.0.0
  • 2.0.0
  • 2.0.0

Parameters

  • params : Dictionary

    Layout properties to be updated.

Returns

  • void
Defined By

Events

Titanium.UI.TabGroup
Fired when the back button is pressed by the user. ...

Fired when the back button is pressed by the user.

This event is fired when the current tab group'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 tab group.

  • 3.0.0

Properties

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Titanium.UI.TabGroup
Fired when the Camera button is released. ...

Fired when the Camera button is released.

Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener.

  • 3.0.0

Properties

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Titanium.UI.TabGroup
Fired when the Camera button is half-pressed then released. ...

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

Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener.

  • 3.0.0

Properties

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Titanium.UI.TabGroup
Fired when the Search button is released. ...

Fired when the Search button is released.

Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener.

  • 3.0.0

Properties

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Titanium.UI.TabGroup
Fired when the volume down button is released. ...

Fired when the volume down button is released.

Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener.

  • 3.0.0

Properties

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Titanium.UI.TabGroup
Fired when the volume up button is released. ...

Fired when the volume up button is released.

Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener.

  • 3.0.0

Properties

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Titanium.UI.TabGroup
Fired when this tab group loses focus. ...

Fired when this tab group loses focus. On Android, fired when a tab in this tab group loses focus.

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

Properties

  • index : Number

    Index of the current active tab. On iOS, a value of undefined indicates that the More tab was the active tab.

  • previousIndex : Number

    Index of the previous active tab. On iOS, a value of undefined indicates that the More tab was the previous tab.

  • tab : Titanium.UI.Tab

    Active tab.

  • previousTab : Titanium.UI.Tab

    Previous active tab. On iOS, a value of undefined indicates that the More tab was the previous tab.

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

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

Fired when the device detects a click against the view.

There is a subtle difference between singletap and click events.

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

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

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

Properties

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Titanium.UI.TabGroup
Fired when the tab group is closed. ...

Fired when the tab group is closed.

  • 0.9
  • 0.9

Properties

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

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

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

Properties

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

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

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

Properties

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Titanium.UI.TabGroup
Fired when this tab group gains focus. ...

Fired when this tab group gains focus. On Android, fired when a tab in this tab group gains focus.

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

Properties

  • index : Number

    Index of the current active tab.

  • previousIndex : Number

    Index of the previous active tab.

  • tab : Titanium.UI.Tab

    Active tab.

  • previousTab : Titanium.UI.Tab

    Previous active tab.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  

Overrides: Titanium.UI.View.focus

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

Fired when a hardware key is pressed in the view.

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

  • 3.1.0

Properties

  • keyCode : Number

    The code for the physical key that was pressed. For more details, see KeyEvent. This API is experimental and subject to change.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

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

Fired when the device detects a long click.

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

The event occurs before the finger/button is lifted.

A longpress and a longclick can occur together.

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

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

  • 0.9

Properties

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

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

Fired when the device detects a long press.

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

The event occurs before the finger is lifted.

A longpress and a longclick can occur together.

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

Properties

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Titanium.UI.TabGroup
Fired when the tab group is opened. ...

Fired when the tab group is opened.

Properties

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

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

Fired when the device detects a pinch gesture.

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

  • 1.8.0
  • 1.8.0

Properties

  • scale : Number

    The scale factor relative to the points of the two touches in screen coordinates.

  • velocity : Number

    The velocity of the pinch in scale factor per second.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Fired when a layout cycle is finished. ...

Fired when a layout cycle is finished.

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

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

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

  • 2.0.0
  • 2.0.0
  • 2.0.0

Properties

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Titanium.UI.TabGroup
deprecated
Fired when a tab is selected. ...

Fired when a tab is selected.

deprecated since 5.2.0

Use <Titanium.UI.Tab.focus> instead.

  • 5.1.0
  • 5.1.0

Properties

  • index : Number

    Index of the current active tab.

  • previousIndex : Number

    Index of the previous active tab.

  • tab : Titanium.UI.Tab

    Active tab.

  • previousTab : Titanium.UI.Tab

    Previous active tab.

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

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

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

Properties

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

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

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

Properties

  • direction : String

    Direction of the swipe--either 'left', 'right', 'up', or 'down'.

  • x : Number

    X coordinate of the event's endpoint from the source view's coordinate system.

  • y : Number

    Y coordinate of the event's endpoint from the source view's coordinate system.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

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

Fired when a touch event is interrupted by the device.

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

Properties

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

  • force : Number

    The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.

  • size : Number

    The current size of the touch area. Note: This property is only available on some Android devices.

  • maximumPossibleForce : Number

    Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.

  • altitudeAngle : Number

    A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.

  • timestamp : Number

    The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.

  • azimuthUnitVectorInViewX : Number

    The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.

  • azimuthUnitVectorInViewY : Number

    The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Fired when a touch event is completed. ...

Fired when a touch event is completed.

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

Properties

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

  • force : Number

    The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.

  • size : Number

    The current size of the touch area. Note: This property is only available on some Android devices.

  • maximumPossibleForce : Number

    Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.

  • altitudeAngle : Number

    A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.

  • timestamp : Number

    The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.

  • azimuthUnitVectorInViewX : Number

    The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.

  • azimuthUnitVectorInViewY : Number

    The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Penciland are 9.1 or later.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

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

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

Event coordinates are always relative to the view in which the initial touch occurred

Properties

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

  • force : Number

    The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.

  • size : Number

    The current size of the touch area. Note: This property is only available on some Android devices.

  • maximumPossibleForce : Number

    Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.

  • altitudeAngle : Number

    A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.

  • timestamp : Number

    The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.

  • azimuthUnitVectorInViewX : Number

    The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.

  • azimuthUnitVectorInViewY : Number

    The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

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

Fired as soon as the device detects a touch gesture.

Properties

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

  • force : Number

    The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.

  • size : Number

    The current size of the touch area. Note: This property is only available on some Android devices.

  • maximumPossibleForce : Number

    Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.

  • altitudeAngle : Number

    A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.

  • timestamp : Number

    The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.

  • azimuthUnitVectorInViewX : Number

    The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.

  • azimuthUnitVectorInViewY : Number

    The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

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

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

  • 3.0.0
  • 0.9
  • 0.9

Properties

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

  • source : Object

    Source object that fired the event.

    •  
    •  
    •  
  • type : String

    Name of the event fired.

    •  
    •  
    •  
  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
Titanium.UI.TabGroup
deprecated
Fired when a tab is unselected. ...

Fired when a tab is unselected.

deprecated since 5.2.0

Use <Titanium.UI.Tab.blur> instead.

  • 5.1.0
  • 5.1.0

Properties

  • index : Number

    Index of the current active tab. On iOS, a value of undefined indicates that the More tab was the active tab.

  • previousIndex : Number

    Index of the previous active tab. On iOS, a value of undefined indicates that the More tab was the previous tab.

  • tab : Titanium.UI.Tab

    Active tab.

  • previousTab : Titanium.UI.Tab

    Previous active tab. On iOS, a value of undefined indicates that the More tab was the previous tab.

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

    •  
    •  
    •