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

All Superinterfaces:
HasBinding, HasCurrentMarkup, HasId, HasIdBindingAndRendered, HasMarkup, HasRenderedPartially, HasVar, IsGridLayoutComponent, IsGridLayoutComponentBase, IsGridLayoutContainer, IsRendered

public interface SheetTagDeclaration
extends HasIdBindingAndRendered, IsGridLayoutComponent, IsGridLayoutContainer, HasMarkup, HasCurrentMarkup, HasRenderedPartially, HasVar

Render a sheet element.


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 first)
          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 setRows(String rows)
          The number of rows to display, starting with the one identified by the "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 setShowPagingAlways(String showPagingAlways)
          Flag indicating whether or not the paging panel should be display, if it is not needed for paging.
 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.
 
Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.HasId
setId
 
Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.HasBinding
setBinding
 
Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.IsRendered
setRendered
 
Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutComponent
setHeight, setWidth
 
Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutComponentBase
setColumnSpan, setCurrentHeight, setCurrentWidth, setDisplay, setHorizontalIndex, setLeft, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaximumHeight, setMaximumWidth, setMinimumHeight, setMinimumWidth, setPreferredHeight, setPreferredWidth, setRowSpan, setTop, setVerticalIndex
 
Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutContainer
setBorderBottom, setBorderLeft, setBorderRight, setBorderTop, setOverflowX, setOverflowY, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop
 
Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.HasMarkup
setMarkup
 
Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.HasCurrentMarkup
setCurrentMarkup
 
Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.HasRenderedPartially
setRenderedPartially
 
Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.HasVar
setVar
 

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.


setRows

void setRows(String rows)
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 of the JSF standard (Tobago 1.5).


setFirst

void setFirst(String first)
Zero-relative row number of the first row to be displayed.


setValue

void setValue(String value)
The sheet's data.


setShowPagingAlways

void setShowPagingAlways(String showPagingAlways)
Flag indicating whether or not the paging panel should be display, if it is not needed for paging.


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


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.


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.


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.



Copyright © 2002-2014 The Apache Software Foundation. All Rights Reserved.