• Settings
    • Locale
    • Change the locale of the datepicker, schedule and client side validation messages.

      Language
      English
      English
      English
      French
      German
      German
      German
      Italian
      Korean
      Spanish
      Catalan
      Dutch
      Portuguese
      Portuguese
      Arabic
      Arabic
      Bulgarian
      Bangla
      Bosnian
      Czech
      Greek
      Estonian
      Persian
      Finnish
      Danish
      Hindi
      Indonesian
      Icelandic
      Croatian
      Japanese
      Hungarian
      Hebrew
      Georgian
      Central Kurdish
      Khmer
      Kyrgyz
      Kazakh
      Lithuanian
      Latvian
      Malay
      Norwegian
      Polish
      Romanian
      Russian
      Slovak
      Slovenian
      Serbian
      Serbian
      Swedish
      Thai
      Turkish
      Ukrainian
      Uzbek
      Vietnamese
      Chinese
      Chinese
  • Resources
Theme
Theme
Preset primefaces.THEME
Apple Liquid Glass style: translucent overlays, menus and bars that blur the page behind them, capsule buttons.
Color scheme color-scheme
Input style p-input-filled
Density data-p-density
Direction primefaces.DIR
Colors
Primary --p-primary-base
Surface --p-surface-*
Shape and motion
Button shape --p-button-border-radius
Shadows --p-*-shadow
Animations --p-transition-duration
Ripple --p-ripple-opacity
Border radius --p-border-radius-*
Typography
Focus ring
Form field
CSS
Only the tokens that differ from the preset.

                        
                    

DataTable Edit

With editable="true" the table is edited in place; p:cellEditor defines the output and input of a column. In row mode, p:rowEditor renders the controls to edit, save or cancel a row. With editMode="cell" a cell is opened by a click, a double click (editInitEvent) or a context menu. The last table appends a row with the client side addRow() method.

DataTable Tag Documentation

DataTable is an enhanced version of the standard Datatable that provides built-in solutions to many commons use cases like paging, sorting, selection, lazy loading, filtering and more.

