tc

Tag sheet

Component Information 
InfoValue
Component Typeorg.apache.myfaces.tobago.Sheet
Handler Classorg.apache.myfaces.tobago.facelets.TobagoComponentHandler
Renderer TypeSheet
DescriptionNone
Attributes 
NameRequiredTypeDescription
bindingfalsejavax.el.ValueExpression
(must evaluate to javax.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: javax.faces.component.UIComponent
columnsfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
LayoutConstraints for column layout. Semicolon separated list of layout tokens ('<x>*', '<x>px' or '<x>%') or "auto"
Type: java.lang.String
directLinkCountfalsejavax.el.ValueExpression
(must evaluate to java.lang.Integer)
The count of rendered direct paging links in the sheet's footer.

Type: java.lang.Integer
Default: 9
firstfalsejavax.el.ValueExpression
(must evaluate to java.lang.Integer)
Zero-relative row number of the first row to be displayed.
Type: int
Default: 0
idfalsejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Type: java.lang.String
markupfalsejavax.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
renderedfalsejavax.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
rowsfalsejavax.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
selectablefalsejavax.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]
showDirectLinksArrowsfalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean)
Flag indicating if paging arrows are shown near direct links
Type: boolean
Default: false
showHeaderfalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean)
Flag indicating the header should be rendered.
Type: boolean
Default: true
showPageRangefalsejavax.el.ValueExpression
(must evaluate to org.apache.myfaces.tobago.layout.ShowPosition)
Flag indicating whether and where the range pages should 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]
showPageRangeArrowsfalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean)
Flag indicating if paging arrows are shown near page range
Type: boolean
Default: true
showPagingAlwaysfalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean)
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
showRootfalsejavax.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
showRootJunctionfalsejavax.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
showRowRangefalsejavax.el.ValueExpression
(must evaluate to org.apache.myfaces.tobago.layout.ShowPosition)
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]
sortActionListenerfalsejava.lang.StringMethod 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.
statefalsejavax.el.ValueExpression
(must evaluate to org.apache.myfaces.tobago.model.SheetState)
Sheet state saving object.
Type: org.apache.myfaces.tobago.model.SheetState
stateChangeListenerfalsejava.lang.StringMethod 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.
valuefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
The sheet's data.
Type: [java.lang.Object[], java.util.List, javax.servlet.jsp.jstl.sql.Result, java.sql.ResultSet, java.lang.Object, javax.faces.model.DataModel]
vartruejava.lang.StringName 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.