Titanium SDK # Titanium.UI.TableViewSection
A table view section is a container within a table used to organize table view rows.
0.9
0.9
9.2.0# Overview
Use the Titanium.UI.createTableViewSection method or <TableViewSection> Alloy element to
create a TableViewSection.
Before the table is rendered, the TableViewSection Titanium.UI.TableViewSection.add
method may be used to add Titanium.UI.TableViewRow objects to a section. After
it is rendered, one of the TableView Titanium.UI.TableView.insertRowBefore,
Titanium.UI.TableView.insertRowAfter, or
Titanium.UI.TableView.appendRow methods must be used instead.
To remove a row from a section after the table is rendered, use the TableView Titanium.UI.TableView.deleteRow method.
In order for a section to be visible, either its headerTitle or headerView property must be
configured.
Starting in Release 3.0, you can directly manipulate the sections in a table using the
following TableView APIs:
- To set all sections in a table view at one time, use the
TableViewTitanium.UI.TableView.sections property. - To add an individual section after a table view is rendered, use either the
TableViewTitanium.UI.TableView.insertSectionBefore or Titanium.UI.TableView.insertSectionAfter method. - To add one or more sections to the end of a table view after it is rendered, use the
TableViewTitanium.UI.TableView.appendSection method. - To remove an individual section after a table view is rendered, use the
TableViewTitanium.UI.TableView.deleteSection method.
Prior to Release 3.0, adding or removing sections individually is not supported. Instead, use the
TableView Titanium.UI.TableView.data property to refresh the whole table with a
new section layout.
See the description and examples sections of Titanium.UI.TableView for more details
about how to use TableViewSection.
Note: On some platforms, TableViewSection may be implemented as a type of view
(that is, an object that inherits from Titanium.UI.View). However, this is an
implementation detail. For portability, you should only use the documented APIs on
table view sections.
# Properties
# apiName READONLY
3.2.0 3.2.0 9.2.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# bubbleParent
3.0.0 3.0.0 9.2.0Indicates 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
# footerTitle
0.9 0.9 9.2.0Title of this section footer.
Using this property and footerView together is not supported. Use one or the other.
On Android, must be set at creation.
# footerView
0.9 0.9 9.2.0View to use for this section footer.
Using this property and footerTitle together is not supported. Use one or the other.
On Android, must be set at creation.
# headerTitle
0.9 0.9 9.2.0Title of this section header.
Using this property and headerView together is not supported. Use one or the other.
On Android, must be set at creation.
# headerView
0.9 0.9 9.2.0View to use for this section header.
Using this property and headerTitle together is not supported. Use one or the other.
On Android, must be set at creation.
In Alloy, you can use a <HeaderView> element inside a <TableViewSection> element:
<Alloy>
<TableView filterAttribute="title">
<SearchBar platform="android,ios"/>
<TableViewSection>
<HeaderView>
<View backgroundColor="#a00" height="50dp"/>
</HeaderView>
<FooterView>
<View backgroundColor="#0a0" height="50dp"/>
</FooterView>
<TableViewRow title="Row 1"/>
<TableViewRow title="Row 2"/>
<TableViewRow title="Row 3"/>
</TableViewSection>
</TableView>
</Alloy>
# lifecycleContainer
3.6.0The 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.
# Methods
# add
0.9 0.9 9.2.0Adds a table view row to this section.
Should be called before adding the section to a table. Calling add on a section
that's already been added to a table does not update the table.
To add a row to a section after it's been added to a table, call one of the
TableView methods, insertRowBefore,
insertRowAfter, or
appendRow.
On Android, it is possible to update a section by adding or removing rows and then
resetting the table view's data property. However, this approach is not
portable and is not recommended.
Parameters
| Name | Type | Description |
|---|---|---|
row | Titanium.UI.TableViewRow | Row to add. |
Returns
- Type
- void
# addEventListener
0.9 0.9 9.2.0Adds the specified callback as an event listener for the named event.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# applyProperties
3.0.0 3.0.0 9.2.0Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# fireEvent
0.9 0.9 9.2.0Fires a synthesized event to any registered listeners.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Returns
- Type
- void
# remove
0.9 0.9 9.2.0Removes a table view row from this section.
Should be called before a section is added to a table. Calling remove on
a section that's already been added to a table may throw an exception.
To delete a row once the section is added to a table, use the TableView
deleteRow method.
On Android, it is possible to update a section by adding or removing rows and then
resetting the table view's data property. However, this approach is not
portable and is not recommended.
Parameters
| Name | Type | Description |
|---|---|---|
row | Titanium.UI.TableViewRow | Row to remove. |
Returns
- Type
- void
# removeEventListener
0.9 0.9 9.2.0Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void
# rowAtIndex
0.9Returns a row in this section.
Parameters
| Name | Type | Description |
|---|---|---|
index | Number | Section index of a row. |