Definition of one app-registered query table: the JavaScript function that loads its rows, its column headings and whether it supports pagination. Instances are created by ControllerMappingList.addTableDef and used to build a Table that the reporting and admin table views can query.
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | The human readable name for this table, shown when a user is choosing a data source. |
| functionName | String | The name of the global JavaScript function that loads this table's rows. |
| headers | List<String> | The statically declared column headings for this table, added via addHeader. Empty or null if the headings are instead supplied dynamically by the headers function. |
| headersFn | String | The name of the global JavaScript function that supplies this table's column headings dynamically, if one was registered instead of a static header list. |
| supportsPagination | boolean | Whether this table's rows can be paged through, rather than always being loaded in full. True by default. |
| tableId | String | The unique identifier this table was registered under. |
Methods
getHeaders()
Returns: List<String>
The statically declared column headings for this table, added via addHeader. Empty or null if the headings are instead supplied dynamically by the headers function.
getTableId()
Returns: String
The unique identifier this table was registered under.
getDescription()
Returns: String
The human readable name for this table, shown when a user is choosing a data source.
getFunctionName()
Returns: String
The name of the global JavaScript function that loads this table's rows.
getHeadersFn()
Returns: String
The name of the global JavaScript function that supplies this table's column headings dynamically, if one was registered instead of a static header list.
addHeader(String text)
Returns: RepoQueryTableDef
Appends one column heading to this table's statically declared header list.
| Parameter | Description |
|---|---|
text | the heading text to add |
isSupportsPagination()
Returns: boolean
Whether this table's rows can be paged through, rather than always being loaded in full. True by default.
supportsPagination(boolean b)
Returns: RepoQueryTableDef
Sets whether this table's rows can be paged through.
| Parameter | Description |
|---|---|
b | true if this table supports pagination |