Overview   Library    Tag    Help 
 FRAMES   NO FRAMES 

Tobago Components 1.0.x
Tag sheet

Render a sheet element.

UIComponentClass: org.apache.myfaces.tobago.component.UIData

RendererType: Sheet

Supported facets:

reload
Contains an instance of UIReload

Tag Information
Tag Classorg.apache.myfaces.tobago.taglib.component.SheetTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
idfalsetruejava.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
bindingfalsetruejava.lang.StringThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:

  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
renderedfalsetruejava.lang.StringFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
Type: java.lang.Boolean
Default: true
columnsfalsetruejava.lang.StringLayoutConstraints for column layout. Semicolon separated list of layout tokens ('<x>*', '<x>px' or '<x>%').
Type: java.lang.String
directLinkCountfalsetruejava.lang.StringThe count of rendered direct paging links in the sheet's footer.

Type: java.lang.Integer
Default: 9
firstfalsetruejava.lang.StringZero-relative row number of the first row to be displayed.
Type: java.lang.Integer
Default: 0
forceVerticalScrollbarfalsetruejava.lang.StringFlag indicating whether or not this sheet should reserve space for vertical toolbar when calculating column width's.
Possible values are: 
 'auto' : sheet try to estimate the need of scrollbar 'true' : space for scrollbar is reserved. 'false' : no space is reserved.

Type: java.lang.String
Default: auto
Allowed values: [auto, true, false]
pagingLengthfalsetruejava.lang.String

**** @deprecated. Will be removed in a future version ****

Please use "rows" instead. The number of rows to display, starting with the one identified by the "pagingStart" property.
Type: java.lang.Integer
Default: 100
pagingStartfalsetruejava.lang.String

**** @deprecated. Will be removed in a future version ****

Please use "first" instead. Zero-relative row number of the first row to be displayed.
Type: java.lang.Integer
Default: 0
rowsfalsetruejava.lang.StringThe number of rows to display, starting with the one identified by the "pagingStart/first" property.
Type: java.lang.Integer
Default: 100
selectablefalsetruejava.lang.StringFlag indicating whether or not the sheet should be selectable.
Type: java.lang.String
Default: multi
Allowed values: [none, single, singleOrNone, multi]
showDirectLinksfalsetruejava.lang.StringFlag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.
Valid values are left, center, right and none.
Type: java.lang.String
Default: none
Allowed values: [left, center, right, none]
showHeaderfalsetruejava.lang.StringFlag indicating the header should be rendered.
Type: java.lang.Boolean
Default: true
showPageRangefalsetruejava.lang.StringFlag 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.
Valid values are left, center, right and none.
Type: java.lang.String
Default: none
Allowed values: [left, center, right, none]
showRowRangefalsetruejava.lang.StringFlag 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.
Valid values are left, center, right and none.
Type: java.lang.String
Default: none
Allowed values: [left, center, right, none]
sortActionListenerfalsetruejava.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.
Type: javax.faces.el.MethodBinding
statefalsetruejava.lang.StringSheet state saving object.
Type: org.apache.myfaces.tobago.model.SheetState
stateChangeListenerfalsetruejava.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.
Type: javax.faces.el.MethodBinding
valuefalsetruejava.lang.StringThe 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]
vartruetruejava.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

Variables
No Variables Defined.

 Overview   Library    Tag    Help 
 FRAMES   NO FRAMES 
Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.