A table view is used to present information, organized in sections and rows, in a vertically-scrolling view.
 |
 |
 |
| Android | iOS | Windows Phone |
|---|
A TableView object is a container for TableViewSection
objects that are, in turn, containers for TableViewRow objects.
Use the Titanium.UI.createTableView method or <TableView> Alloy element to create a TableView.
Also see the TableViews guide.
Creating Tables
There are few approaches to creating and using TableView object.
The simplest approach is to pass dictionaries of TableViewRow properties, such as
backgroundColor,
color, and title, to the
createTableView method, which causes the rows to be implictly
created, added to a single 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, TableViewRow objects can be created explicitly using the Titanium.UI.createTableViewRow method. Child views, such as labels, images, and buttons, may be added to each row. When one or more rows are added to the table view, a single 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
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 ScrollableView or TextArea. Thus, this layout is strongly discouraged.
TextFields in Tables with SOFT_INPUT_ADJUST_PAN (Android)
When a TextField is placed in a row near the bottom of a TableView,
in a window that is configured with
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
ScrollView, "Scroll View as a Table View", example.
Known Issues
There are known issues with the sections property and associated methods added in
Release 3.0:
- On iOS, the first two arguments to the
updateSectionmethod are reversed. (TIMOB-12625). This issue has been addressed in Release 3.3.0 of the Titanium SDK
Row Editing and Moving Modes (iOS only)
On iOS, table views have an editing and a moving mode that may be activated to using their
respective editing and moving
properties. These allow rows to be deleted or re-ordered by the user, depending on each row's
editable and 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
editableproperties may be set. - Inherited
moveableproperty is alwaystrue. Explicitmoveableproperty may be set.
With editing:true and moving:false:
- For red icon delete and swipe delete, inherited
editableproperty is alwaystrue. Expliciteditableproperty may be set. - Inherited and explicit
moveableproperties may be set.
With editing:false and moving: false:
- For red icon delete, inherited and explicit
editableproperties alwaysfalse. For swipe delete, inherited and expliciteditableproperties may be set. - Inherited
moveableproperty is alwaysfalse.
With editing:true and moving:true:
- For red icon delete and swipe delete, inherited and explicit
editableproperties may be set. - Inherited
moveableproperty is alwaystrue. Explicitmoveableproperty 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' }));
// Prior to Release 3.0, you can only add and remove sections by setting the data property
// table.data = [ sectionFish, sectionFruit, sectionVeg ];
// Due to a known issue, TIMOB-12616, the section access methods and sections
// property should not be used on iOS with Release 3.0.x.
table.insertSectionBefore(0, sectionFish);
Table View with Composite Layout
Create a table of rows that contain a custom child-view layout.
Ti.UI.setBackgroundColor('#000');
var win = Ti.UI.createWindow({
backgroundColor: 'black',
exitOnClose: true,
fullscreen: false,
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
selectedBackgroundColor:'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" backgroundColor="white">
<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>
- 0.8
- 0.8
- 0.8
Properties
Whether the view should be "hidden" from (i.e., ignored by) the accessibility service.
Requires: Android 4.0 and later iOS 5.0 and later
On iOS this is a direct analog of the accessibilityElementsHidden property defined in the
UIAccessibility
Protocol.
The native property is only available in iOS 5.0 and later; if
accessibilityHidden is specified on earlier versions of iOS, it is ignored.
On Android, setting accessibilityHidden calls the native
View.setImportantForAccessibility
method. The native method is only available in Android 4.1 (API level 16/Jelly Bean) and
later; if this property is specified on earlier versions of Android, it is ignored.
Default: false
- 3.0.0
- 3.0.0
- 3.0.0
Briefly describes what performing an action (such as a click) on the view will do.
On iOS this is a direct analog of the accessibilityHint property defined in the
UIAccessibility Protocol.
On Android, it is concatenated together with
accessibilityLabel and accessibilityValue in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Default:
- 3.0.0
- 3.0.0
- 3.0.0
A succint label identifying the view for the device's accessibility service.
On iOS this is a direct analog of the accessibilityLabel property defined in the
UIAccessibility Protocol.
On Android, it is concatenated together with
accessibilityValue and accessibilityHint in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Default: Title or label of the control.
- 3.0.0
- 3.0.0
- 3.0.0
A string describing the value (if any) of the view for the device's accessibility service.
On iOS this is a direct analog of the accessibilityValue property defined in the
UIAccessibility Protocol.
On Android, it is concatenated together with
accessibilityLabel and accessibilityHint in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Default: State or value of the control.
- 3.0.0
- 3.0.0
- 3.0.0
Determines whether this table's rows can be selected.
Set to false to prevent rows from being selected.
Default: true
- 0.8
- 0.8
Determines whether this table's rows can be selected while editing the table.
Set to true to allow rows to be selected.
Default: false
- 0.8
- 0.8
Coordinate of the view about which to pivot an animation.
Used on iOS only. For Android, use Titanium.UI.Animation.anchorPoint.
Anchor point is specified as a fraction of the view's size. For example, {0, 0} is at
the view's top-left corner, {0.5, 0.5} at its center and {1, 1} at its bottom-right
corner.
See the "Using an anchorPoint" example in Titanium.UI.Animation for a demonstration.
Default: Center of this view.
- 0.9
- 0.9
Current position of the view during an animation.
Current position of the view during an animation.
- 0.9
- 0.9
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
Background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Prior to iOS 6, it was possible to explicitly specify a color value of Titanium.UI.iOS.COLOR_GROUP_TABLEVIEW_BACKGROUND or 'stripped' (sic) to select the iOS group tableview background texture. On iPhone and iPod Touch, this produces a pinstriped texture; on iPad, it is transparent.
In iOS 6, there is no way to explicitly specify the group tableview background texture. The color values Titanium.UI.iOS.COLOR_GROUP_TABLEVIEW_BACKGROUND or 'stripped' are interpreted as black.
Default: transparent on non-iOS platforms, white on the iOS platform
- 0.9
- 0.9
- 0.9
Overrides: Titanium.UI.View.backgroundColor
Disabled background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Default: Same as the normal background color of this view.
- 0.9
Disabled background image for the view, specified as a local file path or URL.
Default: If `backgroundDisabledImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is disabled.
- 0.9
Focused background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
For normal views, the focused color is only used if focusable is true.
Default: Same as the normal background color of this view.
- 0.9
Focused background image for the view, specified as a local file path or URL.
For normal views, the focused background is only used if focusable is true.
Default: If `backgroundFocusedImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is focused.
- 0.9
A background gradient for the view.
A gradient can be defined as either linear or radial. A linear gradient varies continuously
along a line between the startPoint and endPoint.
A radial gradient is interpolated between two circles, defined by startPoint and
startRadius and endPoint and endRadius respectively.
The start and end points and radius values can be defined in device units, in the view's coordinates, or as percentages of the view's size. Thus, if a view is 60 x 60, the center point of the view can be specified as:
{ x: 30, y: 30 }
Or: { x: '50%', y: '50%' }
When specifying multiple colors, you can specify an offset value for each color, defining how far into the gradient it takes effect. For example, the following color array specifies a gradient that goes from red to blue back to red:
colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ]
Android's linear gradients ignores backfillStart and backfillEnd, treating them as if
they are true. Android's radial gradients ignore the endPoint property.
Examples
Linear and Radial Gradients
The following code excerpt creates two views, one with a linear gradient and one with a radial gradient.
var win1 = Titanium.UI.createWindow({
title:'Tab 1',
backgroundColor:'#fff',
layout: 'vertical'
});
var radialGradient = Ti.UI.createView({
top: 10,
width: 100,
height: 100,
backgroundGradient: {
type: 'radial',
startPoint: { x: 50, y: 50 },
endPoint: { x: 50, y: 50 },
colors: [ 'red', 'blue'],
startRadius: 50,
endRadius: 0,
backfillStart: true
}
});
var linearGradient = Ti.UI.createView({
top: 10,
width: 100,
height: 100,
backgroundGradient: {
type: 'linear',
startPoint: { x: '0%', y: '50%' },
endPoint: { x: '100%', y: '50%' },
colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ],
}
});
win1.add(radialGradient);
win1.add(linearGradient);
win1.open();
Default: No gradient
Background image for the view, specified as a local file path or URL.
Default: Default behavior when `backgroundImage` is unspecified depends on the type of view and the platform. For generic views, no image is used. For most controls (buttons, text fields, and so on), platform-specific default images are used.
Size of the left end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
Default: 0
- 0.9
- 0.9
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
Size of the top end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
Default: 0
- 0.9
- 0.9
Border color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Default: Same as the normal background color of this view (Android), black (iOS).
Radius for the rounded corners of the view's border.
Each corner is rounded using an arc of a circle.
Default: 0
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
View's bottom position, in platform-specific units.
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.
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.
Array of this view's child views.
Array of this view's child views.
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
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
- 6.2.0
- 6.2.0
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
- 0.8
- 0.8
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
- 0.8
- 0.8
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
Determines whether the search is limited to the start of the string
Set to true to enable case anchored search.
Default: false
- 3.3.0
- 3.3.0
- 3.3.0
Filter attribute to be used when searching.
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'.
Determines whether the search is case insensitive.
Set to false to enable case sensitive search.
Default: true
Whether view should be focusable while navigating with the trackball.
Default: false
- 0.9
When set to false, the ListView will not draw the divider after the header view.
Default: undefined but behaves as false
- 3.3.0
View positioned above the first row that is only revealed when the user drags the table contents down.
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 Titanium.UI.View.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>
- 2.1.0
- 2.1.0
Table view header as a view that will be rendered instead of a label.
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>
View height, in platform-specific units.
View height, in platform-specific units.
Defaults to: If undefined, defaults to either Titanium.UI.FILL or Titanium.UI.SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.
Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:
- Titanium.UI.SIZE. The view should size itself to fit its contents.
- Titanium.UI.FILL. The view should size itself to fill its parent.
- 'auto'. Represents the default sizing behavior for a given type of
view. The use of 'auto' is deprecated, and should be replaced with the
SIZEorFILLconstants 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:
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
- 0.8
- 0.8
Determines whether the layout has wrapping behavior.
For more information, see the discussion of horizontal layout mode in the description of the layout property.
Default: true
- 2.1.0
- 2.1.0
- 2.1.0
Array of objects (with title and index properties) to control the table view index.
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.
- 0.8
- 0.8
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
Specifies how the view positions its children. One of: 'composite', 'vertical', or 'horizontal'.
There are three layout options:
composite(orabsolute). Default layout. A child view is positioned based on its positioning properties or "pins" (top,bottom,left,rightandcenter). If no positioning properties are specified, the child is centered.The child is always sized based on its
widthandheightproperties, 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 bothleftandcenter.xare 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.yandbottomare all specified, theheightandcenter.yvalues take precedence.)Scenario Behavior `height` & `top` specified Child positioned `top` unit from parent's top, using specified `height`; any `center.y` and `bottom` values are ignored. `height` & `center.y` specified Child positioned with center at `center.y`, using specified `height`; any `bottom` value is ignored. `height` & `bottom` specified Child positioned `bottom` units from parent's bottom, using specified `height`. `top` & `center.y` specified Child positioned with top edge `top` units from parent's top and center at `center.y`. Height is determined implicitly; any `bottom` value is ignored. `top` & `bottom` specified Child positioned with top edge `top` units from parent's top and bottom edge `bottom` units from parent's bottom. Height is determined implicitly. Only `top` specified Child positioned `top` units from parent's top, and uses the default height calculation for the view type. `center.y` and `bottom` specified Child positioned with center at `center.y` and bottom edge `bottom` units from parent's bottom. Height is determined implicitly. Only `center.y` specified Child positioned with center at `center.y`, and uses the default height calculation for the view type. Only `bottom` specified Child positioned with bottom edge `bottom` units from parent's bottom, and uses the default height calculation for the view type. `height`, `top`, `center.y`, and `bottom` unspecified Child centered vertically in the parent and uses the default height calculation for the child view type. Horizontal positioning works like vertical positioning, except that the precedence is
width,left,center.x,right.For complete details on composite layout rules, see Transitioning to the New UI Layout System in the Titanium Mobile Guides.
vertical. Children are laid out vertically from top to bottom. The first child is laid outtopunits 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'sbottomvalue plus the lower child'stopvalue.
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 (thehorizontalWrapproperty istrue).
With wrapping behavior, the children are laid out horizontally from left to right, in rows. If a child requires more horizontal space than exists in the current row, it is wrapped to a new row. The height of each row is equal to the maximum height of the children in that row.
Wrapping behavior is available on iOS and Android (Release 2.1.0 and later). When the
horizontalWrapproperty 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
toporbottomis specified, the child is centered in the row. - If either
toporbottomis specified, the child is aligned to either the top or bottom of the row, with the specified amount of padding. - If both
topandbottomis specified for a given child, the properties are both treated as padding.
If the
horizontalWrapproperty is false, the behavior is more equivalent to a vertical layout. Children are laid or horizontally from left to right in a single row. Theleftandrightproperties are used as padding between the children, and thetopandbottomproperties are used to position the children vertically.On Android and iOS prior to Release 2.1.0, the horizontal layout always wraps and the
horizontalWrapproperty is not supported.
Default: Composite layout
View's left position, in platform-specific units.
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.
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
Max number of row class names.
See Titanium.UI.TableViewRow.className for more details. This property will default to 32 when it is set to a number lesser than that.
Default: 32
- 5.2.0
Maximum row height for table view rows.
Maximum row height for table view rows.
Minimum row height for table view rows.
Minimum row height for table view rows.
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
- 0.8
- 0.8
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
- 0.8
- 0.8
Opacity of this view, from 0.0 (transparent) to 1.0 (opaque).
Default: 1.0 (opaque)
Determines the behavior when the user overscrolls the view.
This API can be assigned the following constants:
- Titanium.UI.Android.OVER_SCROLL_ALWAYS
- Titanium.UI.Android.OVER_SCROLL_IF_CONTENT_SCROLLS
- Titanium.UI.Android.OVER_SCROLL_NEVER
Default: Titanium.UI.Android.OVER_SCROLL_ALWAYS
- 3.1.0
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".
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.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
View positioned above the first row that is only revealed when the user drags the list view contents down.
View positioned above the first row that is only revealed when the user drags the list view contents down.
An alternate to the headerPullView property. See Titanium.UI.RefreshControl for usage and examples.
- 6.2.0
- 3.2.0
- 3.2.0
View's right position, in platform-specific units.
View's right 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.
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
The insets for table view cells (applies to all cells). This property is applicable on iOS 7 and greater.
Requires: iOS 7.0 and later
In iOS 7 and later, cell separators do not extend all the way to the edge of the table view.Set this to a
dictionary with two keys, left specifying inset from left edge and right specifying the inset from the
right edge. This property is only available upon creation of the cells.
For example:
tableView1.setRowSeparatorInsets({
left:10,
right:10
});
- 5.2.0
- 5.2.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
Style of the scrollbar.
This API can be assigned the following constants:
- Titanium.UI.iOS.ScrollIndicatorStyle.BLACK
- Titanium.UI.iOS.ScrollIndicatorStyle.DEFAULT
- Titanium.UI.iOS.ScrollIndicatorStyle.WHITE
Default: Titanium.UI.iOS.ScrollIndicatorStyle.DEFAULT
- 2.1.0
- 2.1.0
If true, the tableview can be scrolled.
Default: true
- 0.8
- 0.8
Controls whether the scroll-to-top gesture is effective.
The scroll-to-top gesture is a tap on the status bar; The default value of this property is true. This gesture works when you have a single visible table view. If there are multiple table views, web views, text areas, and/or scroll views visible, you will need to disable (set to false) on the above views you DON'T want this behaviour on. The remaining view will then respond to scroll-to-top gesture.
Default: true
- 2.1.2
- 2.1.2
Search field to use for the table view.
Search field to use for the table view.
In an Alloy application, you can use a <SearchView> or <SearchBar> element inside a <TableView> element.
<Alloy>
<TableView>
<!-- search, shorthand with Ti.UI.SearchBar -->
<SearchBar platform="ios"/>
<!-- search, shorthand with Ti.UI.Android.SearchView -->
<SearchView ns="Ti.UI.Android" platform="android"/>
</TableView>
</Alloy>
Determines whether the SearchBar or SearchView appears as part of the TableView.
Set to false if the search view will be displayed in the action bar.
Default: true
- 3.0.2
Determines whether the search field is visible.
Set to true to hide the search field.
Default: false (search field visible)
- 0.8
- 0.8
Number of sections in this table view.
Number of sections in this table view.
- 3.0.0
- 3.0.0
- 3.0.0
Sections of this table.
Sections of this table.
In Release 3.0, this property is read-only on Android.
Due to a known issue, TIMOB-12616, the sections property should not be used
for adding sections on iOS.
- 3.1.0
- 3.0.0
- 3.0.0
Separator line color between rows, as a color name or hex triplet.
To make the line invisible, set this property to transparent, or the same value as the
backgroundColor property.
For information about color values, see the "Colors" section of Titanium.UI.
Default: platform-specific default color
The insets for table view separators (applies to all cells). This property is applicable on iOS 7 and greater.
deprecated
5.2.0 Use <Titanium.UI.TableView.tableSeparatorInsets> instead.
Requires: iOS 7.0 and later
In iOS 7 and later, cell separators do not extend all the way to the edge of the table view.
This property sets the default inset for all cells in the table. Set this to a dictionary
with two keys, left specifying inset from left edge and right specifying the inset from the right edge.
For example:
tableView1.setSeparatorInsets({
left:10,
right:10
});
- 3.2.0
- 3.2.0
Separator style constant.
This API can be assigned the following constants:
- 5.2.0
- 0.8
- 0.8
Determines whether this table view displays a vertical scroll indicator.
Set to false to hide the vertical scroll indicator.
Default: true
- 0.8
- 0.8
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.
Determines keyboard behavior when this view is focused.
This API can be assigned the following constants:
- Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS
- Titanium.UI.Android.SOFT_KEYBOARD_HIDE_ON_FOCUS
- Titanium.UI.Android.SOFT_KEYBOARD_SHOW_ON_FOCUS
Default: Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS
- 0.9
Style of the table view, specified using one of the constants from Titanium.UI.iOS.TableViewStyle.
Style of the table view, specified using one of the constants from Titanium.UI.iOS.TableViewStyle.
Style should always be set before setting the data on table view.
This API can be assigned the following constants:
- 0.8
- 0.8
The insets for the table view header and footer. This property is applicable on iOS 7 and greater.
Requires: iOS 7.0 and later
In iOS 7 and later, cell separators do not extend all the way to the edge of the table view.Set this to a
dictionary with two keys, left specifying inset from left edge and right specifying the inset from the
right edge. If the rowSeparatorInsets is not set, the tableSeparatorInsets will also set the cell insets.
For example:
tableView1.setTableSeparatorInsets({
left:10,
right:10
});
- 5.2.0
- 5.2.0
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
The view's top position.
The view's top position.
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.
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.
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. This has no effect unless touchFeedback is true.
Requires: Android 5.0 and later
Default: Theme provided color.
- 6.1.0
Transformation matrix to apply to the view.
Android only supports 2DMatrix transforms.
Default: Identity matrix
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.
Requires: Android 5 and later
Translation values are applied to the static post layout value.
- 5.0.0
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.
Default: Undefined. Behaves as if set to (0,-3)
- 3.3.0
- 3.3.0
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.
Default: true
View's width, in platform-specific units.
View's width, in platform-specific units.
Defaults to: If undefined, defaults to either Titanium.UI.FILL or Titanium.UI.SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.
Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:
- Titanium.UI.SIZE. The view should size itself to fit its contents.
- Titanium.UI.FILL. The view should size itself to fill its parent.
- 'auto'. Represents the default sizing behavior for a given type of
view. The use of 'auto' is deprecated, and should be replaced with the
SIZEorFILLconstants if it is necessary to set the view's behavior explicitly.
This is an input property for specifying the view's width dimension. To determine the view's size once rendered, use the rect or size properties.
This API can be assigned the following constants:
Z-index stack order position, relative to other sibling views.
Z-index stack order position, relative to other sibling views.
A view does not have a default z-index value, meaning that it is undefined by default. When this property is explicitly set, regardless of its value, it causes the view to be positioned in front of any sibling that has an undefined z-index.
Methods
Adds a child to this view's hierarchy.
The child view is added as the last child in this view's hierarchy.
Although all views inherit from Titanium.UI.View, not all views are capable of containing other views. In particular:
- Some views are not designed to be containers at all.
- Some views are special-purpose containers that can only contain certain other views.
- Some views are top-level containers that cannot (or should not) be added to other views.
Non-Container Views
The following views are not intended to act as containers that can hold other views:
- ActivityIndicator
- Button
- ImageView
- Label
- ProgressBar
- SearchBar
- Slider
- Switch
- TableView
- TextArea
- TextField
- WebView
Adding children to the these views may be supported on some platforms, but is not guaranteed to work across platforms. Where it is supported, it may not work as expected.
For maximum portability, these views should be treated as if they do not support children.
Instead of adding children to these views, applications can positon other views as
siblings. For example, instead of adding a button as a child of a WebView, you can add
the button to the web view's parent such that it appears on top of the web view.
Special-Purpose Containers
A few view objects act as special-purpose containers--that is, they only manage
certain types of children, and many of them support a special means of adding
these children, instead of the general add method. These containers include:
ButtonBar and TabbedBar are designed to hold their own internally-created buttons, assigned by adding strings to the "labels" array. Views added using the
addmethod are displayed on top of these buttons.Picker. Can only hold
PickerRowsandPickerColumns, which are added using theaddmethod. Adding other types of views to aPickeris not supported.TableView is a specialized container for
TableViewSectionandTableViewRowobjects. These objects must be added using the properties and methods thatTableViewprovides for adding and removing sectons and rows.On some platforms, it is possible to add arbitrary child views to a table view using the
addmethod. However, this is not guaranteed to work on all platforms, and in general, should be avoided.TableViewSection is a specialized container for
TableViewRowobjects, which are added using theaddmethod. Theaddmethod onTableViewSectioncan only be used to addTableViewRowobjects.Toolbar is designed to hold buttons and certain other controls, added to its
itemsarray. Views added using theaddmethod are displayed on top of the controls in theitemsarray.The
Tab,TabGroup,NavigationWindowandSplitWindowobjects are special containers that manage windows. These are discussed in the "Top-Level Containers" section.
Top-Level Containers
There are certain top-level containers that are not intended to be added as the children of other views. These top-level containers include Titanium.UI.Window, Titanium.UI.iPad.SplitWindow, Titanium.UI.iOS.NavigationWindow, and Titanium.UI.TabGroup. Other types of views must be added to a top-level container in order to be displayed on screen.
The special containers Titanium.UI.iOS.NavigationWindow,
Titanium.UI.iPad.SplitWindow, Titanium.UI.Tab, and
Titanium.UI.TabGroup manage windows.
These managed windows may be referred to as children of the
container, but they are not added using the add method.
Tab is another kind of special container: it is not itself a top-level container,
but can only be used within a TabGroup. You cannot add a Tab to an arbitrary
container.
Parameters
- view : Titanium.UI.View/Array<Titanium.UI.View>
View to add to this view's hierarchy.
You may pass an array of views, e.g.
view.add([subview1, subview2].
Returns
- void
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
Animates this view.
The Animation object or dictionary passed to this method defines the end state for the animation, the duration of the animation, and other properties.
Note that if you use animate to move a view, the view's actual position is changed, but
its layout properties, such as top, left, center and so on are not changed--these
reflect the original values set by the user, not the actual position of the view.
The rect property can be used to determine the actual size and position of the view.
Parameters
- animation : Titanium.UI.Animation/Dictionary<Titanium.UI.Animation>
Either a dictionary of animation properties or an Animation object.
- callback : Callback<Object>
Function to be invoked upon completion of the animation.
Returns
- void
Appends a single row or an array of rows to the end of the table.
Each row can be passed as a TableViewRow object, or as
dictionary specifying the properties for a table row, in which case this TableView will
create TableViewRow objects as needed.
On iOS, the row(s) can be inserted with animation by specifying a properties parameter.
Parameters
- row : Titanium.UI.TableViewRow/Dictionary<Titanium.UI.TableViewRow>/Array<Titanium.UI.TableViewRow>/Array<Dictionary<Titanium.UI.TableViewRow>>
Row or rows to add to the table.
- animation : TableViewAnimationProperties (optional)
Animation properties. (iOS only.)
Returns
- void
Appends a single section or an array of sections to the end of the table.
Each section can be passed as a TableViewSection object, or as
dictionary specifying the properties for a table section, in which case this TableView will
create TableViewSection objects as needed.
On iOS, the section(s) can be inserted with animation by specifying a properties parameter.
Due to a known issue, TIMOB-12616, this method should not be used for adding sections on iOS.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- section : Titanium.UI.TableViewSection/Dictionary<Titanium.UI.TableViewSection>/Array<Titanium.UI.TableViewSection>/Array<Dictionary<Titanium.UI.TableViewSection>>
Section or section to add to the table.
- animation : TableViewAnimationProperties (optional)
Animation properties. (iOS only.)
Returns
- void
Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- props : Dictionary
A dictionary of properties to apply.
Returns
- void
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
xoryproperty, 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
Deletes an existing row.
On iOS, the row can be deleted with animation by specifying a properties parameter.
Starting in SDK 3.1.0, the row can be specified using Titanium.UI.TableViewRow on Android and iOS.
Parameters
- row : Number/Titanium.UI.TableViewRow
Index of the row to delete, or the row object to delete.
- animation : TableViewAnimationProperties (optional)
Animation properties. (iOS only.)
Returns
- void
Deletes an existing section.
On iOS, the section can be deleted with animation by specifying a properties parameter.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- section : Number
Index of the section to delete.
- animation : TableViewAnimationProperties (optional)
Animation properties. (iOS only.)
Returns
- void
Programmatically deselects a row.
- 0.8
- 0.8
Parameters
- row : Number
Row index to deselect.
Returns
- void
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.
Parameters
- name : String
Name of the event.
- event : Dictionary
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Returns
- void
Gets the value of the backgroundColor property.
- 0.9
- 0.9
- 0.9
Returns
- String
Overrides: Titanium.UI.View.getBackgroundColor
Gets the value of the data property.
Returns
Gets the value of the separatorInsets property.
deprecated since 5.2.0
Use <Titanium.UI.TableView.tableSeparatorInsets> instead.
- 3.2.0
- 3.2.0
Returns
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
idproperty in your views to enable it for indexing in this method.
Returns
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.
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 insertposition(Number): Position in the children array to insert the view. If omitted, inserts the view to the end of the array.
Returns
- void
Inserts a row after another row.
Each row can be passed as a TableViewRow object, or as
dictionary specifying the properties for a table row, in which case this TableView will
create TableViewRow objects as needed.
On iOS, the row(s) may be inserted with animation by setting the animation parameter.
Parameters
- index : Number
Index of the row to insert after.
- row : Titanium.UI.TableViewRow/Dictionary<Titanium.UI.TableViewRow>
Row to insert.
- animation : TableViewAnimationProperties (optional)
Animation properties. (iOS only.)
Returns
- void
Inserts a row before another row.
Each row can be passed as a TableViewRow object, or as
dictionary specifying the properties for a table row, in which case this TableView will
create TableViewRow objects as needed.
On iOS, the row(s) may be inserted with animation by setting the animation parameter.
Parameters
- index : Number
Index of the row to insert before.
- row : Titanium.UI.TableViewRow/Dictionary<Titanium.UI.TableViewRow>
Row to insert.
- animation : TableViewAnimationProperties (optional)
Animation properties. (iOS only.)
Returns
- void
Inserts a section after another section.
Each section can be passed as a TableViewSection object, or as
dictionary specifying the properties for a table section, in which case this TableView will
create TableViewSection objects as needed.
On iOS, the section(s) may be inserted with animation by setting the animation parameter.
Due to a known issue, TIMOB-12616, this method should not be used for adding sections on iOS.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- index : Number
Index of the section to insert after.
- section : Titanium.UI.TableViewSection/Dictionary<Titanium.UI.TableViewSection>
section to insert.
- animation : TableViewAnimationProperties (optional)
Animation properties. (iOS only.)
Returns
- void
Inserts a section before another section.
Each section can be passed as a TableViewSection object, or as
dictionary specifying the properties for a table section, in which case this TableViewSection will
create TableViewSection objects as needed.
On iOS, the section(s) may be inserted with animation by setting the animation parameter.
Due to a known issue, TIMOB-12616, this method should not be used for adding sections on iOS.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- index : Number
Index of the section to insert before.
- section : Titanium.UI.TableViewSection/Dictionary<Titanium.UI.TableViewSection>
section to insert.
- animation : TableViewAnimationProperties (optional)
Animation properties. (iOS only.)
Returns
- void
Removes a child view from this view's hierarchy.
Parameters
- view : Titanium.UI.View
View to remove from this view's hierarchy.
Returns
- void
Removes all child views from this view's hierarchy.
- 3.1.0
- 3.1.0
- 3.1.0
Returns
- void
Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Parameters
- name : String
Name of the event.
- callback : Callback<Object>
Callback function to remove. Must be the same function passed to
addEventListener.
Returns
- void
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 insertposition(Number): Position in the children array of the view elment to replace.
Returns
- void
Scrolls the table view to ensure that the specified row is on screen.
On iOS, specify a TableViewAnimationProperties object to control the position that the selected row is scrolled to, and whether scrolling is animated.
Parameters
- index : Number
Row index to scroll to.
- animation : TableViewAnimationProperties (optional)
Animation properties. (iOS only.)
Returns
- void
Scrolls the table to a specific top position where 0 is the topmost y position in the table view.
The behavior of this method is platform-specific.
On Android, the top value is interpreted as a row index that should be scrolled
to the top of the screen. The table will not scroll the last row of data higher than
the bottom of the screen. If there is less than one screenful of data below the
specified row, the table doesn't scroll the specified row all the way to the top.
If the table has less than one screenful of data total, it does not scroll at all.
On iOS, the top value is interpreted as a pixel offset between the top of the top
row of data and the top of the table view. So a top value of 0 scrolls the list to
the top. A positive value scrolls it down, and a negative value scrolls the list up
above the first item.
On iOS, specify a TableViewAnimationProperties object with animated set to false to
disable the scrolling animation.
Parameters
- top : Number
Y position for the top of the table view.
- animation : TableViewAnimationProperties (optional)
Animation properties. (iOS only.)
Returns
- void
Programmatically selects a row. In Android, it sets the currently selected item. If in touch mode, the item will not be selected but it will still be positioned appropriately. If the specified selection position is less than 0, then the item at position 0 will be selected.
- 3.0.0
- 1.8.2
- 1.8.2
Parameters
- row : Number
Row index to select.
Returns
- void
Sets the value of the accessibilityHidden property.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- accessibilityHidden : Boolean
New value for the property.
Returns
- void
Sets the value of the accessibilityHint property.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- accessibilityHint : String
New value for the property.
Returns
- void
Sets the value of the accessibilityLabel property.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- accessibilityLabel : String
New value for the property.
Returns
- void
Sets the value of the accessibilityValue property.
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- accessibilityValue : String
New value for the property.
Returns
- void
Sets the value of the allowsSelection property.
- 0.8
- 0.8
Parameters
- allowsSelection : Boolean
New value for the property.
Returns
- void
Sets the value of the allowsSelectionDuringEditing property.
- 0.8
- 0.8
Parameters
- allowsSelectionDuringEditing : Boolean
New value for the property.
Returns
- void
Sets the value of the anchorPoint property.
- 0.9
- 0.9
Parameters
- anchorPoint : Point
New value for the property.
Returns
- void
Sets the value of the backgroundColor property.
- 0.9
- 0.9
- 0.9
Parameters
- backgroundColor : String
New value for the property.
Returns
- void
Overrides: Titanium.UI.View.setBackgroundColor
Sets the value of the backgroundDisabledColor property.
- 0.9
Parameters
- backgroundDisabledColor : String
New value for the property.
Returns
- void
Sets the value of the backgroundDisabledImage property.
- 0.9
Parameters
- backgroundDisabledImage : String
New value for the property.
Returns
- void
Sets the value of the backgroundFocusedColor property.
- 0.9
Parameters
- backgroundFocusedColor : String
New value for the property.
Returns
- void
Sets the value of the backgroundFocusedImage property.
- 0.9
Parameters
- backgroundFocusedImage : String
New value for the property.
Returns
- void
Sets the value of the backgroundGradient property.
Parameters
- backgroundGradient : Gradient
New value for the property.
Returns
- void
Sets the value of the backgroundImage property.
Parameters
- backgroundImage : String
New value for the property.
Returns
- void
Sets the value of the backgroundLeftCap property.
- 0.9
- 0.9
Parameters
- backgroundLeftCap : Number
New value for the property.
Returns
- void
Sets the value of the backgroundRepeat property.
Parameters
- backgroundRepeat : Boolean
New value for the property.
Returns
- void
Sets the value of the backgroundTopCap property.
- 0.9
- 0.9
Parameters
- backgroundTopCap : Number
New value for the property.
Returns
- void
Sets the value of the borderColor property.
Parameters
- borderColor : String
New value for the property.
Returns
- void
Sets the value of the borderRadius property.
Parameters
- borderRadius : Number
New value for the property.
Returns
- void
Sets the value of the borderWidth property.
Parameters
- borderWidth : Number
New value for the property.
Returns
- void
Sets the value of the bottom property.
Parameters
- bottom : Number/String
New value for the property.
Returns
- void
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 clipMode property.
- 3.3.0
- 3.3.0
Parameters
- clipMode : Number
New value for the property.
Returns
- void
Sets this tableview's content insets.
A table view is essentially a scroll view that contains a set of static row views that
represents the content. Thus, the setContentInsets method facilitates a margin, or inset,
distance between the content and the container scroll view.
Typically used with the headerPullView property.
- 2.1.0
- 2.1.0
Parameters
- edgeInsets : TableViewEdgeInsets
Dictionary to describe the insets.
- animated : TableViewContentInsetOption (optional)
Determines whether, and how, the content inset change should be animated.
Returns
- void
Sets the value of the content offset of the table view without animation by default.
- 3.4.0
- 3.4.0
Parameters
- contentOffset : Dictionary
Dictionary with the properties
x,y, andanimated. Thexandycoordinates reposition the top-left point of the scrollable region of the table view. Theanimatedproperty is optional and set tofalseby default.
Returns
- void
Sets the value of the data property.
Parameters
- data : Array<Titanium.UI.TableViewRow>/Array<Titanium.UI.TableViewSection>
New value for the property.
Returns
- void
Sets the value of the dimBackgroundForSearch property.
- 6.2.0
- 6.2.0
Parameters
- dimBackgroundForSearch : Boolean
New value for the property.
Returns
- void
Sets the value of the editable property.
- 0.8
- 0.8
Parameters
- editable : Boolean
New value for the property.
Returns
- void
Sets the value of the editing property.
- 0.8
- 0.8
Parameters
- editing : Boolean
New value for the property.
Returns
- void
Sets the value of the elevation property.
- 5.0.0
Parameters
- elevation : Number
New value for the property.
Returns
- void
Sets the value of the filterAnchored property.
- 3.3.0
- 3.3.0
- 3.3.0
Parameters
- filterAnchored : Boolean
New value for the property.
Returns
- void
Sets the value of the filterAttribute property.
Parameters
- filterAttribute : String
New value for the property.
Returns
- void
Sets the value of the filterCaseInsensitive property.
Parameters
- filterCaseInsensitive : Boolean
New value for the property.
Returns
- void
Sets the value of the focusable property.
- 0.9
Parameters
- focusable : Boolean
New value for the property.
Returns
- void
Sets the value of the headerDividersEnabled property.
- 3.3.0
Parameters
- headerDividersEnabled : Boolean
New value for the property.
Returns
- void
Sets the value of the headerPullView property.
- 2.1.0
- 2.1.0
Parameters
- headerPullView : Titanium.UI.View
New value for the property.
Returns
- void
Sets the value of the headerTitle property.
Parameters
- headerTitle : String
New value for the property.
Returns
- void
Sets the value of the headerView property.
Parameters
- headerView : Titanium.UI.View
New value for the property.
Returns
- void
Sets the value of the height property.
Parameters
- height : Number/String
New value for the property.
Returns
- void
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 hideSearchOnSelection property.
- 0.8
- 0.8
Parameters
- hideSearchOnSelection : Boolean
New value for the property.
Returns
- void
Sets the value of the horizontalWrap property.
- 2.1.0
- 2.1.0
- 2.1.0
Parameters
- horizontalWrap : Boolean
New value for the property.
Returns
- void
Sets the value of the index property.
- 0.8
- 0.8
Parameters
- index : Array<TableViewIndexEntry>
New value for the property.
Returns
- void
Sets the value of the keepScreenOn property.
- 0.9
Parameters
- keepScreenOn : Boolean
New value for the property.
Returns
- void
Sets the value of the layout property.
Parameters
- layout : String
New value for the property.
Returns
- void
Sets the value of the left property.
Parameters
- left : Number/String
New value for the property.
Returns
- void
Sets the value of the lifecycleContainer property.
- 3.6.0
Parameters
- lifecycleContainer : Titanium.UI.Window/Titanium.UI.TabGroup
New value for the property.
Returns
- void
Sets the value of the maxClassname property.
- 5.2.0
Parameters
- maxClassname : Number
New value for the property.
Returns
- void
Sets the value of the maxRowHeight property.
Parameters
- maxRowHeight : Number
New value for the property.
Returns
- void
Sets the value of the minRowHeight property.
Parameters
- minRowHeight : Number
New value for the property.
Returns
- void
Sets the value of the moveable property.
- 0.8
- 0.8
Parameters
- moveable : Boolean
New value for the property.
Returns
- void
Sets the value of the moving property.
- 0.8
- 0.8
Parameters
- moving : Boolean
New value for the property.
Returns
- void
Sets the value of the opacity property.
Parameters
- opacity : Number
New value for the property.
Returns
- void
Sets the value of the overScrollMode property.
- 3.1.0
Parameters
- overScrollMode : Number
New value for the property.
Returns
- void
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.
- 5.1.0
Parameters
- previewContext : Titanium.UI.iOS.PreviewContext
New value for the property.
Returns
- void
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 refreshControl property.
- 6.2.0
- 3.2.0
- 3.2.0
Parameters
- refreshControl : Titanium.UI.RefreshControl
New value for the property.
Returns
- void
Sets the value of the right property.
Parameters
- right : Number/String
New value for the property.
Returns
- void
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.
- 5.4.0
Parameters
- rotationX : Number
New value for the property.
Returns
- void
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 rowHeight property.
Parameters
- rowHeight : Number
New value for the property.
Returns
- void
Sets the value of the rowSeparatorInsets property.
- 5.2.0
- 5.2.0
Parameters
- rowSeparatorInsets : Dictionary
New value for the property.
Returns
- void
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.
- 5.4.0
Parameters
- scaleY : Number
New value for the property.
Returns
- void
Sets the value of the scrollIndicatorStyle property.
- 2.1.0
- 2.1.0
Parameters
- scrollIndicatorStyle : Number
New value for the property.
Returns
- void
Sets the value of the scrollable property.
- 0.8
- 0.8
Parameters
- scrollable : Boolean
New value for the property.
Returns
- void
Sets the value of the scrollsToTop property.
- 2.1.2
- 2.1.2
Parameters
- scrollsToTop : Boolean
New value for the property.
Returns
- void
Sets the value of the search property.
Parameters
- search : Titanium.UI.SearchBar/Titanium.UI.Android.SearchView
New value for the property.
Returns
- void
Sets the value of the searchAsChild property.
- 3.0.2
Parameters
- searchAsChild : Boolean
New value for the property.
Returns
- void
Sets the value of the searchHidden property.
- 0.8
- 0.8
Parameters
- searchHidden : Boolean
New value for the property.
Returns
- void
Sets the value of the sections property.
- 3.1.0
- 3.0.0
- 3.0.0
Parameters
- sections : Array<Titanium.UI.TableViewSection>
New value for the property.
Returns
- void
Sets the value of the separatorColor property.
Parameters
- separatorColor : String
New value for the property.
Returns
- void
Sets the value of the separatorInsets property.
deprecated since 5.2.0
Use <Titanium.UI.TableView.tableSeparatorInsets> instead.
- 3.2.0
- 3.2.0
Parameters
- separatorInsets : Dictionary
New value for the property.
Returns
- void
Sets the value of the separatorStyle property.
- 5.2.0
- 0.8
- 0.8
Parameters
- separatorStyle : Number
New value for the property.
Returns
- void
Sets the value of the showVerticalScrollIndicator property.
- 0.8
- 0.8
Parameters
- showVerticalScrollIndicator : Boolean
New value for the property.
Returns
- void
Sets the value of the softKeyboardOnFocus property.
- 0.9
Parameters
- softKeyboardOnFocus : Number
New value for the property.
Returns
- void
Sets the value of the style property.
- 0.8
- 0.8
Parameters
- style : Number
New value for the property.
Returns
- void
Sets the value of the tableSeparatorInsets property.
- 5.2.0
- 5.2.0
Parameters
- tableSeparatorInsets : Dictionary
New value for the property.
Returns
- void
Sets the value of the tintColor property.
- 3.1.3
- 3.1.3
Parameters
- tintColor : String
New value for the property.
Returns
- void
Sets the value of the top property.
Parameters
- top : Number/String
New value for the property.
Returns
- void
Sets the value of the touchEnabled property.
Parameters
- touchEnabled : Boolean
New value for the property.
Returns
- void
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.
- 6.1.0
Parameters
- touchFeedbackColor : String
New value for the property.
Returns
- void
Sets the value of the transform property.
Parameters
- transform : Titanium.UI.2DMatrix/Titanium.UI.3DMatrix
New value for the property.
Returns
- void
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.
- 5.0.0
Parameters
- translationX : Number
New value for the property.
Returns
- void
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.
- 5.0.0
Parameters
- translationZ : Number
New value for the property.
Returns
- void
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.
- 3.3.0
- 3.3.0
Parameters
- viewShadowOffset : Point
New value for the property.
Returns
- void
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.
Parameters
- visible : Boolean
New value for the property.
Returns
- void
Sets the value of the width property.
Parameters
- width : Number/String
New value for the property.
Returns
- void
Sets the value of the zIndex property.
Parameters
- zIndex : Number
New value for the property.
Returns
- void
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.
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
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
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
Updates an existing row, optionally with animation.
Parameters
- index : Number
Index of the row to update.
- row : Titanium.UI.TableViewRow
Row data to update.
- animation : TableViewAnimationProperties
Animation properties. (iOS only.)
Returns
- void
Updates an existing section, optionally with animation.
Known issues:
- On iOS, event listeners do not fire correctly after table view sections are
updated using the
updateSectionmethods. (TIMOB-12616
- 3.0.0
- 3.0.0
- 3.0.0
Parameters
- index : Number
Index of the section to update.
- section : Titanium.UI.TableViewSection
section data to update.
- animation : TableViewAnimationProperties
Animation properties. (iOS only.)
Returns
- void
Events
Fired when a table row is clicked by the user.
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.
- 0.9
- 0.9
- 0.9
Properties
- detail : Boolean
Indicates whether the detail button was clicked. Only
trueifrow.hasDetailistrueand the detail button was clicked. - index : Number
Row index.
- row : Titanium.UI.TableViewRow
Table view row object.
- rowData : Dictionary<Titanium.UI.TableViewRow>
Properties of the row.
When the row is created implicitly using a JavaScript dictionary object, use this property rather than
rowto access any custom row properties.Here's an example of creating a row implicitly, which is not the recommended way.
var data = [{title:'Row 1', hasChild:true, color:'red', selectedColor:'#fff', special:'special 1'},]; var table = Ti.UI.createTableView({data: data}); - searchMode : Boolean
Indicates whether the table is in search mode.
- section : Titanium.UI.TableViewSection
Table view section object, if the clicked row is contained in a section.
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview'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.
Overrides: Titanium.UI.View.click
Fired when the device detects a double click against the view.
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview'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 table row is deleted by the user.
- 0.8
- 0.8
Properties
- detail : Boolean
Indicates whether the delete button was clicked. Always
falsefor this event. - index : Number
Row index.
- row : Titanium.UI.TableViewRow
Table view row object.
- rowData : Dictionary<Titanium.UI.TableViewRow>
Properties of the row. Use this property rather than
rowto access any custom row properties. - searchMode : Boolean
Indicates whether the table is in search mode. Always
falsefor this event. - section : Titanium.UI.TableViewSection
Table view section object, if the deleted row is contained in a section.
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview'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 this view.
- 0.9
- 0.9
- 0.9
Properties
- index : Number
Row index.
- row : Titanium.UI.TableViewRow
Table view row object.
- rowData : Dictionary<Titanium.UI.TableViewRow>
Properties of the row.
When the row is created implicitly using a JavaScript dictionary object, use this property rather than
rowto access any custom row properties.Here's an example of creating a row implicitly, which is not the recommended way.
var data = [{title:'Row 1', hasChild:true, color:'red', selectedColor:'#fff', special:'special 1'},]; var table = Ti.UI.createTableView({data: data}); - x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview'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.
Overrides: Titanium.UI.View.doubletap
Fired when the scrollable region stops being dragged.
deprecated since 3.0.0
Use <Titanium.UI.TableView.dragend> instead.
A dragging gesture is when a touch remains in contact with the display to physically drag the view, as opposed to it being the result of scrolling momentum.
- 0.8
- 0.8
Properties
- decelerate : Boolean
Indicates whether scrolling will continue but decelerate, now that the drag gesture has been released by the touch. If
false, scrolling will stop immediately. - 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 scrollable region starts being dragged.
deprecated since 3.0.0
Use <Titanium.UI.TableView.dragstart> instead.
A dragging gesture is when a touch remains in contact with the display to physically drag the view, as opposed to it being the result of scrolling momentum.
- 0.8
- 0.8
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 scrollable region stops being dragged.
A dragging gesture is when a touch remains in contact with the display to physically drag the view, as opposed to it being the result of scrolling momentum.
- 3.0.0
- 3.0.0
Properties
- decelerate : Boolean
Indicates whether scrolling will continue but decelerate, now that the drag gesture has been released by the touch. If
false, scrolling will stop immediately. - 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 scrollable region starts being dragged.
A dragging gesture is when a touch remains in contact with the display to physically drag the view, as opposed to it being the result of scrolling momentum.
- 3.0.0
- 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.
Fired when the index bar is clicked by the user.
If the tabe view contains the index array of indices the index bar will appear on the side. This event will fire when this bar is clicked
- 3.4.0
- 3.4.0
Properties
- title : String
The title of the index clicked.
- index : Number
The index number clicked.
- 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 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.
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.
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.
- 0.9
- 0.9
- 0.9
Properties
- index : Number
Row index.
- row : Titanium.UI.TableViewRow
Table view row object.
- rowData : Dictionary<Titanium.UI.TableViewRow>
Properties of the row.
When the row is created implicitly using a JavaScript dictionary object, use this property rather than
rowto access any custom row properties.Here's an example of creating a row implicitly, which is not the recommended way.
var data = [{title:'Row 1', hasChild:true, color:'red', selectedColor:'#fff', special:'special 1'},]; var table = Ti.UI.createTableView({data: data}); - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - x : Number
X coordinate of the event from the
sourceview'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.
Overrides: Titanium.UI.View.longpress
Fired when a table row is moved by the user.
- 0.8
- 0.8
Properties
- detail : Boolean
Boolean to indicate if the right area was clicked. Always
falsefor this event. - index : Number
Row index.
- searchMode : Boolean
Boolean to indicate if the table is in search mode. Always
falsefor this event. - section : Titanium.UI.TableViewSection
Table view section object, if the deleted row is contained in a section.
- row : Titanium.UI.TableViewRow
Table view row object.
- rowData : Dictionary<Titanium.UI.TableViewRow>
Properties of the row. Use this property rather than
rowto access any custom row properties. - x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview'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 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.
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.
Fired when the table view is scrolled.
Properties
- contentOffset : Point
Dictionary with
xandyproperties containing the content offset. - contentSize : Dictionary
Dictionary with
widthandheightproperties containing the size of the content (regardless of the display size in the case of scrolling). - firstVisibleItem : Number
Row index of the topmost visible row in the view.
- size : Dictionary
Dictionary with
widthandheightproperties containing the size of the visible table view - totalItemCount : Number
Total number of rows in the view.
- visibleItemCount : Number
Number of rows currently visible in the view.
- 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 table view stops scrolling.
deprecated since 3.0.0
Use <Titanium.UI.TableView.scrollend> instead.
Properties
- contentSize : Dictionary
Dictionary with
widthandheightproperties containing the size of the content (regardless of the display size in the case of scrolling). - contentOffset : Point
Dictionary with
xandyproperties containing the content offset. - size : Dictionary
Dictionary with
widthandheightproperties containing the size of the visible table view. - x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview'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 table view stops scrolling.
- 3.0.0
- 3.0.0
- 3.0.0
Properties
- contentSize : Dictionary
Dictionary with
widthandheightproperties containing the size of the content (regardless of the display size in the case of scrolling). - contentOffset : Point
Dictionary with
xandyproperties containing the content offset. - size : Dictionary
Dictionary with
widthandheightproperties containing the size of the visible table view. - x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview'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 single tap against the view.
- 0.9
- 0.9
- 0.9
Properties
- index : Number
Row index.
- row : Titanium.UI.TableViewRow
Table view row object.
- rowData : Dictionary<Titanium.UI.TableViewRow>
Properties of the row.
When the row is created implicitly using a JavaScript dictionary object, use this property rather than
rowto access any custom row properties.Here's an example of creating a row implicitly, which is not the recommended way.
var data = [{title:'Row 1', hasChild:true, color:'red', selectedColor:'#fff', special:'special 1'},]; var table = Ti.UI.createTableView({data: data}); - x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview'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.
Overrides: Titanium.UI.View.singletap
Fired when the device detects a swipe gesture (left or right) against the view.
- 2.1.0
- 2.1.0
- 2.1.0
Properties
- direction : String
Direction of the swipe, either
leftorright. - index : Number
Row index.
- row : Titanium.UI.TableViewRow
Table view row object.
- rowData : Dictionary<Titanium.UI.TableViewRow>
Properties of the row.
When the row is created implicitly using a JavaScript dictionary object, use this property rather than
rowto access any custom row properties.Here's an example of creating a row implicitly, which is not the recommended way.
var data = [{title:'Row 1', hasChild:true, color:'red', selectedColor:'#fff', special:'special 1'},]; var table = Ti.UI.createTableView({data: data}); - x : Number
X coordinate of the event's endpoint from the
sourceview's coordinate system. - y : Number
Y coordinate of the event's endpoint from the
sourceview'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.
Overrides: Titanium.UI.View.swipe
Fired when a touch gesture is interrupted by the device.
Generated in various circumstances, including an incoming call to allow the UI to clean up state.
On Android and iOS, be aware that a row or table touch event and a table
scroll event cannot occur concurrently. If a table begins
to scroll during a touch event, the appropriate row or table touchcancel event fire
before the scroll event begins.
- 0.9
- 0.9
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - force : Number
The current force value of the touch event. Note: This property only available for iOS devices that support 3D-Touch and run 9.0 or later.
- 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.
- 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.touchcancel
Fired when a touch gesture is complete.
On Android and iOS, be aware that a row or table touch event and a table
scroll event cannot occur concurrently. If a table begins
to scroll during a touch event, the appropriate row or table touchcancel event fire
before the scroll event begins.
- 0.9
- 0.9
- 0.9
Properties
- index : Number
Row index.
- row : Titanium.UI.TableViewRow
Table view row object.
- rowData : Dictionary<Titanium.UI.TableViewRow>
Properties of the row.
When the row is created implicitly using a JavaScript dictionary object, use this property rather than
rowto access any custom row properties.Here's an example of creating a row implicitly, which is not the recommended way.
var data = [{title:'Row 1', hasChild:true, color:'red', selectedColor:'#fff', special:'special 1'},]; var table = Ti.UI.createTableView({data: data}); - x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - force : Number
The current force value of the touch event. Note: This property only available for iOS devices that support 3D-Touch and run 9.0 or later.
- 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.
- 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.touchend
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
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview'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 against this view.
On Android and iOS, be aware that a row or table touch event and a table
scroll event cannot occur concurrently. If a table begins
to scroll during a touch event, the appropriate row or table touchcancel event fire
before the scroll event begins.
- 0.9
- 0.9
- 0.9
Properties
- index : Number
Row index.
- row : Titanium.UI.TableViewRow
Table view row object.
- rowData : Dictionary<Titanium.UI.TableViewRow>
Properties of the row.
When the row is created implicitly using a JavaScript dictionary object, use this property rather than
rowto access any custom row properties.Here's an example of creating a row implicitly, which is not the recommended way.
var data = [{title:'Row 1', hasChild:true, color:'red', selectedColor:'#fff', special:'special 1'},]; var table = Ti.UI.createTableView({data: data}); - x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview's coordinate system. - force : Number
The current force value of the touch event. Note: This property only available for iOS devices that support 3D-Touch and run 9.0 or later.
- 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.
- 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.touchstart
Fired when the device detects a two-finger tap against the view.
- 0.9
- 0.9
Properties
- x : Number
X coordinate of the event from the
sourceview's coordinate system. - y : Number
Y coordinate of the event from the
sourceview'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.
Overrides: Titanium.UI.View.twofingertap