org.apache.myfaces.tobago.taglib.component
Class SheetTag

java.lang.Object
  extended by javax.faces.webapp.UIComponentTag
      extended by org.apache.myfaces.tobago.taglib.component.TobagoTag
          extended by org.apache.myfaces.tobago.taglib.component.SheetTag
All Implemented Interfaces:
JspTag, Tag, SheetTagDeclaration, TobagoTagDeclaration, HasBinding, HasId, HasIdBindingAndRendered, IsRendered

public class SheetTag
extends TobagoTag
implements SheetTagDeclaration


Field Summary
 
Fields inherited from class javax.faces.webapp.UIComponentTag
pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
SheetTag()
           
 
Method Summary
 java.lang.String getColumns()
           
 java.lang.String getComponentType()
           
 java.lang.String getPagingLength()
           
 java.lang.String getPagingStart()
           
 java.lang.String getShowHeader()
           
 java.lang.String getStateChangeListener()
           
 java.lang.String getValue()
           
 java.lang.String getVar()
           
 void release()
           
 void setColumns(java.lang.String columns)
          LayoutConstraints for column layout.
 void setDirectLinkCount(java.lang.String directLinkCount)
          The count of rendered direct paging links in the sheet's footer.
 void setFirst(java.lang.String pagingStart)
          Zero-relative row number of the first row to be displayed.
 void setForceVerticalScrollbar(java.lang.String forceVerticalScrollbar)
          Flag indicating whether or not this sheet should reserve space for vertical toolbar when calculating column width's.
 void setPagingLength(java.lang.String pagingLength)
          Please use "rows" instead.
 void setPagingStart(java.lang.String pagingStart)
          Please use "first" instead.
protected  void setProperties(UIComponent component)
           
 void setRows(java.lang.String pagingLength)
          The number of rows to display, starting with the one identified by the "pagingStart/first" property.
 void setSelectable(java.lang.String selectable)
          Flag indicating whether or not the sheet should be selectable.
 void setShowDirectLinks(java.lang.String showDirectLinks)
          Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.
 void setShowHeader(java.lang.String showHeader)
          Flag indicating the header should be rendered.
 void setShowPageRange(java.lang.String showPageRange)
          Flag indicating whether and where the range pages should rendered in the sheet's footer.
 void setShowRowRange(java.lang.String showRowRange)
          Flag indicating whether or not the range of displayed rows should rendered in the sheet's footer.
 void setSortActionListener(java.lang.String sortActionListener)
          Method binding representing an actionListener method that will be invoked when sorting was requested by the user.
 void setState(java.lang.String state)
          Sheet state saving object.
 void setStateChangeListener(java.lang.String stateChangeListener)
          Method binding representing a stateChangeListener method that will be notified when the state was changed by the user.
 void setValue(java.lang.String value)
          The sheet's data.
 void setVar(java.lang.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 class org.apache.myfaces.tobago.taglib.component.TobagoTag
doEndTag, doStartTag, getDisabled, getHeight, getHidden, getInline, getLabel, getReadonly, getRendererType, getTitle, getWidth, setDisabled, setHeight, setHidden, setInline, setLabel, setReadonly, setTitle, setWidth
 
Methods inherited from class javax.faces.webapp.UIComponentTag
encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getDoStartValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setRendered, setupResponseWriter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, 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
 

Constructor Detail

SheetTag

public SheetTag()
Method Detail

getComponentType

public java.lang.String getComponentType()
Specified by:
getComponentType in class UIComponentTag

release

public void release()
Specified by:
release in interface Tag
Overrides:
release in class TobagoTag

setProperties

protected void setProperties(UIComponent component)
Overrides:
setProperties in class TobagoTag

getColumns

public java.lang.String getColumns()

setColumns

public void setColumns(java.lang.String columns)
Description copied from interface: SheetTagDeclaration
LayoutConstraints for column layout. Semicolon separated list of layout tokens ('<x>*', '<x>px' or '<x>%').

Specified by:
setColumns in interface SheetTagDeclaration

getShowHeader

public java.lang.String getShowHeader()

setShowHeader

public void setShowHeader(java.lang.String showHeader)
Description copied from interface: SheetTagDeclaration
Flag indicating the header should be rendered.

Specified by:
setShowHeader in interface SheetTagDeclaration

getPagingLength

public java.lang.String getPagingLength()

setPagingLength

public void setPagingLength(java.lang.String pagingLength)
Description copied from interface: SheetTagDeclaration
Please use "rows" instead. The number of rows to display, starting with the one identified by the "pagingStart" property.

Specified by:
setPagingLength in interface SheetTagDeclaration

setRows

public void setRows(java.lang.String pagingLength)
Description copied from interface: SheetTagDeclaration
The number of rows to display, starting with the one identified by the "pagingStart/first" property.

Specified by:
setRows in interface SheetTagDeclaration

getPagingStart

public java.lang.String getPagingStart()

getStateChangeListener

public java.lang.String getStateChangeListener()

setPagingStart

public void setPagingStart(java.lang.String pagingStart)
Description copied from interface: SheetTagDeclaration
Please use "first" instead. Zero-relative row number of the first row to be displayed.

Specified by:
setPagingStart in interface SheetTagDeclaration

setFirst

public void setFirst(java.lang.String pagingStart)
Description copied from interface: SheetTagDeclaration
Zero-relative row number of the first row to be displayed.

Specified by:
setFirst in interface SheetTagDeclaration

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)
Description copied from interface: SheetTagDeclaration
The sheet's data.

