Overview   Library    Tag    Help 
 FRAMES   NO FRAMES 

tc
Tag sheet

Render a sheet element.

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

RendererType: Sheet

Supported facets:

reload
Contains an instance of UIReload

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

Attributes
NameRequiredRequest-timeTypeDescription
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent) 		The 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.

Type: javax.faces.component.UIComponent
columnsfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String) 		LayoutConstraints for column layout. Semicolon separated list of layout tokens ('*', 'px' or '%').
Type: java.lang.String
directLinkCountfalsefalsejavax.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
firstfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Integer) 		Zero-relative row number of the first row to be displayed.
Type: int
Default: 0
forceVerticalScrollbarfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String) 		Flag 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]
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
markupfalsefalsejavax.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
renderedfalsefalsejavax.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
renderedPartiallyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String[])

Indicate the partially rendered components in a case of a submit.

The search depends on the number of prefixed colons in the relativeId:

number of prefixed colons == 0
fully relative
number of prefixed colons == 1
absolute (still normal findComponent syntax)
number of prefixed colons == 2
search in the current naming container (same as 0 colons)
number of prefixed colons == 3
search in the parent naming container of the current naming container
number of prefixed colons > 3
go to the next parent naming container for each additional colon

If a literal is specified: to use more than one identifier the identifiers must be space delimited.

Using this in a UISheet or UITabGroup component this list indicates components to update when calling internal AJAX requests like sort or paging commands. Don't forget to add the sheet-id or tagGroup-id in that case, if needed.

You can also use
Type: java.lang.String[]
rowsfalsefalsejavax.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
selectablefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String) 		Flag indicating whether or not the sheet should be selectable.
Type: java.lang.String
Default: multi
Allowed Values: [none, single, singleOrNone, multi]
showDirectLinksfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String) 		Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.
Type: java.lang.String
Default: center
Allowed Values: [left, center, right, none]
showDirectLinksArrowsfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean) 		Flag indicating if paging arrows are shown near direct links
Type: boolean
Default: false
showHeaderfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean) 		Flag indicating the header should be rendered.
Type: boolean
Default: true
showPageRangefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String) 		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: java.lang.String
Default: right
Allowed Values: [left, center, right, none]
showPageRangeArrowsfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean) 		Flag indicating if paging arrows are shown near page range
Type: boolean
Default: true
showPagingAlwaysfalsefalsejavax.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
showRootfalsefalsejavax.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
showRootJunctionfalsefalsejavax.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
showRowRangefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String) 		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: java.lang.String
Default: left
Allowed Values: [left, center, right, none]
sortActionListenerfalsefalsejavax.el.MethodExpression
(signature must match void sortActionListener(javax.faces.event.ActionEvent)) 		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.
statefalsefalsejavax.el.ValueExpression
(must evaluate to org.apache.myfaces.tobago.model.SheetState) 		Sheet state saving object.
Type: org.apache.myfaces.tobago.model.SheetState
stateChangeListenerfalsefalsejavax.el.MethodExpression
(signature must match void stateChangeListener(javax.faces.event.ActionEvent)) 		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.
valuefalsefalsejavax.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]
vartruefalsejava.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.