# Titanium.UI.TableView

A table view is used to present information, organized in sections and rows, in a vertically-scrolling view.

Availability
0.8
0.8
9.2.0

# Overview

Android iOS
Android iOS

A TableView object is a container for Titanium.UI.TableViewSection objects that are, in turn, containers for Titanium.UI.TableViewRow objects.

Use the Titanium.UI.createTableView method or <TableView> Alloy element to create a TableView.

Also see the TableViews guide (opens new window).

# Creating Tables

There are few approaches to creating and using TableView object.

The simplest approach is to pass dictionaries of TableViewRow properties, such as Titanium.UI.TableViewRow.backgroundColor, Titanium.UI.TableViewRow.color, and Titanium.UI.TableViewRow.title, to the Titanium.UI.createTableView method, which causes the rows to be implictly created, added to a single Titanium.UI.TableViewSection, and then added to the TableView. Refer to the "Simple Table View with Basic Rows" example.

For more control over the layout of each row, however, Titanium.UI.TableViewRow objects can be created explicitly using the Titanium.UI.createTableViewRow method. Child views, such as Titanium.UI.Label, Titanium.UI.ImageView, and Titanium.UI.Button, may be added to each row. When one or more Titanium.UI.TableViewRow are added to the table view, a single Titanium.UI.TableViewSection is automatically created to hold the rows. See the "Table View with Composite Layout" example.

Lastly, sets of rows may be explicitly created and added to a their own Titanium.UI.TableViewSection objects, which are then added to a TableView, to enable the rows to be organized. Headers and footers titles or views must be configured in order for the sections to be visible.

# Tables and Scroll Views

As a table view inherently scrolls, it creates a very poor user experience when one contains other scrolling views, such as a Titanium.UI.ScrollableView or Titanium.UI.TextArea. Thus, this layout is strongly discouraged.

# TextFields in Tables with SOFT_INPUT_ADJUST_PAN (Android)

When a Titanium.UI.TextField is placed in a row near the bottom of a TableView, in a window that is configured with Titanium.UI.Android.SOFT_INPUT_ADJUST_PAN, it is expected for the text field to automatically move to a visible position after it is focused and the software keyboard displayed. However, due to a known problem caused by native Android's ListView behavior, the keyboard is likely to completely obscure the text field.

To mitigate this, a ScrollView may be used instead of a table view, as demonstrated in the Titanium.UI.ScrollView, "Scroll View as a Table View", example.

# Row Editing and Moving Modes

Table views have an editing and a moving mode that may be activated to using their respective Titanium.UI.TableView.editing and Titanium.UI.TableView.moving properties. These allow rows to be deleted or re-ordered by the user, depending on each row's Titanium.UI.TableViewRow.editable and Titanium.UI.TableViewRow.moveable property that are either explicitly set or inherited from the table.

There are two UI controls available for deleting table view rows, depending on the combination of editing and moving modes enabled:

  • "red icon delete" - a circular red icon is displayed on the left-hand side of a row, which reveals a delete button on the right-hand side of that row when clicked.
  • "swipe delete" - without either of the table editing or moving modes enabled, a left or right swipe gesture on a row reveals a delete button on the right-hand side of the row.

Note that because the operating system handles the functionality of the swipe delete, the OS will capture swipe events and not bubble the event to Titanium listeners. As such, if you rely on swipe events, you must not set editing to true on such rows, and simulate the functionality you need.

When editable and moveable properties are set on the table view, they are known as inherited, whereas when set on a row, they are known as explicit. As their resulting behavior may not follow their literal meaning, depending on the combination of editing and moving modes that are enabled, a detailed description of the behavior follows.

With editing:false and moving:true:

  • For red icon delete and swipe delete, inherited and explicit editable properties may be set.
  • Inherited moveable property is always true. Explicit moveable property may be set.

With editing:true and moving:false:

  • For red icon delete and swipe delete, inherited editable property is always true. Explicit editable property may be set.
  • Inherited and explicit moveable properties may be set.

With editing:false and moving: false:

  • For red icon delete, inherited and explicit editable properties always false. For swipe delete, inherited and explicit editable properties may be set.
  • Inherited moveable property is always false.

With editing:true and moving:true:

  • For red icon delete and swipe delete, inherited and explicit editable properties may be set.
  • Inherited moveable property is always true. Explicit moveable property may be set.

# Examples

# Simple Table View

Create a basic table view.

Ti.UI.backgroundColor = 'white';
var win = Ti.UI.createWindow();

