org.apache.myfaces.tobago.taglib.component
Interface SheetTagDeclaration

All Superinterfaces:

HasBinding, HasId, HasIdBindingAndRendered, IsRendered, JspTag, Tag, TobagoTagDeclaration

All Known Implementing Classes:

SheetTag

public interface SheetTagDeclaration
extends TobagoTagDeclaration, HasIdBindingAndRendered

Render a sheet element.

Field Summary

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Method Summary

void	setColumns(String columns) LayoutConstraints for column layout.
void	setDirectLinkCount(String directLinkCount) The count of rendered direct paging links in the sheet's footer.
void	setFirst(String pagingStart) Zero-relative row number of the first row to be displayed.
void	setForceVerticalScrollbar(String forceVerticalScrollbar) Flag indicating whether or not this sheet should reserve space for vertical toolbar when calculating column width's.
void	setPagingLength(String pagingLength) Deprecated.
void	setPagingStart(String pagingStart) Deprecated.
void	setRows(String pagingLength) The number of rows to display, starting with the one identified by the "pagingStart/first" property.
void	setSelectable(String selectable) Flag indicating whether or not the sheet should be selectable.
void	setShowDirectLinks(String showDirectLinks) Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.
void	setShowHeader(String showHeader) Flag indicating the header should be rendered.
void	setShowPageRange(String showPageRange) Flag indicating whether and where the range pages should rendered in the sheet's footer.
void	setShowRowRange(String showRowRange) Flag indicating whether or not the range of displayed rows should rendered in the sheet's footer.
void	setSortActionListener(String sortActionListener) Method binding representing an actionListener method that will be invoked when sorting was requested by the user.
void	setState(String state) Sheet state saving object.
void	setStateChangeListener(String stateChangeListener) Method binding representing a stateChangeListener method that will be notified when the state was changed by the user.
void	setValue(String value) The sheet's data.
void	setVar(String var) 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.

Methods inherited from interface javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, release, setPageContext, setParent

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasId

setId

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasBinding

setBinding

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.IsRendered

setRendered

Method Detail

setColumns

void setColumns(String columns)

LayoutConstraints for column layout. Semicolon separated list of layout tokens ('<x>*', '<x>px' or '<x>%').

setShowHeader

void setShowHeader(String showHeader)

Flag indicating the header should be rendered.

setPagingLength

@Deprecated
void setPagingLength(String pagingLength)

Deprecated.

Please use "rows" instead. The number of rows to display, starting with the one identified by the "pagingStart" property.

setRows

void setRows(String pagingLength)

The number of rows to display, starting with the one identified by the "pagingStart/first" property.

setPagingStart

@Deprecated
void setPagingStart(String pagingStart)

Deprecated.

Please use "first" instead. Zero-relative row number of the first row to be displayed.

setFirst

void setFirst(String pagingStart)

Zero-relative row number of the first row to be displayed.

setValue

void setValue(String value)

The sheet's data.

setVar

void setVar(String var)

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.

setDirectLinkCount

void setDirectLinkCount(String directLinkCount)

The count of rendered direct paging links in the sheet's footer.

setForceVerticalScrollbar

void setForceVerticalScrollbar(String forceVerticalScrollbar)

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 scroolbar is reserved.
      'false' : no space is reserved.
      

setShowDirectLinks

void setShowDirectLinks(String showDirectLinks)

Flag 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.

setShowPageRange

void setShowPageRange(String showPageRange)

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.
Valid values are left, center, right and none.

setShowRowRange

void setShowRowRange(String showRowRange)

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.
Valid values are left, center, right and none.

setSelectable

void setSelectable(String selectable)

Flag indicating whether or not the sheet should be selectable.

setState

void setState(String state)

Sheet state saving object.

setStateChangeListener

void setStateChangeListener(String stateChangeListener)

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.

setSortActionListener

void setSortActionListener(String sortActionListener)

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 SortActionEvent. The method should sort according to the sortColumnId and direction getting from the sheet's SheetState object.