TableView

super: UITableView (on iOS)

A TableView displays a list of items in a single column. The TableView uses a TableViewCell template to draw the visible rows of the table. The values for the cells are obtained with the DataSet approach; you can use the built-in data grid (to edit the data grid, double click on the TableView from the design board) or use another object that inherit from the DataSet (recordsets from a databases, sensors, network datasources, etc).

Events

Load() This event is called when the object becames available in the current runtime system.
WillShow() The view is about to be added to the App's views hierarchy.
WillHide() The view is about to be removed from the App's views hierarchy.
RowHeight(section: Int, index: Int): Float This event lets you specify a different height depending of the section and row indexes. If this event is implemented, the return value of this event is used to define the height of the specified row instead of the rowHeight property of the TableView. If the return value is TableViewDimension.Automatic, the table view uses a height that fits the content of the TableViewCell (and its customView).
DidSelectCell(cell: TableViewCell, section: Int, index: Int) This event is called when a row is selected. The parameters contain the instance of the TableViewCell, the section index and the row index of the selected cell.
DidDeselectCell(cell: TableViewCell, section: Int, index: Int) This event is called when a row is deselected. The parameters contain the instance of the TableViewCell, the section index and the row index of the deselected cell.
WillShowCell(cell: TableViewCell, section: Int, index: Int) This event is called when the table is about to draw a cell for a particular row. The parameters contain the instance of the TableViewCell, the section index and the row index of the cell.
CanEditCell(cell: TableViewCell, section: Int, index: Int): Bool The event allows you to exclude individual rows from being treated as editable. Editable rows display the insertion or deletion control in their cells. If this event is not implemented, all rows are assumed to be editable. Return true if you want the cell to be editable, false otherwise.
CommitEdit(cell: TableViewCell, section: Int, index: Int, editingMode: TableViewCellEditingStyle): Bool This event is called when users tap the insertion (green plus) control of an editing row or the Delete confirmation button after a left swipe gesture or after pressing the Delete (red minus) button of an editing row. This event lets you commit the change, for example by performing an insert statement to the DataSet and by invoking the insertRow method of the TableView. In case of Delete editing mode, if the event returns true, the TableView assumes that the DataSet has been updated and proceeds to remove the row; otherwise, if it returns false, the TableView just dismiss the presented action.
WillReload() This event is called when the table and its dataSet are about to be reloaded because of the user did perform the pull-to-reload gesture. Only applies if the reloadOnPull property is true.
DidReload() This event is called when the dataSet of the table completes a reload.
DidScroll() This event is called when the user scrolls the content view.
DidEndDragging(decelerate: Bool) This event is called when dragging ended in the scroll view. The scroll view sends this event when the user’s finger touches up after dragging content. The decelerating property of the scroll view controls deceleration. The decelerate value is true if the scrolling movement will continue, but decelerate, after a touch-up gesture during a dragging operation. If the value is NO, scrolling stops immediately upon touch-up.
DidEndDecelerating() This event is called when the scroll view ends decelerating the scrolling movement.
DidShow() The view has been added to the App's views hierarchy.
DidHide() The view has been removed from the App's views hierarchy.
Unload() This event is called when the object has been removed from the current runtime system (but not yet deallocated).

Properties

var style: TableViewStyle Returns the style of the table view. (read-only)
var rowHeight: Float The height of each row.
var separatorStyle: TableViewCellSeparatorStyle The style for table cells used as separators. By default it uses a single line running across its width.
var separatorColor: Color The color of separator rows in the table view.
var sectionHeaderHeight: Float The height of section headers in the table view.
var sectionFooterHeight: Float The height of section footers in the table view.
var editing: Bool A Boolean value that determines whether the table view is in editing mode.
var allowsSelection: Bool A Boolean value that determines whether users can select a row.
var allowsSelectionDuringEditing: Bool A Boolean value that determines whether users can select cells while the table view is in editing mode.
var allowsMultipleSelection: Bool A Boolean value that controls whether users can select more than one cell simultaneously in editing mode.
var allowsMultipleSelectionDuringEditing: Bool Description not yet ready.
var dataSet: Object The DataSet object provides information that TableView needs to construct its content. The dataSet must return a List of objects and each object represents a different row. If the DataSet value is not flat, for example a Map from a JSON result of an HTTPRequest, the keyPath property defines the list of keys used to browse the data tree to get a List node.
var reloadOnPull: Bool A Boolean value that controls whether the dataSet and the table must be reloaded when the user drags the table over the top.
var pullTitle: String The text to display in the refresh control.
var pullColor: Color The tint color for the title and the activity indicator of the refresh control. If nil, the title and the activity indicator will use their default color.
var selectedRow: IndexPath Returns an index path identifying the row and section at the given point. (read-only)
var selectedRows: List The index paths of the selected rows. (read-only)
var keyPath: String The base keyPath to get a particular node of the DataSet value. The DataSet must provide a List of objects and each object represents a different row. If the DataSet value is not flat, for example a Map from a JSON result of an HTTPRequest, the keyPath defines the list of keys used to browse the data tree to get a List node. The values for each exposed property of the cell are retrieved by adding the current index and the cell property key to the base keyPath.
var objectName: String The name of the object.

