| Info | Value |
|---|---|
| Component Type | org.primefaces.component.DataGrid |
| Handler Class | None |
| Renderer Type | org.primefaces.component.DataGridRenderer |
| 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. |
columns | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Number of columns of grid. Default is 3. |
paginator | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enables pagination. |
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. |
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. |
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." |
lazy | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if lazy loading is enabled for the data component. |
layout | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Layout approach to use, valid values are "tabular" (default) and "grid" for responsive grid. |
rowStatePreserved | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Keeps state of its children on a per-row basis. Default is false. |
multiViewState | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to keep DataGrid state across views, defaults to false. |
Output generated by Vdldoc View Declaration Language Documentation Generator.