NameTypeRequiredDefaultDescription
widgetVar String false Deprecated, use ref instead. Name of the client side component.
virtualScroll boolean false false Loads data on demand as the scrollbar gets close to the bottom.
var String true Name of the iterator variable that references each element in the data set.
value Object true Datasource of the component.
touchable Boolean false Enable touch if supported by device. NULL uses global default or primefaces.TOUCHABLE. Default: globally enabled.
tableStyleClass String false Style class of the table element.
tableStyle String false Inline style of the table element.
tabindex String false 0 Position of the element in the tabbing order.
summary String false Summary attribute for WCAG.
styleClass String false Style class of the component.
style String false Inline style of the component.
stripedRows boolean false false Whether to display striped rows to visually separate content.
stickyTopAt String false Selector to position on the page according to other fixing elements on the top of the table.
stickyHeader boolean false false Sticky header stays in window viewport during scrolling.
sortMode String false multiple Defines sorting mode, valid values are "single" and "multiple".
sortBy Object false Property to be used for sorting.
skipChildren boolean false false Ignores processing of children during lifecycle, improves performance if table only has output components.
size String false regular Size of the table content, valid values are "small", "regular" and "large".
showSelectAll boolean false true Whether to show the select all checkbox inside the column's header.
showGridlines boolean false false When enables, cell borders are displayed.
selectionTextDisabled boolean false true Disables text selection on row click.
selectionRowMode String false new 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.
selectionPageOnly boolean false true 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. When false, individual row unselections after 'select all' are preserved even across page navigation.
selectionMode String false Detected though the "selection" value expression. Enables data selection, valid values are "single" and "multiple".
selectionDisabled boolean false false Disables row selection when true.
selection Object false Reference to the selection data.
selectAllFilteredOnly boolean false false When enabled, toggle select will only apply on filtered items.
scrollWidth String false Width for scrollable data.
scrollRows int false 0 Number of rows to display in virtual scrolling mode.
scrollHeight String false Height for scrollable data.
scrollable boolean false false Makes data scrollable with fixed header.
saveOnCellBlur boolean false true Saves the changes in cell editing on blur, when set to false changes are discarded.
rowTitle String false Title for each row.
rowStyleClass String false Style class for each row.
rowStatePreserved boolean false false Keeps state of its children on a per-row basis.
rowsPerPageTemplate String false Template of the rowsPerPage dropdown.
rowSelector String false Client side check if rowclick triggered row click event not a clickable element in row content.
rows int false 0 Number of rows to display per page. Default value is 0 meaning to display all data available.
rowKey String false Unique identifier of row data.
rowIndexVar String false Name of iterator to refer each row index.
rowHover boolean false false Adds hover effect to rows, default is false. Hover is always on when selection is enabled.
rowExpandMode String false multiple Defines row expand mode, valid values are "single" and "multiple".
rowEditMode String false eager Defines the row edit behavior, valid values are "eager" and "lazy".
rowDragSelector String false td,span:not(.p-c) Defines the element used to reorder rows using dragdrop.
resizeMode String false fit Defines the resize behavior, valid values are "fit" and expand.
resizableColumns boolean false false Decides whether datatable columns are resizable or not.
renderEmptyFacets boolean false false Render facets even if their children are not rendered.
rendered boolean false true Boolean value to specify the rendering of the component, when set to false component will not be rendered.
reflow boolean false false Reflow mode is a responsive mode to display columns as stacked depending on screen size.
ref String false generated ('pf_' + componentClientId) Name of the client side component, e.g. to access it via PF('name').
partialUpdate boolean false true When disabled, it updates the whole table instead of updating a specific field such as body element in the client requests of the dataTable.
paginatorTemplate String false {FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink} {RowsPerPageDropdown} Template of the paginator.
paginatorPosition String false bottom Position of the paginator.
paginatorAlwaysVisible boolean false true Defines if paginator should be hidden if total data count is less than number of rows per page.
paginator boolean false false Enables pagination.
pageLinks int false 10 Maximum number of page links to display.
onRowClick String false Client side callback to execute after clicking row.
onExpandStart String false Client side callback to execute before row expansion.
nativeElements boolean false false In native mode, treetable uses native checkboxes.
multiViewState boolean false false Whether to keep component state across views.
liveScrollBuffer int false 0 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.
liveScroll boolean false false Enables live scrolling.
liveResize boolean false false Columns are resized live in this mode without using a resize helper.
lazy boolean false True, if the value-binding is instance of LazyDataModel. Defines if lazy loading is enabled for the data component.
id String false generated Unique identifier of the component in a namingContainer.
globalFilterOnly boolean false false When true this will hide all column filters and allow all columns to be filtered by global filter only.
globalFilterFunction MethodExpression false Custom implementation to globally filter a value against a constraint.
globalFilter String false Value of the global filter to use when filtering by default.
frozenRows int false 0 Number of rows to freeze starting from the beginning.
frozenColumnsAlignment String false left Defines the alignment of frozen columns, valid values are 'left' and 'right'.
frozenColumns int false 0 Number of columns to freeze
first int false 0 Index of the first data to display.
filterNormalize boolean false false Defines if filtering would be done using normalized values (accents will be removed from characters).
filterEvent String false keyup Client side event to invoke filtering. If "enter" it will only filter after ENTER key is pressed.
filteredValue Object false List to keep the filtered data if filtering is enabled.
filterDelay int false 300 Delay to wait in milliseconds before sending each filter query.
filterBy Object false Property to be used for filtering.
exportTag String false If XML data exporter in use, this allows customization of the document tag in the XML.
exportRowTag String false If XML data exporter in use, this allows customization of the row tag in the XML.
expandedRow boolean false false Defines if row should be rendered as expanded by default.
escapeText boolean false true Defines if headerText and footerText values on columns are escaped or not.
emptyMessage String false i18n Text to display when there is no data to display.
editMode String false row Defines edit mode, valid values are "row" and "cell".
editInitEvent String false click Defines a client side event to open cell on editable table.
editingRow boolean false false Defines if cell editors of row should be displayed as editable or not. False means display mode.
editable boolean false false Controls incell editing.
draggableRowsFunction MethodExpression false Method expression to execute after dragging row.
draggableRows boolean false false When enabled, rows can be reordered using dragdrop.
draggableColumns boolean false false Decides whether datatable columns can be reordered using dragdrop.
disableContextMenuIfEmpty boolean false false Decides whether to disable context menu or not if a table has no records.
dir String false ltr Defines text direction, valid values are ltr and rtl.
dataLocale Object false The view locale Locale to be used in features such as sorting.
currentPageReportTemplate String false ({currentPage} of {totalPages}) Template of the currentPageReport UI.
clientCache boolean false false Caches the next page asynchronously.
cellSeparator String false Separator text to use in output mode of editable cells with multiple components.
cellNavigation boolean false true Enables cell navigation with the keyboard for WCAG and screen reader compliance.
cellEditMode String false eager Defines the cell edit behavior, valid values are "eager" and "lazy".
binding UIComponent false generated An EL expression referring to a server side UIComponent instance in a backing bean.
ariaRowLabel String false Label to read by screen readers on checkbox and radio selection.
allowUnsorting boolean false false Defines whether columns are allowed to be unsorted.
Loading...
Row Editing
CodeNameStatusPrice
bfdf4197
Bamboo Watch
INSTOCK
$65.00
f256193b
Black Watch
INSTOCK
$72.00
bba486ee
Blue Band
LOWSTOCK
$79.00
3fdcc6c2
Blue T-Shirt
INSTOCK
$29.00
c8f0ea8c
Bracelet
INSTOCK
$15.00
5731c98c
Brown Purse
OUTOFSTOCK
$120.00
bfd4c679
Chakra Bracelet
LOWSTOCK
$32.00
c53ad67a
Galaxy Earrings
INSTOCK
$34.00
ad35cfc5
Game Controller
LOWSTOCK
$99.00
a765334f
Gaming Set
INSTOCK
$299.00
Cell Editing with Click and RightClick
CodeNameStatusPrice
823a78fb
Bamboo Watch
INSTOCK
$65.00
27f5c389
Black Watch
INSTOCK
$72.00
291d16a8
Blue Band
LOWSTOCK
$79.00
96023e0b
Blue T-Shirt
INSTOCK
$29.00
8cedd6fb
Bracelet
INSTOCK
$15.00
2404bc3c
Brown Purse
OUTOFSTOCK
$120.00
e5868423
Chakra Bracelet
LOWSTOCK
$32.00
8706ce5b
Galaxy Earrings
INSTOCK
$34.00
52b93bcd
Game Controller
LOWSTOCK
$99.00
865563b5
Gaming Set
INSTOCK
$299.00
Cell Editing with Double Click Event (dblclick)
CodeNameStatusPrice
d201e9db
Bamboo Watch
INSTOCK
$65.00
196b5843
Black Watch
INSTOCK
$72.00
eb83afa7
Blue Band
LOWSTOCK
$79.00
8f9fa115
Blue T-Shirt
INSTOCK
$29.00
fdc77b6d
Bracelet
INSTOCK
$15.00
c91d318c
Brown Purse
OUTOFSTOCK
$120.00
566d3834
Chakra Bracelet
LOWSTOCK
$32.00
e31205c3
Galaxy Earrings
INSTOCK
$34.00
2ceb0bc0
Game Controller
LOWSTOCK
$99.00
27eb97a8
Gaming Set
INSTOCK
$299.00
Row Editing with Add
CodeNameStatusPrice
077dda05
Bamboo Watch
INSTOCK
65.0
bca47872
Black Watch
INSTOCK
72.0
251d01fd
Blue Band
LOWSTOCK
79.0
6296a112
Blue T-Shirt
INSTOCK
29.0
ef27a09f
Bracelet
INSTOCK
15.0
5d1ed9d4
Brown Purse
OUTOFSTOCK
120.0
bb2bf2c1
Chakra Bracelet
LOWSTOCK
32.0
5a9d6018
Galaxy Earrings
INSTOCK
34.0
ef1caa5b
Game Controller
LOWSTOCK
99.0
1a08fe3e
Gaming Set
INSTOCK
299.0
767a37b4
Gold Phone Case
OUTOFSTOCK
24.0
36c12d7c
Green Earbuds
INSTOCK
89.0
5789cc11
Green T-Shirt
INSTOCK
49.0
79437405
Grey T-Shirt
OUTOFSTOCK
48.0
789a4431
Headphones
LOWSTOCK
175.0

