Table
Overview
Creates a table view to place UI elements into a column and row grid system. It also provides the ability to highlight rows, columns and allow users to move items up or down.
Members
Description
Gets or sets whether a table will have alternating colors or not. The alternating colors default to system values.
Definition
boolean table.alternatingColorsDescription
Gets or sets whether the columns can be resized by the user.
Definition
boolean table.columnsCanBeResized (default true)Description
Gets or sets whether no items are allowed to be selected, the default value is true. Note that if set to false, and no item is selected use selectedRows to specify a default selection. This only prevents the user for deselecting an item it does not prevent no items from being selected.
Definition
boolean table.emptySelectionDescription
Gets or sets whether multiple items can be selected, the default value is true.
Definition
boolean table.multipleSelectionDescription
Gets the number of columns in the table.
Definition
number table.numberOfColumnsDescription
Gets the number of rows in the table.
Definition
number table.numberOfRowsDescription
Gets or sets the height of the rows by pixel value. Note that setting this will override the value of rowHeightStyle.
Definition
number table.rowHeightDescription
Gets or sets the height of the row based on user preferences and system recommendations, this can be either "default", "small", "medium" or "large". Note that this will override the value of rowHeight.
Definition
string table.rowHeightStyleDescription
Gets or sets an array of the rows that are selected. The array contains the indexes of all the rows selected.
Definition
array table.selectedRowsDescription
Gets or sets the horizontal intercell spacing between cells in logical pixels. The default value depends on the native OS defaults.
Definition
number table.spaceXDescription
Gets or sets the vertical intercell spacing between cells in logical pixels. The default value depends on the native OS defaults.
Definition
number table.spaceYMethods
Description
Adds a new column to the table, the columns name is used in the header's label, and uniquely identifies the column in the table (regardless if its moved by a user).
Definition
table.addColumn(columnName)Parameters
| Name | Type | Description |
|---|---|---|
| columnName | string | The name used for identifying the column and the label used in the header. |
Description
Appends a new row to the end of the table, if a index is passed in the row is added at that location.
Definition
table.addRow(rowIndex)Parameters
| Name | Type | Description |
|---|---|---|
| rowIndex | number | A positive whole number that represents the index to add a row at, if nothing is passed for this value the row is appended to the end of the table. |
Description
Moves the column specified by fromIndex to the location specified by toIndex.
Definition
table.moveColumn(fromIndex, toIndex)Parameters
| Name | Type | Description |
|---|---|---|
| fromIndex | number | A positive whole number that represents the column's index to move from. |
| toIndex | number | A positive whole number that represents the column's index to move to. |
Description
Moves the row specified by fromIndex to the location specified by toIndex.
Definition
table.moveRow(fromIndex, toIndex)Parameters
| Name | Type | Description |
|---|---|---|
| fromIndex | number | A positive whole number that represents the row's index to move from. |
| toIndex | number | A positive whole number that represents the row's index to move to. |
Description
Removes the column specified by the name passed in (or the headers label).
Definition
table.removeColumn(columnName)Parameters
| Name | Type | Description |
|---|---|---|
| columnName | string | The name used for identifying the column and the label used in the header. |
Description
Removes the last row in the table, if an index is passed in the specified row is removed.
Definition
table.removeRow(rowIndex)Parameters
| Name | Type | Description |
|---|---|---|
| rowIndex | number | A positive whole number that represents the index to remove. |
Description
Resizes a column's width to the specified width passed in.
Definition
table.setColumnWidth(columnName, width)Parameters
| Name | Type | Description |
|---|---|---|
| columnName | string | The name of the column (or header's label). |
| width | number | A positive whole number that represents the logical pixel width of the column. |
Description
Set the value of the specified cell at the column indicated by columnName, and the row indicated by rowIndex. The value can be either a user interface control string.
Definition
table.setValueAt(columnName, rowIndex, control)Parameters
| Name | Type | Description |
|---|---|---|
| columnName | string | The name of the column (or header's label). |
| rowIndex | number | A positive whole number that represents the rows index. |
| control | Control | Control to render at the specified row and column. This can be either a string, or any user interface control. |
Description
Set the value of the specified cell at the column indicated by columnName, and the row indicated by rowIndex. The value can be either a user interface control string.
Definition
table.setValueAt(columnName, rowIndex, text)Parameters
| Name | Type | Description |
|---|---|---|
| columnName | string | The name of the column (or header's label). |
| rowIndex | number | A positive whole number that represents the rows index. |
| text | string | Text to render at the specified row and column. This can be either a string, or any user interface control. |
Events
Description
Fires when the user clicks a column (e.g., after any processing has occured).
Definition
table.addEventListener('column-clicked', function() { ... });Description
Fires when the user begins to click a column but prior to any processing.
Definition
table.addEventListener('column-mousedown', function() { ... });Description
Fires when a new row is added to the table by the user or programmatically.
Definition
table.addEventListener('row-added', function() { ... });Description
Fires when a row is removed form the table by the user or programmatically.
Definition
table.addEventListener('row-removed', function() { ... });Description
Fires when the selected rows change by the user or programmatically. This fires prior to the selection actually changing.
Definition
table.addEventListener('select', function() { ... });Description
Fires when the selected rows change by the user or programmatically. This fires after the selection has changed.
Definition
table.addEventListener('selected', function() { ... });