| Info | Value |
|---|---|
| Component Type | org.primefaces.component.DataTable |
| Display Name | None |
| Handler Class | org.primefaces.component.datatable.DataTableHandler |
| Renderer Type | org.primefaces.component.DataTableRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
rendered | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Datasource of the component. |
var | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the iterator variable used to refer each data. |
rows | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Number of rows to display per page. Default value is 0 meaning to display all data available. |
first | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Index of the first data to display. |
widgetVar | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
paginator | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enables pagination. Default is false. |
paginatorTemplate | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Template of the paginator. |
rowsPerPageTemplate | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Template of the rowsPerPage dropdown. |
rowsPerPageLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Label for rowsPerPage dropdown. |
currentPageReportTemplate | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Template of the currentPageReport UI. |
pageLinks | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum number of page links to display. Default is 10. |
paginatorPosition | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the paginator. Default is both. |
paginatorAlwaysVisible | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if paginator should be hidden if total data count is less than number of rows per page. Default is true. |
scrollable | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Makes data scrollable with fixed header. Default is false. |
scrollHeight | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Height for scrollable data. |
scrollWidth | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Width for scrollable data. |
selectionMode | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Enables data selection, valid values are "single" and "multiple". |
selection | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Reference to the selection data. |
rowIndexVar | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of iterator to refer each row index. |
emptyMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text to display when there is no data to display. Default is "No records found." |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the main container. |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the main container. |
liveScroll | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enables live scrolling. Default is false. |
rowStyleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class for each row. |
onExpandStart | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute before row expansion. |
resizableColumns | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Decides whether datatable columns are resizable or not. |
sortBy | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Property to be used for default sorting. |
sortOrder | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Sets sorting order. Default is "ascending" |
sortFunction | false | javax.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| Custom pluggable sortFunction for default sorting. |
scrollRows | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| No Description |
rowKey | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Unique identifier of row data. |
filterEvent | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side event to invoke datatable filtering for input fields. Default is keyup. |
filterDelay | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay to wait in milliseconds before sending each filter query. Default is 300. |
tableStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the table element. |
tableStyleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the table element. |
draggableColumns | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Decides whether datatable columns can be reordered using dragdrop. |
editable | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Controls incell editing. |
lazy | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if lazy loading is enabled for the data component. |
filteredValue | false | javax.el.ValueExpression
(must evaluate to java.util.List)
| List to keep the filtered data if filtering is enabled. |
sortMode | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Defines sorting mode, valid values are "single" (default) and "multiple". |
editMode | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Defines edit mode, valid values are "row" (default) and "cell". |
editingRow | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if cell editors of row should be displayed as editable or not. Default is false meaning display mode. |
cellSeparator | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Separator text to use in output mode of editable cells with multiple components. |
summary | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Summary attribute for WCAG. |
frozenRows | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Number of rows to freeze starting from the beginning. |
dir | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Defines text direction, valid values are "ltr" (default) and "rtl". |
liveResize | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Columns are resized live in this mode without using a resize helper. |
stickyHeader | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Sticky header stays in window viewport during scrolling. |
expandedRow | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if row should be rendered as expanded by default. |
disabledSelection | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables row selection when true. |
rowSelectMode | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Defines row select mode for checkbox based selection, valid values are new (default), add and checkbox. |
rowExpandMode | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Defines row expand mode, valid values are "single" and "multiple" (default). |
dataLocale | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Locale to be used in features such as filtering and sorting, defaults to view locale. |
nativeElements | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| In native mode, datatable uses native radio-checkbox elements for row selection instead of extended ones. |
frozenColumns | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Number of columns to freeze from the start index 0. |
draggableRows | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, rows can be reordered using dragdrop. |
caseSensitiveSort | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Case sensitivity for sorting, insensitive by default. |
skipChildren | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Ignores processing of children during lifecycle, improves performance if table only has output components, default is false. |
disabledTextSelection | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables text selection on row click. Default is true. |
sortField | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the field to pass lazy load method for sorting. If not specified, sortBy expression is used to extract the name. |
Output generated by Vdldoc View Declaration Language Documentation Generator.