Usage


<h:form id="form">
    <p:growl id="msgs" showDetail="true"/>

    <div class="card">
        <h5>Row Editing</h5>
        <p:dataTable id="products1" var="product" value="#{dtEditView.products1}" editable="true"
                     style="margin-bottom:20px">

            <p:ajax event="rowEdit" listener="#{dtEditView.onRowEdit}" update=":form:msgs"/>
            <p:ajax event="rowEditCancel" listener="#{dtEditView.onRowCancel}" update=":form:msgs"/>

            <p:column headerText="Code">
                <p:cellEditor>
                    <f:facet name="output">
                        <h:outputText value="#{product.code}"/>
                    </f:facet>
                    <f:facet name="input">
                        <p:inputText id="modelInput" value="#{product.code}" style="width:100%"/>
                    </f:facet>
                </p:cellEditor>
            </p:column>

            <p:column headerText="Name">
                <p:cellEditor>
                    <f:facet name="output">
                        <h:outputText value="#{product.name}"/>
                    </f:facet>
                    <f:facet name="input">
                        <p:inputText value="#{product.name}" style="width:100%" label="Name"/>
                    </f:facet>
                </p:cellEditor>
            </p:column>

            <p:column headerText="Status">
                <p:cellEditor>
                    <f:facet name="output"><h:outputText value="#{product.inventoryStatus}"/></f:facet>
                    <f:facet name="input">
                        <p:selectOneMenu value="#{product.inventoryStatus}" style="width:100%">
                            <f:selectItems value="#{dtEditView.inventoryStatusList}" var="status"
                                           itemLabel="#{status.text}" itemValue="#{status}"/>
                        </p:selectOneMenu>
                    </f:facet>
                </p:cellEditor>
            </p:column>

            <p:column headerText="Price">
                <p:cellEditor>
                    <f:facet name="output">
                        <h:outputText value="#{product.price}">
                            <f:convertNumber type="currency" currencySymbol="$"/>
                        </h:outputText>
                    </f:facet>
                    <f:facet name="input">
                        <p:inputNumber value="#{product.price}" style="width:100%" label="Price" symbol="$"/>
                    </f:facet>
                </p:cellEditor>
            </p:column>

            <p:column style="width:6rem">
                <p:rowEditor editTitle="Edit Row" cancelTitle="Cancel Edit" saveTitle="Save Row"/>
            </p:column>
        </p:dataTable>
    </div>

    <div class="card">
        <h5>Cell Editing with Click and RightClick</h5>
        <p:dataTable id="products2" var="product" value="#{dtEditView.products2}" editable="true"
                     editMode="cell" ref="cellProducts">

            <p:ajax event="cellEdit" listener="#{dtEditView.onCellEdit}" update=":form:msgs"/>

            <p:column headerText="Code">
                <p:cellEditor>
                    <f:facet name="output">
                        <h:outputText value="#{product.code}"/>
                    </f:facet>
                    <f:facet name="input">
                        <p:inputText id="modelInput2" value="#{product.code}" style="width:100%"/>
                    </f:facet>
                </p:cellEditor>
            </p:column>

            <p:column headerText="Name">
                <p:cellEditor>
                    <f:facet name="output">
                        <h:outputText value="#{product.name}"/>
                    </f:facet>
                    <f:facet name="input">
                        <p:inputText value="#{product.name}" style="width:100%" label="Name"/>
                    </f:facet>
                </p:cellEditor>
            </p:column>

            <p:column headerText="Status">
                <p:cellEditor>
                    <f:facet name="output">
                        <h:outputText value="#{product.inventoryStatus}"/>
                    </f:facet>
                    <f:facet name="input">
                        <p:selectOneMenu value="#{product.inventoryStatus}" style="width:100%">
                            <f:selectItems value="#{dtEditView.inventoryStatusList}" var="status"
                                           itemLabel="#{status.text}" itemValue="#{status}"/>
                        </p:selectOneMenu>
                    </f:facet>
                </p:cellEditor>
            </p:column>

            <p:column headerText="Price">
                <p:cellEditor>
                    <f:facet name="output">
                        <h:outputText value="#{product.price}">
                            <f:convertNumber type="currency" currencySymbol="$"/>
                        </h:outputText>
                    </f:facet>
                    <f:facet name="input">
                        <p:inputNumber value="#{product.price}" style="width:100%" label="Price" symbol="$"/>
                    </f:facet>
                </p:cellEditor>
            </p:column>
        </p:dataTable>
    </div>

    <div class="card">
        <h5>Cell Editing with Double Click Event (dblclick)</h5>
        <p:dataTable id="products3" var="product" value="#{dtEditView.products3}" editable="true" editMode="cell"
                     ref="cellCars2" editInitEvent="dblclick" style="margin-bottom:20px">

            <p:ajax event="cellEdit" listener="#{dtEditView.onCellEdit}" update=":form:msgs"/>

            <p:column headerText="Code">
                <p:cellEditor>
                    <f:facet name="output">
                        <h:outputText value="#{product.code}"/>
                    </f:facet>
                    <f:facet name="input">
                        <p:inputText id="modelInput3" value="#{product.code}" style="width:100%"/>
                    </f:facet>
                </p:cellEditor>
            </p:column>

            <p:column headerText="Name">
                <p:cellEditor>
                    <f:facet name="output">
                        <h:outputText value="#{product.name}"/>
                    </f:facet>
                    <f:facet name="input">
                        <p:inputText value="#{product.name}" style="width:100%" label="Name"/>
                    </f:facet>
                </p:cellEditor>
            </p:column>

            <p:column headerText="Status">
                <p:cellEditor>
                    <f:facet name="output">
                        <h:outputText value="#{product.inventoryStatus}"/>
                    </f:facet>
                    <f:facet name="input">
                        <p:selectOneMenu value="#{product.inventoryStatus}" style="width:100%">
                            <f:selectItems value="#{dtEditView.inventoryStatusList}" var="status"
                                           itemLabel="#{status.text}" itemValue="#{status}"/>
                        </p:selectOneMenu>
                    </f:facet>
                </p:cellEditor>
            </p:column>

            <p:column headerText="Price">
                <p:cellEditor>
                    <f:facet name="output">
                        <h:outputText value="#{product.price}">
                            <f:convertNumber type="currency" currencySymbol="$"/>
                        </h:outputText>
                    </f:facet>
                    <f:facet name="input">
                        <p:inputNumber value="#{product.price}" style="width:100%" label="Price" symbol="$"/>
                    </f:facet>
                </p:cellEditor>
            </p:column>
        </p:dataTable>
    </div>

    <div class="card">
        <h5>Row Editing with Add</h5>
        <p:dataTable id="products4" ref="products4" var="product" value="#{dtAddRowView.products1}"
                     editable="true">

            <p:ajax event="rowEdit" listener="#{dtAddRowView.onRowEdit}" update=":form:msgs"/>
            <p:ajax event="rowEditCancel" listener="#{dtAddRowView.onRowCancel}" update=":form:msgs"/>

            <p:column headerText="Code">
                <p:cellEditor>
                    <f:facet name="output"><h:outputText value="#{product.code}"/></f:facet>
                    <f:facet name="input"><p:inputText value="#{product.code}" style="width:100%"/></f:facet>
                </p:cellEditor>
            </p:column>

            <p:column headerText="Name">
                <p:cellEditor>
                    <f:facet name="output"><h:outputText value="#{product.name}"/></f:facet>
                    <f:facet name="input"><p:inputText value="#{product.name}" style="width:100%"
                                                       label="Name"/></f:facet>
                </p:cellEditor>
            </p:column>

            <p:column headerText="Status">
                <p:cellEditor>
                    <f:facet name="output"><h:outputText value="#{product.inventoryStatus}"/></f:facet>
                    <f:facet name="input">
                        <h:selectOneMenu value="#{product.inventoryStatus}" style="width:100%">
                            <f:selectItems value="#{dtEditView.inventoryStatusList}" var="status"
                                           itemLabel="#{status}" itemValue="#{status}"/>
                        </h:selectOneMenu>
                    </f:facet>
                </p:cellEditor>
            </p:column>

            <p:column headerText="Price">
                <p:cellEditor>
                    <f:facet name="output"><h:outputText value="#{product.price}"/></f:facet>
                    <f:facet name="input"><p:inputText value="#{product.price}" style="width:100%"
                                                       label="Price"/></f:facet>
                </p:cellEditor>
            </p:column>

            <p:column style="width:6rem">
                <p:rowEditor/>
            </p:column>
        </p:dataTable>

        <p:commandButton value="Add new row" process="@this" update=":form:msgs" styleClass="mt-3"
                         action="#{dtAddRowView.onAddNew()}" oncomplete="PF('products4').addRow();"/>
    </div>

    <p:contextMenu for="products2" ref="cMenu">
        <p:menuitem value="Edit Cell" icon="pi pi-search"
                    onclick="PF('cellProducts').showCellEditor();return false;"/>
        <p:menuitem value="Hide Menu" icon="pi pi-times" onclick="PF('cMenu').hide()"/>
    </p:contextMenu>
</h:form>