sheet (Tobago Core VDL Documentation)

Description:
Render a sheet element.
UIComponentClass: org.apache.myfaces.tobago.component.UISheet
RendererType:
- Sheet (default)
Supported facets:
reload
Contains an instance of UIReload
before
Components to be rendered before the sheet, e.g. paginators
after
Components to be rendered after the sheet, e.g. paginators
Supported markups:
bordered
Add borders to the table cells.
dark
Set dark background.
hover
Background of row changed on hovering.
small
Small margins for table cells.
striped
Zebra-striping for table rows.
spread
Use the full height for the HTML content.

Component Information
Info	Value
Component Type	`org.apache.myfaces.tobago.Sheet`
Handler Class	`org.apache.myfaces.tobago.facelets.TobagoComponentHandler`
Renderer Type	`Sheet`
Description	None

Attributes
Name	Required	Type	Description
`binding`	`false`	`jakarta.el.ValueExpression` (must evaluate to `jakarta.faces.component.UIComponent`)	The value binding expression linking this component to a property in a backing bean. For Facelets, the component is the outer UIPanel, not the input control. Type: `jakarta.faces.component.UIComponent`
`columns`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	LayoutConstraints for column layout. Contains a space separated list of layout tokens '<n>fr', '<x>px', '<x>%' or 'auto', where x is a number and n is an integer. Type: `java.lang.String`
`directLinkCount`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Integer`)	** @deprecated. Will be removed in a future version ** Use paginator attribute or paginator tags instead. The count of rendered direct paging links in the sheet's footer. Type: `java.lang.Integer` Default: `9`
`first`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Zero-relative row number of the first row to be displayed. Type: `int` Default: `0`
`id`	`false`	`java.lang.String`	The component identifier for this component. This value must be unique within the closest parent component that is a naming container. Type: `java.lang.String`
`lazy`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Lazy loading by scroll event. Type: `boolean` Default: `false`
`lazyRows`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Indicate how many rows are loaded at once when lazy loading is enabled. Default is 50. Type: `java.lang.Integer` Default: `50`
`markup`	`false`	`jakarta.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.context.Markup`)	Indicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer. Type: `org.apache.myfaces.tobago.context.Markup`
`maxSortColumns`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Integer`)	The maximum count of multi-sorted columns to indicate. Type: `java.lang.Integer` Default: `0`
`paginator`	`false`	`jakarta.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.layout.PaginatorMode`)	Create paginator components automatically or do it manually. custom: no paginator is created automatically, you have to do it manually. This can be done using a `<tc:paginatorPanel>` with e.g. a `<tc:paginatorList>` and/or some other paginator components. auto: a appropriate paginator is used. list: a `<tc:paginatorList>` is used. page: a `<tc:paginatorPage>` is used. row: a `<tc:paginatorRow>` is used. useShowAttributes (default): is deprecated, use for compatibility. The used paginators are defined by the show-attributes: `showDirectLinks`, `showPageRange`, `showRowRange`, `directLinkCount`, `showDirectLinksArrows`, `showPageRangeArrows`, `showPagingAlways`. Type: `org.apache.myfaces.tobago.layout.PaginatorMode` Default: `useShowAttributes` Allowed Values: `[auto, custom, list, page, row, useShowAttributes]`
`readonlyRows`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating that the rows of the sheet are readonly. The readonly attribute is a performance optimization hint used during {@link jakarta.faces.event.PhaseId#APPLY_REQUEST_VALUES} and {@link jakarta.faces.event.PhaseId#PROCESS_VALIDATIONS} and {@link jakarta.faces.event.PhaseId#UPDATE_MODEL_VALUES}. When set to true, it signals the rows of the sheet are read-only und doesn't require updates potentially saving processing time. This optimization should only be applied when there are no non-readonly {@link jakarta.faces.component.EditableValueHolder} components in the sheet rows. Type: `boolean` Default: `false`
`rendered`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. Type: `boolean` Default: `true`
`rows`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Integer`)	The number of rows to display, starting with the one identified by the "first" property. The default has been changed from 100 to 0 because this is the default in the JSF standard (since Tobago 1.5). Type: `int` Default: `0`
`selectable`	`false`	`jakarta.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.model.Selectable`)	Indicating the selection mode of the sheet. Type: `org.apache.myfaces.tobago.model.Selectable` Default: `multi` Allowed Values: `[none, single, singleOrNone, multi]`
`showDirectLinks`	`false`	`jakarta.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.layout.ShowPosition`)	** @deprecated. Will be removed in a future version ** Use paginator attribute or paginator tags instead. Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer. Type: `org.apache.myfaces.tobago.layout.ShowPosition` Default: `center` Allowed Values: `[left, center, right, none]`
`showDirectLinksArrows`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	** @deprecated. Will be removed in a future version ** Use paginator attribute or paginator tags instead. Flag indicating if paging arrows are shown near direct links Type: `boolean` Default: `false`
`showHeader`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating the header should be rendered. Type: `boolean` Default: `true`
`showPageRange`	`false`	`jakarta.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.layout.ShowPosition`)	** @deprecated. Will be removed in a future version ** Use paginator attribute or paginator tags instead. Flag indicating whether and where the range pages should be rendered in the sheet's footer. Rendering this range also offers the capability to enter the index displayed page directly. Type: `org.apache.myfaces.tobago.layout.ShowPosition` Default: `right` Allowed Values: `[left, center, right, none]`
`showPageRangeArrows`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	** @deprecated. Will be removed in a future version ** Use paginator attribute or paginator tags instead. Flag indicating if paging arrows are shown near page range Type: `boolean` Default: `true`
`showPagingAlways`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	** @deprecated. Will be removed in a future version ** Use paginator attribute or paginator tags instead. Flag indicating whether or not the paging panel should be display, if it is not needed for paging. showPagingAlways="false" which is the default means, that the paging footer should be displayed, only when it is needed. When the rows="0" paging is not needed, so the footer will not be rendered, when rows="N", N > 0 and the size of the data value is <= N paging is not needed and the footer will not be rendered, in any other case the paging footer will be displayed. showPagingAlways="true" means, that the paging footer should be displayed in any case. Type: `boolean` Default: `false`
`showRoot`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed. Often in tree structures the root node is special and should not be displayed. Type: `boolean` Default: `false`
`showRootJunction`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed with an open-close-switch. Type: `boolean` Default: `false`
`showRowRange`	`false`	`jakarta.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.layout.ShowPosition`)	** @deprecated. Will be removed in a future version ** Use paginator attribute or paginator tags instead. Flag indicating whether or not the range of displayed rows should rendered in the sheet's footer. Rendering this range also offers the capability to enter the index of the start row directly. Type: `org.apache.myfaces.tobago.layout.ShowPosition` Default: `left` Allowed Values: `[left, center, right, none]`
`sortActionListener`	`false`	`java.lang.String`	Method binding representing an actionListener method that will be invoked when sorting was requested by the user. Use this if your application needs special handling for sorting columns. If this is not set and the sortable attribute column is set to true the sheet implementation will use a default sort method. The expression must evaluate to a public method which takes an ActionEvent as parameter and with a return type of void. The method will receive a {@link org.apache.myfaces.tobago.event.SortActionEvent}. The method should sort according to the sortColumnId and direction getting from the sheet's {@link org.apache.myfaces.tobago.model.SheetState} object.
`state`	`false`	`jakarta.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.model.SheetState`)	Sheet state saving object. Type: `org.apache.myfaces.tobago.model.SheetState`
`stateChangeListener`	`false`	`java.lang.String`	Method binding representing a stateChangeListener method that will be notified when the state was changed by the user. The expression must evaluate to a public method that takes a SheetStateChangeEvent parameter, with a return type of void.
`value`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Object`)	The sheet's data. Type: `[java.lang.Object[], java.util.List, jakarta.servlet.jsp.jstl.sql.Result, java.sql.ResultSet, java.lang.Object, jakarta.faces.model.DataModel]`
`var`	`true`	`java.lang.String`	Name of a request-scope attribute under which the model data for the row selected by the current value of the "rowIndex" property (i.e. also the current value of the "rowData" property) will be exposed. Type: `java.lang.String`

tc

Tag sheet