| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Columns |
| Handler Class | org.primefaces.component.columns.ColumnsHandler |
| Renderer Type | None |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
ariaHeaderText | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Label to read by screen readers, when not specified headerText is used. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
caseSensitiveSort | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Case sensitivity for sorting, insensitive by default. |
colspan | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Defines the number of columns the column spans. |
columnIndexVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of iterator to refer each row index. |
converter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| An EL expression or a literal text that defines a converter for the component. When it's an EL expression, it's resolved to a converter instance. In case it's a static text, it must refer to a converter id. |
displayPriority | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Defines the display priority, in which order the columns should be displayed. |
draggable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if columns are draggable if draggableColumns is set. Default true. |
exportable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if the column should be exported by dataexporter. |
exportColspan | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Defines the number of columns the column spans to be exported. |
exportFooterValue | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines if the footer value of column to be exported. |
exportFunction | false | jakarta.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| Custom pluggable exportFunction. |
exportHeaderValue | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines if the header value of column to be exported. |
exportRowspan | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Defines the number of rows the column spans to be exported. |
exportTag | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| If XML data exporter in use, this allows customization of the column tag in the XML. |
exportValue | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the value of the cell to be exported if something other than the cell contents or exportFunction. |
field | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the field to pass lazy load method for filtering and sorting. If not specified, filterBy-sortBy values are used to identify the field name. |
filterable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to mark column as filterable. |
filterBy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Property to be used for filtering. |
filterFunction | false | jakarta.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| Custom implementation to filter a value against a constraint. |
filterMatchMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Match mode for filtering. |
filterMaxLength | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum number of characters for an input filter. |
filterPlaceholder | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Placeholder for plain input text style filters. |
filterPosition | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Location of the column filter with respect to header content. Options are 'bottom'(default) and 'top'. |
filterStyle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the filter element. |
filterStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the filter element. |
filterValue | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the filter field. |
footerText | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Shortcut for footer facet. |
groupRow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Speficies whether to group rows based on the column data. |
headerText | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Shortcut for header facet. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
nullSortOrder | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Defines where the null values are placed in ascending sort order. Default value is "1" meaning null values are placed at the end in ascending mode and at beginning in descending mode. Set to "-1" for the opposite behavior. |
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. |
resizable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies resizable feature at column level. Datatable's resizableColumns must be enabled to use this option. |
responsivePriority | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Responsive priority of the column, lower values have more priority. |
rowspan | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Defines the number of rows the column spans. |
selectRow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether clicking the column selects the row when datatable has row selection enabled, default is true. |
sortable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to mark column as sortable. |
sortBy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Property to be used for sorting. |
sortFunction | false | jakarta.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| Custom pluggable sortFunction. |
sortOrder | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Sets default sorting order. Possible values "asc", "desc" or null |
sortPriority | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Sets default sorting priority over the other columns. Default is Integer.MAX_VALUE. Lower values have more priority. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the column. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the column. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory tooltip information. |
toggleable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if columns are toggleable by columnToggler component. Default value is true and a false value marks the column as static. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| No Description |
var | true | java.lang.String | Name of the iterator variable that references each element in the data set. |
visible | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Controls the visibilty of the column, default is true. |
width | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Width of the column in pixels or percentage. |
Output generated by Vdldoc View Declaration Language Documentation Generator.