You are reading 13.2.0. See this page in 13.4.1.
Titanium.UI.TableViewSection
Extends Titanium.Proxy
A table view section is a container within a table used to organize table view rows.
Use the Titanium.UI.createTableViewSection method or <TableViewSection> Alloy element to
create a TableViewSection.
Before the table is rendered, the TableViewSection add
method may be used to add TableViewRow objects to a section. After
it is rendered, one of the TableView insertRowBefore,
insertRowAfter, or
appendRow methods must be used instead.
To remove a row from a section after the table is rendered, use the 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
TableViewsections property. - To add an individual section after a table view is rendered, use either the
TableViewinsertSectionBefore or insertSectionAfter method. - To add one or more sections to the end of a table view after it is rendered, use the
TableViewappendSection method. - To remove an individual section after a table view is rendered, use the
TableViewdeleteSection method.
Prior to Release 3.0, adding or removing sections individually is not supported. Instead, use the
TableView data property to refresh the whole table with a
new section layout.
See the description and examples sections of 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 View). However, this is an
implementation detail. For portability, you should only use the documented APIs on
table view sections.
Properties 9
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
footerTitle
StringTitle 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.
View 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
StringTitle 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.
View 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>Inherited from Titanium.Proxy
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
Number of rows in this section.
Rows in this section.
Methods 7
Adds 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 | Type | Description |
|---|---|---|
| row | Titanium.UI.TableViewRow | Row to add. |
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | 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. |
Removes 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 | Type | Description |
|---|---|---|
| row | Titanium.UI.TableViewRow | Row to remove. |
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|
rowAtIndex
AndroidReturns a row in this section.
| Parameters | Type | Description |
|---|---|---|
| index | Number | Section index of a row. |