Specified by:
setValue in interface SheetTagDeclaration

getVar

public java.lang.String getVar()

setVar

public void setVar(java.lang.String var)
Description copied from interface: SheetTagDeclaration
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.

Specified by:
setVar in interface SheetTagDeclaration

setDirectLinkCount

public void setDirectLinkCount(java.lang.String directLinkCount)
Description copied from interface: SheetTagDeclaration
The count of rendered direct paging links in the sheet's footer.

Specified by:
setDirectLinkCount in interface SheetTagDeclaration

setForceVerticalScrollbar

public void setForceVerticalScrollbar(java.lang.String forceVerticalScrollbar)
Description copied from interface: SheetTagDeclaration
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.
      

Specified by:
setForceVerticalScrollbar in interface SheetTagDeclaration

setShowDirectLinks

public void setShowDirectLinks(java.lang.String showDirectLinks)
Description copied from interface: SheetTagDeclaration
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.

Specified by:
setShowDirectLinks in interface SheetTagDeclaration

setShowPageRange

public void setShowPageRange(java.lang.String showPageRange)
Description copied from interface: SheetTagDeclaration
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.

Specified by:
setShowPageRange in interface SheetTagDeclaration

setShowRowRange

public void setShowRowRange(java.lang.String showRowRange)
Description copied from interface: SheetTagDeclaration
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.

Specified by:
setShowRowRange in interface SheetTagDeclaration

setState

public void setState(java.lang.String state)
Description copied from interface: SheetTagDeclaration
Sheet state saving object.

Specified by:
setState in interface SheetTagDeclaration

setStateChangeListener

public void setStateChangeListener(java.lang.String stateChangeListener)
Description copied from interface: SheetTagDeclaration
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.

Specified by:
setStateChangeListener in interface SheetTagDeclaration

setSortActionListener

public void setSortActionListener(java.lang.String sortActionListener)
Description copied from interface: SheetTagDeclaration
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.

Specified by:
setSortActionListener in interface SheetTagDeclaration

setSelectable

public void setSelectable(java.lang.String selectable)
Description copied from interface: SheetTagDeclaration
Flag indicating whether or not the sheet should be selectable.

Specified by:
setSelectable in interface SheetTagDeclaration


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