Methods

func reload(reloadDataSet: Bool = true, keepSelection: Bool = true) Reloads the content of the table view.
func setEditing(editing: Bool, animated: Bool = true) When you call this method with the value of editing set to true, the table view goes into editing mode by calling on each visible row. Calling this method with editing set to false turns off editing mode. In editing mode, the cells of the table might show an insertion or deletion control on the left side of each cell and a reordering control on the right side, depending on how the cell is configured. You can selectively exclude cells from editing mode by implementing the CanEditItem event.
func numberOfRows(section: Int): Int Returns the number of rows in a specified section.
func numberOfSections(): Int The number of sections in the table view.
func indexPathForRowAtPoint(point: Point): IndexPath Returns an index path identifying the row and section at the given point.
func selectRow(indexPath: Object, animated: Bool = true, scrollPosition: TableViewScrollPosition = 0) Selects a row in the table view identified by index path, optionally scrolling the row to a location in the table view. The scrollPosition is a constant that identifies a relative position in the table view (top, middle, bottom) for the row when scrolling concludes. See TableViewScrollPosition for descriptions of valid constants.
func deselectRow(indexPath: Object, animated: Bool = true) Deselects a given row identified by index path, with an option to animate the deselection.
func scrollToRow(indexPath: Object, scrollPosition: TableViewScrollPosition = 0, animated: Bool = true) Scrolls through the table view until a row identified by index path is at a particular location on the screen.
func insertRow(indexPath: Object, content: Map, rowAnimation: TableViewRowAnimation = 100) Inserts a row in the table view at the specified location; the location can be an IndexPath (row and section) or an Int (row, in this case it refers to the first section). The content parameter is a Map of keys/values used to configure the new TableViewCell; the keys should be the name of a default property (identifier, text, detailText, image) or an exposed property of the optional CustomView. The optional rowAnimation parameter defines the kind of animation to perform when inserting the cell (the animation is not simulated in the Creo Simulator for Mac).
func insertRows(indexPaths: List, content: List, rowAnimation: TableViewRowAnimation = 100) Inserts rows in the table view at the specified locations; the IndexPaths parameter is an array of locations, each location can be an IndexPath (row and section) or an Int (row, in this case it refers to the first section). The content parameter is an List of Maps, one for each row, used to configure the new cells (TableViewCell); the keys should be the name of a default property (identifier, text, detailText, image) or an exposed property of the optional CustomView. The optional rowAnimation parameter defines the kind of animation to perform when inserting the cell (the animation is not simulated in the Creo Simulator for Mac).
func deleteRow(indexPath: Object, rowAnimation: TableViewRowAnimation = 100) Deletes the row specified by an IndexPath (row and section) or an Int (row, in this case it refers to the first section), with an option to animate the deletion (the animation is not simulated in the Creo Simulator for Mac).
func deleteRows(indexPaths: List, rowAnimation: TableViewRowAnimation = 100) Deletes the rows specified by an array of index paths, with an option to animate the deletion (the animation is not simulated in the Creo Simulator for Mac).
func cellForRowAtIndexPath(indexPath: Object): TableViewCell Returns the table cell at the specified index path.
func visibleCells(): List The table cells that are visible in the table view.
func indexPathsForVisibleRows(): List An array of index paths, each identifying a visible row in the table view.
func indexPathForCell(cell: TableViewCell): IndexPath Returns an index path representing the row and section of a given table-view cell.
func animate(duration: Float, delay: Float, options: AnimationOption, animations: Closure, completion: Closure) Animate changes to one or more views using the specified duration, delay, options and completion handler.
func setFocus() Force focus to be set to the selected control. For TextField and TextView that means force Keyboard to appear.
func clearFocus() Clear focus from selected control

Enums

TableViewCellEditingStyle

.Delete
.Insert
.None

TableViewStyle

.Grouped
.Plain

TableViewCellSeparatorStyle

.None
.SingleLine

TableViewScrollPosition

.Bottom
.Middle
.None
.Top

TableViewRowAnimation

.Automatic
.Bottom
.Fade
.Left
.Middle
.None
.Right
.Top

AnimationOption

.AllowAnimatedContent
.AllowUserInteraction
.Autoreverse
.BeginFromCurrentState
.CurveEaseIn
.CurveEaseInOut
.CurveEaseOut
.CurveLinear
.LayoutSubviews
.OverrideInheritedCurve
.OverrideInheritedDuration
.OverrideInheritedOptions
.Repeat
.ShowHideTransitionViews
.TransitionCrossDissolve
.TransitionCurlDown
.TransitionCurlUp
.TransitionFlipFromBottom
.TransitionFlipFromLeft
.TransitionFlipFromRight
.TransitionFlipFromTop
.TransitionNone