var tableData = [ {title: 'Apples'}, {title: 'Bananas'}, {title: 'Carrots'}, {title: 'Potatoes'} ];

var table = Ti.UI.createTableView({
  data: tableData
});
win.add(table);
win.open();

# Table View Sections

Create a table with three sections, each with two rows. Add two sections to the table before and one after it is rendered. This sample only works on Release 3.0 and later.

Ti.UI.backgroundColor = 'white';
var win = Ti.UI.createWindow();

var sectionFruit = Ti.UI.createTableViewSection({ headerTitle: 'Fruit' });
sectionFruit.add(Ti.UI.createTableViewRow({ title: 'Apples' }));
sectionFruit.add(Ti.UI.createTableViewRow({ title: 'Bananas' }));

var sectionVeg = Ti.UI.createTableViewSection({ headerTitle: 'Vegetables' });
sectionVeg.add(Ti.UI.createTableViewRow({ title: 'Carrots' }));
sectionVeg.add(Ti.UI.createTableViewRow({ title: 'Potatoes' }));

var table = Ti.UI.createTableView({
  data: [sectionFruit, sectionVeg]
});

win.add(table);
win.open();

var sectionFish = Ti.UI.createTableViewSection({ headerTitle: 'Fish' });
sectionFish.add(Ti.UI.createTableViewRow({ title: 'Cod' }));
sectionFish.add(Ti.UI.createTableViewRow({ title: 'Haddock' }));

table.insertSectionBefore(0, sectionFish);

# Table View with Composite Layout

Create a table of rows that contain a custom child-view layout.

var win = Ti.UI.createWindow({
  backgroundColor: 'black',
  title: 'TableView Demo'
});

// generate random number, used to make each row appear distinct for this example
function randomInt(max){
  return Math.floor(Math.random() * max) + 1;
}

var IMG_BASE = 'images/';
var defaultFontSize = Ti.Platform.name === 'android' ? 16 : 14;

var tableData = [];

for (var i=1; i<=20; i++){
  var row = Ti.UI.createTableViewRow({
    className: 'forumEvent', // used to improve table performance
    backgroundSelectedColor: 'white',
    rowIndex: i, // custom property, useful for determining the row during events
    height: 110
  });

  var imageAvatar = Ti.UI.createImageView({
    image: IMG_BASE + 'custom_tableview/user.png',
    left: 10, top: 5,
    width: 50, height: 50
  });
  row.add(imageAvatar);

  var labelUserName = Ti.UI.createLabel({
    color: '#576996',
    font: {fontFamily:'Arial', fontSize: defaultFontSize+6, fontWeight: 'bold'},
    text: 'Fred Smith ' + i,
    left: 70, top: 6,
    width: 200, height: 30
  });
  row.add(labelUserName);

  var labelDetails = Ti.UI.createLabel({
    color: '#222',
    font: {fontFamily:'Arial', fontSize: defaultFontSize+2, fontWeight: 'normal'},
    text: 'Replied to post with id ' + randomInt(1000) + '.',
    left: 70, top: 44,
    width: 360
  });
  row.add(labelDetails);

  var imageCalendar = Ti.UI.createImageView({
    image: IMG_BASE + 'custom_tableview/eventsButton.png',
    left: 70, bottom: 2,
    width: 32, height: 32
  });
  row.add(imageCalendar);

  var labelDate = Ti.UI.createLabel({
    color: '#999',
    font: {fontFamily:'Arial', fontSize: defaultFontSize, fontWeight: 'normal'},
    text: 'on ' + randomInt(30) + ' Nov 2012',
    left: 105, bottom: 10,
    width: 200, height: 20
  });
  row.add(labelDate);

  tableData.push(row);
}

var tableView = Ti.UI.createTableView({
  backgroundColor: 'white',
  data: tableData
});

win.add(tableView);
win.open();

# Alloy XML Markup

Previous table view sections example as an Alloy view.

<Alloy>
    <Window id="win">
        <TableView id="table">
            <TableViewSection id="sectionFruit" headerTitle="Fruit">
                <TableViewRow title="Apple"/>
                <TableViewRow title="Bananas"/>
            </TableViewSection>
            <TableViewSection id="sectionVeg" headerTitle="Vegetables">
                <TableViewRow title="Carrots"/>
                <TableViewRow title="Potatoes"/>
            </TableViewSection>
            <TableViewSection id="sectionFish" headerTitle="Fish">
                <TableViewRow title="Cod"/>
                <TableViewRow title="Haddock"/>
            </TableViewSection>
        </TableView>
    </Window>
