dataTable (Liferay Faces Alloy View Description Language Documentation (VDLDoc))

Description:

DataTable is a UIData (iterator) component that renders a <table> element representing tabular data and is designed to be used in conjunction with alloy:column child component tags. Since it extends HtmlDataTable, it supports all the features of h:dataTable.

Since:

2.0.0

Example usage of this component can be found at:

http://www.liferayfaces.org/web/guest/alloy-showcase/-/alloy-tag/alloy/datatable/general

Component Information
Info	Value
Component Type	`com.liferay.faces.alloy.component.datatable.DataTable`
Handler Class	None
Renderer Type	`com.liferay.faces.alloy.component.datatable.DataTableRenderer`
Description	None

Attributes
Name	Required	Type	Description
`bgcolor`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the background color for the `<table>` element.
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	An EL expression that binds the Java reference to this component in the component tree to a bean property.
`bodyrows`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Comma-delimited list of of row indexes. Each row index in the list will cause a previous `<tbody>` element to be closed, and a new `<tbody>` element to be opened.
`border`	`false`	`javax.el.ValueExpression` (must evaluate to `int`)	The width of the table border (measured in pixels).
`captionClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	List of CSS class names (separated by spaces) that are to be rendered within the class attribute of the table's `<caption>` element.
`captionStyle`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the css style of the caption element.
`cellpadding`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the cell padding for the `<table>` element.
`cellspacing`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the cell spacing for the `<table>` element.
`clientKey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The key name that can be used to reference the component on the client.
`columnClasses`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	List of CSS class names (separated by commas) that are to be rendered within the class attribute of the table's `<td>` elements.
`dir`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the reading direction for the element For example, right to left (RTL), or left to right (LTR).
`first`	`false`	`javax.el.ValueExpression` (must evaluate to `int`)	The first row number that is to be displayed, relative to zero.
`footerClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	List of CSS class names (separated by spaces) that are to be rendered within the class attribute of the table's `<tfoot>` element.
`frame`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies which side(s) of the surrounding frame are visible. Value values: none, above, below, hsides, vsides, lhs, rhs, box, border.
`headerClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	List of CSS class names (separated by spaces) that are to be rendered within the class attribute of the table's `<thead>` element.
`id`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A unique identifier for this component.
`lang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the language code used in the element.
`multiColumnSort`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When true, multiple columns can be selected by the user when the meta key is held down during a left click on a sortable column header. The default value is `false`.
`onclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when this component is clicked.
`ondblclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a double click event occurs.
`onkeydown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a keydown event occurs.
`onkeypress`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a keypress event occurs.
`onkeyup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a keyup event occurs.
`onmousedown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mousedown event occurs.
`onmousemove`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mousemove event occurs.
`onmouseout`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mouseout event occurs.
`onmouseover`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mouseover event occurs.
`onmouseup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mouseup event occurs.
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, this component will be rendered to there response. When false, it will not be rendered to the response. The default value is `true`.
`role`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the various WAI-ARIA roles that the element is used for. Since: JSF 2.2
`rowClasses`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	List of CSS class names (separated by commas) that are to be rendered within the class attribute of the table's `<tr>` elements.
`rows`	`false`	`javax.el.ValueExpression` (must evaluate to `int`)	The total number of rows that are to be displayed. If not set, then all rows are displayed.
`rules`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the rules for the `<table>` element. Valid values: none, groups, rows, cols, all.
`selectedRowIndexes`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Comma-delimited list of row indexes that indicate which rows are selected.
`selectionMode`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Indicates the type of row selection. Valid values are `"checkbox"`, `"radio"`.
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the css style of the element.
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
`summary`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the summary for the `<table>` element.
`title`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the title of the element.
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	The value of this component, which is typically bound via EL to a model bean property. The value can be any of the following types: Any concrete subclass of `DataModel` Array (automatically wrapped with `ArrayDataModel`) java.util.Collection (automatically wrapped with `CollectionDataModel`) java.util.List (automatically wrapped with `ListDataModel`) java.sql.ResultSet (automatically wrapped with `ResultSetDataModel`)
`var`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The name of the variable that is to be introduced into the EL representing the current iteration.
`width`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the width for the `<table>` element.

alloy

Tag dataTable