Holds everything a table template needs to render one page of records: the row data, the column definitions, the paginator and a set of CSS classes for the table element. Built by TableViewMetaBuilder, normally obtained from Formatter's newTable helper, rather than constructed directly.
Properties
| Property | Returns | Description |
|---|---|---|
| bodyId | String | Identifier for the table body element, used as its HTML id attribute so client-side script can target it, for example when replacing rows after a paged reload. |
| classes | List<String> | The extra CSS classes to apply to the table element. |
| columns | List<ColumnMeta> | The columns to render, in display order. |
| id | String | Identifier for the table element itself, used as its HTML id attribute. |
| paginator | Paginator | The paginator describing the current page of records and how to navigate to other pages. |
| records | List | The rows to render for the current page of the table. |
| selection | boolean | Whether the table renders a selection checkbox column, allowing rows to be picked for a bulk action. |
Methods
getId()
Returns: String
Identifier for the table element itself, used as its HTML id attribute.
getBodyId()
Returns: String
Identifier for the table body element, used as its HTML id attribute so client-side script can target it, for example when replacing rows after a paged reload.
getPaginator()
Returns: Paginator
The paginator describing the current page of records and how to navigate to other pages.
getRecords()
Returns: List
The rows to render for the current page of the table.
getColumns()
Returns: List<ColumnMeta>
The columns to render, in display order.
getClasses()
Returns: List<String>
The extra CSS classes to apply to the table element.
isSelection()
Returns: boolean
Whether the table renders a selection checkbox column, allowing rows to be picked for a bulk action.