</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.


# allowsMultipleSelectionDuringEditing

Availability
10.1.0
8.2.0
9.2.0
allowsMultipleSelectionDuringEditing :Boolean

Determines whether multiple items of this table view can be selected at the same time while editing the table.

Default: false


# allowsMultipleSelectionInteraction

Availability
8.2.0
9.2.0
allowsMultipleSelectionInteraction :Boolean

Allows a two-finger pan gesture to automatically transition the table view into editing mode and start selecting rows.

Setting this property to true allows the user to start selecting multiple contiguous rows via a two-finger pan gesture. If the table view is already in editing mode, the user can also select multiple rows via a one-finger pan gesture along the edge of the table that contains editing controls (checkboxes). In order to support this behavior, you must also set allowsMultipleSelectionDuringEditing to true. Once user interaction stops the rowsselected event is fired.

Default: false


# allowsSelection

Availability
8.2.0
9.2.0
allowsSelection :Boolean

Determines whether this table's rows can be selected.

Set to false to prevent rows from being selected.

Default: true


# allowsSelectionDuringEditing

Availability
10.1.0
5.4.0
9.2.0
allowsSelectionDuringEditing :Boolean

Determines whether this table's rows can be selected while editing the table.

Set to true to allow rows to be selected.

Default: false


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


# backgroundColor

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

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

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

Default: transparent on non-iOS platforms, white on the iOS platform


# 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


# 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


# 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

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

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

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.


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


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


# data

Availability
0.8
0.8
9.2.0

Rows of the table view.


# dimBackgroundForSearch CREATION ONLY

Availability
6.2.0
9.2.0
dimBackgroundForSearch :Boolean

A Boolean indicating whether the underlying content is dimmed during a search.

If you do not want to show the dimmed background when clicking on the search bar, set this property false during creation.

Default: true


# editable

Availability
9.3.0
3.2.0
9.2.0
editable :Boolean

Determines the rows' default editable behavior, which allows them to be deleted by the user when the table is in editing or moving mode.

This property determines the default behavior of child rows, but may be overridden by a row's editable property.

See the Titanium.UI.TableView description section for a full explanation of the TableView's editing and moving modes.

Default: Depends on `editing` and `moving` mode


# editing

Availability
9.3.0
3.2.0
9.2.0
editing :Boolean

Determines whether row editing mode is active.

The editing mode allows rows to be deleted or re-ordered, depending on their editable and moveable settings.

See the Titanium.UI.TableView description section for a full explanation of the TableView's editing and moving modes.

Default: false


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


# filterAnchored

Availability
3.3.0
3.3.0
9.2.0
filterAnchored :Boolean

Determines whether the search is limited to the start of the string

Set to true to enable case anchored search.

Default: false


# filterAttribute

Availability
0.8
0.8
9.2.0
filterAttribute :String

Filter attribute to be used when searching.

On the Android platform, this property can only be set to Titanium-defined properties of the TableViewRow object, such as title. To search text stored in a different attribute, set the title property of the TableViewRow object to the property to be searched. For example:

var label = Ti.UI.createLabel({text: 'Foobar'}),
var row = Ti.UI.createTableViewRow(title: label.text);
row.add(label);

On the iOS platform, this property can be set to any property on the TableViewRow object, including arbitrary properties set on the object, not only Titanium-defined properties.

Note that the filter is not anchored to the beginning of the string. So typing "ha" in the text box will include rows titled 'Harold' and 'Harvard', but also 'Sharon' and 'Jonathan'.


# filterCaseInsensitive

Availability
0.8
0.8
9.2.0
filterCaseInsensitive :Boolean

Determines whether the search is case insensitive.

Set to false to enable case sensitive search.

Default: true


# 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


# fixedSize CREATION ONLY

Availability
11.0.0
fixedSize :Boolean

Sets fixedSize mode on Android TableView.

Set it to true if all TableView items have the same size to gain some performance.

Default: false


# focusable

Availability
0.9
focusable :Boolean

Whether view should be focusable while navigating with the trackball.

Default: false


# footerDividersEnabled CREATION ONLY

Availability
3.3.0
footerDividersEnabled :Boolean

When set to false, the ListView will not draw the divider before the footer view.

Default: undefined but behaves as false


# footerTitle

Availability
0.8
0.8
9.2.0
footerTitle :String

Table view footer title.


# footerView

Availability
0.8
0.8
9.2.0
footerView :Titanium.UI.View

Table view footer as a view that will be rendered instead of a label.

