When true columns can be unsorted upon clicking sort.
A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.
Defines the cell edit behavior.
Separator text to use in output mode of editable cells with multiple components.
Caches the next page asynchronously.
true to disable the context menu when the DataTable has got on
data row, or false otherwise.
Disables text selection on row click.
Columns can be reordered with drag & drop when enabled.
When enabled, rows can be reordered using drag & drop.
Event that triggers row/cell editing.
Whether rows may be edited as a whole or whether each cell can be edited individually.
Controls in-cell editing.
true if rows are expandable, or false otherwise.
true if filtering is enabled, or false otherwise.
Delay for filtering in milliseconds.
Event to invoke filtering for input filters.
ID of the form to use for AJAX requests.
The number of frozen columns.
The client-side ID of the widget, with all parent naming containers, such as
myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs
multiple container elements (such as Paginator), this may also be an array if IDs.
Columns are resized live in this mode without using a resize helper.
Enables live scrolling.
Percentage of the height of the buffer between the bottom of the page and the
scroll position to initiate the load for the new chunk. This value is in the range 0...100.
true if sorting by multiple columns is enabled, or false otherwise.
Whether multiple resize mode is enabled.
true to use native radio button and checkbox elements, or false otherwise.
Callback that is invoked when the user clicked on a row of the DataTable.
An optional callback that is invoked
after this widget was created successfully, at the end of the init method. This is
usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called
during a refresh (AJAX update).
An optional callback that is invoked after
this widget was refreshed after an AJAX update, at the end of the refresh method.
This is usually specified via the widgetPostRefresh attribute on the JSF component.
An optional callback that is invoked before
this widget is about to be destroyed, e.g., when the component was removed at the end of an AJAX update. This is
called at the beginning of the destroy method. This is usually specified via the
widgetPreDestroy attribute on the JSF component.
Reflow mode is a responsive mode to display columns as stacked depending on screen size.
Enables column resizing.
Defines the resize behavior.
CSS selector for the draggable handle.
Defines the row edit.
Defines row expand mode.
Adds hover effect to rows. Hover is always on when selection is enabled.
CSS selector find finding the rows of this DataTable.
Saves the changes in cell editing on blur, when set to false changes are discarded.
Scroll viewport height.
Maximum number of rows that may be loaded via live scrolling.
Number of additional rows to load in each live scroll.
Scroll viewport width.
Makes data scrollable with fixed header.
Enables row selection.
When using a paginator and selection mode is checkbox, the select all
checkbox in the header will select all rows on the current page if true, or all rows on all pages if false.
Default is true.
Defines row selection mode when clicking on the row itself.
IDs of the columns by which to order. Order by the first column, then by the second, etc.
true if sorting is enabled on the DataTable, false otherwise.
Sticky header stays in window viewport during scrolling.
Selector to position on the page according to other fixing elements on the top of the table.
The value of the tabindex attribute for this DataTable.
Loads data on demand as the scrollbar gets close to the bottom.
The name of the widget variables of this widget. The widget variable can be used to
access a widget instance by calling PF("myWidgetVar").
Generated using TypeDoc
The configuration for the DataTable widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.