UIComponentClass: org.apache.myfaces.tobago.component.UISheet
RendererType:
Supported facets:
Supported markups:
| Info | Value |
|---|---|
| Component Type | org.apache.myfaces.tobago.Sheet |
| Handler Class | org.apache.myfaces.tobago.facelets.TobagoComponentHandler |
| Renderer Type | Sheet |
| Description | None |
| 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.IntegerDefault: 9 |
first | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Zero-relative row number of the first row to be displayed. Type: intDefault: 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: booleanDefault: 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.IntegerDefault: 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.IntegerDefault: 0 |
paginator | false | jakarta.el.ValueExpression
(must evaluate to org.apache.myfaces.tobago.layout.PaginatorMode)
| Create paginator components automatically or do it manually.
Type: org.apache.myfaces.tobago.layout.PaginatorModeDefault: useShowAttributesAllowed 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: booleanDefault: 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: booleanDefault: 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: intDefault: 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.SelectableDefault: multiAllowed 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.ShowPositionDefault: centerAllowed 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 linksType: booleanDefault: false |
showHeader | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Flag indicating the header should be rendered. Type: booleanDefault: 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.ShowPositionDefault: rightAllowed 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 rangeType: booleanDefault: 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.
Type: booleanDefault: 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: booleanDefault: 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: booleanDefault: 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.ShowPositionDefault: leftAllowed 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 |
Output generated by Vdldoc View Declaration Language Documentation Generator.