| Info | Value |
|---|---|
| Component Type | org.primefaces.component.DataTable |
| Handler Class | org.primefaces.component.datatable.DataTableHandler |
| Renderer Type | None |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
allowUnsorting | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines whether columns are allowed to be unsorted.Default is false. |
ariaRowLabel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Label to read by screen readers on checkbox and radio selection. |
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| An EL expression referring to a server side UIComponent instance in a backing bean.Default is generated. |
cellEditMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the cell edit behavior, valid values are "eager" and "lazy".Default is eager. |
cellNavigation | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enables cell navigation with the keyboard for WCAG and screen reader compliance.Default is true. |
cellSeparator | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Separator text to use in output mode of editable cells with multiple components. |
clientCache | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Caches the next page asynchronously.Default is false. |
currentPageReportTemplate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Template of the currentPageReport UI.Default is ({currentPage} of {totalPages}). |
dataLocale | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Locale to be used in features such as sorting.Default is The view locale. |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines text direction, valid values are ltr and rtl.Default is ltr. |
disableContextMenuIfEmpty | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Decides whether to disable context menu or not if a table has no records.Default is false. |
draggableColumns | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Decides whether datatable columns can be reordered using dragdrop.Default is false. |
draggableRows | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, rows can be reordered using dragdrop.Default is false. |
draggableRowsFunction | false | jakarta.el.ValueExpression
(must evaluate to jakarta.el.MethodExpression)
| Method expression to execute after dragging row. |
editable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Controls incell editing.Default is false. |
editingRow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if cell editors of row should be displayed as editable or not. False means display mode.Default is false. |
editInitEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines a client side event to open cell on editable table.Default is click. |
editMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines edit mode, valid values are "row" and "cell".Default is row. |
emptyMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Text to display when there is no data to display.Default is i18n. |
escapeText | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if headerText and footerText values on columns are escaped or not.Default is true. |
expandedRow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if row should be rendered as expanded by default.Default is false. |
exportRowTag | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| If XML data exporter in use, this allows customization of the row tag in the XML. |
exportTag | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| If XML data exporter in use, this allows customization of the document tag in the XML. |
filterBy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Property to be used for filtering. |
filterDelay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay to wait in milliseconds before sending each filter query.Default is 300. |
filteredValue | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| List to keep the filtered data if filtering is enabled. |
filterEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side event to invoke filtering. If "enter" it will only filter after ENTER key is pressed.Default is keyup. |
filterNormalize | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if filtering would be done using normalized values (accents will be removed from characters).Default is false. |
first | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Index of the first data to display.Default is 0. |
frozenColumns | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Number of columns to freezeDefault is 0. |
frozenColumnsAlignment | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the alignment of frozen columns, valid values are 'left' and 'right'.Default is left. |
frozenRows | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Number of rows to freeze starting from the beginning.Default is 0. |
globalFilter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Value of the global filter to use when filtering by default. |
globalFilterFunction | false | jakarta.el.ValueExpression
(must evaluate to jakarta.el.MethodExpression)
| Custom implementation to globally filter a value against a constraint. |
globalFilterOnly | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true this will hide all column filters and allow all columns to be filtered by global filter only.Default is false. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer.Default is generated. |
lazy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if lazy loading is enabled for the data component.Default is True, if the value-binding is instance of LazyDataModel.. |
liveResize | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Columns are resized live in this mode without using a resize helper.Default is false. |
liveScroll | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enables live scrolling.Default is false. |
liveScrollBuffer | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Percentage height of the buffer between the bottom of the page and the scroll position to initiate the load for the new chunk. Value is defined in integer.Default is 0. |
multiViewState | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to keep component state across views.Default is false. |
nativeElements | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| In native mode, treetable uses native checkboxes.Default is false. |
onExpandStart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute before row expansion. |
onRowClick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute after clicking row. |
pageLinks | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum number of page links to display.Default is 10. |
paginator | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enables pagination.Default is false. |
paginatorAlwaysVisible | false | jakarta.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. |
paginatorPosition | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the paginator.Default is bottom. |
paginatorTemplate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Template of the paginator.Default is {FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink} {RowsPerPageDropdown}. |
partialUpdate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When disabled, it updates the whole table instead of updating a specific field such as body element in the client requests of the dataTable.Default is true. |
reflow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Reflow mode is a responsive mode to display columns as stacked depending on screen size.Default is false. |
rendered | false | jakarta.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.Default is true. |
renderEmptyFacets | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Render facets even if their children are not rendered.Default is false. |
resizableColumns | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Decides whether datatable columns are resizable or not.Default is false. |
resizeMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the resize behavior, valid values are "fit" and expand.Default is fit. |
rowDragSelector | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the element used to reorder rows using dragdrop.Default is td,span:not(.ui-c). |
rowEditMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the row edit behavior, valid values are "eager" and "lazy".Default is eager. |
rowExpandMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines row expand mode, valid values are "single" and "multiple".Default is multiple. |
rowHover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Adds hover effect to rows, default is false. Hover is always on when selection is enabled.Default is false. |
rowIndexVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of iterator to refer each row index. |
rowKey | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of row data. |
rows | false | jakarta.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.Default is 0. |
rowSelector | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side check if rowclick triggered row click event not a clickable element in row content. |
rowsPerPageTemplate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Template of the rowsPerPage dropdown. |
rowStatePreserved | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Keeps state of its children on a per-row basis.Default is false. |
rowStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class for each row. |
rowTitle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Title for each row. |
saveOnCellBlur | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Saves the changes in cell editing on blur, when set to false changes are discarded.Default is true. |
scrollable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Makes data scrollable with fixed header.Default is false. |
scrollHeight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Height for scrollable data. |
scrollRows | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Number of rows to display in virtual scrolling mode.Default is 0. |
scrollWidth | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Width for scrollable data. |
selectAllFilteredOnly | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, toggle select will only apply on filtered items.Default is false. |
selection | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Reference to the selection data. |
selectionDisabled | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables row selection when true.Default is false. |
selectionMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Enables data selection, valid values are "single" and "multiple".Default is Detected though the "selection" value expression.. |
selectionPageOnly | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When using paginator and checkbox selection mode the select all checkbox in header will select the current page if true or all rows if false.Default is true. |
selectionRowMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Indicates how rows of a DataTable may be selected, when clicking on the row itself (not the checkbox / radiobutton from p:column). The value `new` always unselects other rows, `add` preserves the currently selected rows, and `none` disables row selection.Default is new. |
selectionTextDisabled | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables text selection on row click.Default is true. |
showGridlines | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enables, cell borders are displayed.Default is false. |
showSelectAll | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to show the select all checkbox inside the column's header.Default is true. |
size | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Size of the table content, valid values are "small", "regular" and "large".Default is regular. |
skipChildren | false | jakarta.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. |
sortBy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Property to be used for sorting. |
sortMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines sorting mode, valid values are "single" and "multiple".Default is multiple. |
stickyHeader | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Sticky header stays in window viewport during scrolling.Default is false. |
stickyTopAt | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Selector to position on the page according to other fixing elements on the top of the table. |
stripedRows | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to display striped rows to visually separate content.Default is false. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the component. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the component. |
summary | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Summary attribute for WCAG. |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the element in the tabbing order.Default is 0. |
tableStyle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the table element. |
tableStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the table element. |
touchable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enable touch if supported by device. NULL uses global default or primefaces.TOUCHABLE. Default: globally enabled. |
value | true | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Datasource of the component. |
var | true | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the iterator variable that references each element in the data set. |
virtualScroll | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Loads data on demand as the scrollbar gets close to the bottom.Default is false. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.