In Alloy you can use a <FooterView> element nested in a <TableView> element:

<Alloy>
    <TableView>
        <FooterView>
            <View backgroundColor="#a00" height="50dp"/>
        </FooterView>
        <TableViewRow><Label>Row 1</Label></TableViewRow>
        <TableViewRow><Label>Row 2</Label></TableViewRow>
    </TableView>
</Alloy>

# headerDividersEnabled CREATION ONLY

Availability
3.3.0
headerDividersEnabled :Boolean

When set to false, the ListView will not draw the divider after the header view.

Default: undefined but behaves as false


# headerPullView

Availability
2.1.0
9.2.0
headerPullView :Titanium.UI.View

View positioned above the first row that is only revealed when the user drags the table contents down.

A headerPullView is a UI control that is often used to provide a convenient way for the user to refresh a table's data. Typically used with the setContentInsets method.

To specify the wrapper color see pullBackgroundColor.

For an example, see the "Pull to refresh" section in the TableViews guide.

Alloy applications can use a <HeaderPullView> element inside a <TableView> element.

<Alloy>
    <TableView>
        <HeaderPullView platform="ios">
            <View class="pull">
                <Label color="#F2F4F4" bottom="25dp">Header pull view</Label>
            </View>
        </HeaderPullView>
    </TableView>
</Alloy>

# headerTitle

Availability
0.8
0.8
9.2.0
headerTitle :String

Table view header title.


# headerView

Availability
0.8
0.8
9.2.0
headerView :Titanium.UI.View

Table view header as a view that will be rendered instead of a label.

In Alloy you can use a <HeaderView> element nested in a <TableView> element:

<Alloy>
    <TableView>
        <HeaderView>
            <View backgroundColor="#a00" height="50dp"/>
        </HeaderView>
        <TableViewRow><Label>Row 1</Label></TableViewRow>
        <TableViewRow><Label>Row 2</Label></TableViewRow>
    </TableView>
</Alloy>

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

# hideSearchOnSelection

Availability
0.8
9.2.0
hideSearchOnSelection :Boolean

Determines whether the search field should hide on completion.

Set to false to prevent the search field from being hidden when an item in the search results is clicked.

Many standard applications (such as Contacts) have a behavior equivalent to false for this value, but the default is true for legacy reasons.

The Android platform behaves as though this value were false.

Default: true


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


# index

Availability
0.8
9.2.0
index :Array<TableViewIndexEntry>

Array of objects (with title and index properties) to control the table view index.

If an index array is specified, an index bar is displayed on the right-hand side of the table view. Clicking on a title in the index bar scrolls the table view to the row index associated with that title. If the index is -1 the table view will scroll to the top.


# 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


# keyboardDismissMode

Availability
12.2.0
12.2.0
keyboardDismissMode :Number

The manner in which the keyboard is dismissed when a drag begins in the table view.

Default: Undefined (behaves like <Titanium.UI.iOS.KEYBOARD_DISMISS_MODE_NONE>)


# 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

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

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

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.


# lifecycleContainer

Availability
3.6.0

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

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


# maxClassname CREATION ONLY

Availability
5.2.0
maxClassname :Number

Max number of row class names.

See className for more details. This property will default to 32 when it is set to a number lesser than that.

Default: 32


# maxRowHeight

Availability
0.8
0.8
9.2.0
maxRowHeight :Number

Maximum row height for table view rows.


# minRowHeight

Availability
0.8
0.8
9.2.0
minRowHeight :Number

Minimum row height for table view rows.


# moveable

Availability
9.3.0
3.2.0
9.2.0
moveable :Boolean

Determines the rows' default moveable behavior, which allows them to be re-ordered by the user when the table is in editing or moving mode.

This property determines the default behavior of child rows, but may be overridden by a row's moveable property.

See the Titanium.UI.TableView description section for a full explanation of the TableView's editing and moving modes.

Default: Depends on `editing` and `moving` mode


# moving

Availability
9.3.0
3.2.0
9.2.0
moving :Boolean

Determines whether row moving mode is active.

The moving mode allows rows to be deleted or re-ordered, depending on their editable and moveable settings.

See the Titanium.UI.TableView description section for a full explanation of the TableView's editing and moving modes.

Default: false


# opacity

Availability
0.9
0.9
9.2.0
opacity :Number

Opacity of this view, from 0.0 (transparent) to 1.0 (opaque). Defaults to 1.0 (opaque).


# overrideCurrentAnimation CREATION ONLY

Availability