public class

UISheet

extends AbstractUISheet
implements SupportsMarkup SortActionSource SortActionSource2
java.lang.Object
   ↳ javax.faces.component.UIComponent
     ↳ javax.faces.component.UIComponentBase
       ↳ javax.faces.component.UIData
         ↳ org.apache.myfaces.tobago.internal.component.AbstractUISheet
           ↳ org.apache.myfaces.tobago.component.UISheet

Class Overview

Render a sheet element. UIComponent class, generated from template component1.2.stg with class org.apache.myfaces.tobago.internal.taglib.component.SheetTagDeclaration.

Summary

Constants
String COMPONENT_TYPE
[Expand]
Inherited Constants
From class org.apache.myfaces.tobago.internal.component.AbstractUISheet
From class javax.faces.component.UIData
From interface javax.faces.component.NamingContainer
From interface org.apache.myfaces.tobago.component.OnComponentPopulated
[Expand]
Inherited Fields
From class javax.faces.component.UIComponent
Public Constructors
UISheet()
Public Methods
Measure getBorderBottom()
This attribute is for internal use only.
Measure getBorderLeft()
This attribute is for internal use only.
Measure getBorderRight()
This attribute is for internal use only.
Measure getBorderTop()
This attribute is for internal use only.
Integer getColumnSpan()
String getColumns()
LayoutConstraints for column layout.
Measure getCurrentHeight()
This value will usually be set by the layout manager.
Markup getCurrentMarkup()
Measure getCurrentWidth()
This value will usually be set by the layout manager.
Integer getDirectLinkCount()
The count of rendered direct paging links in the sheet's footer.
Display getDisplay()
This attribute is for internal use only.
String getForceVerticalScrollbar()
Flag indicating whether or not this sheet should reserve space for vertical toolbar when calculating column width's.
Measure getHeight()
This value will usually be set by the layout manager.
Integer getHorizontalIndex()
This attribute is for internal use only.
Measure getLeft()
This value will usually be set by the layout manager.
Measure getMarginBottom()
Measure getMarginLeft()
Measure getMarginRight()
Measure getMarginTop()
Markup getMarkup()
Measure getMaximumHeight()
Measure getMaximumWidth()
Measure getMinimumHeight()
Measure getMinimumWidth()
Measure getPaddingBottom()
This attribute is for internal use only.
Measure getPaddingLeft()
This attribute is for internal use only.
Measure getPaddingRight()
This attribute is for internal use only.
Measure getPaddingTop()
This attribute is for internal use only.
Measure getPreferredHeight()
Measure getPreferredWidth()
String[] getRenderedPartially()
Indicate the partially rendered Components in a case of a submit.
Integer getRowSpan()
String getSelectable()
Flag indicating whether or not the sheet should be selectable.
String getShowDirectLinks()
Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.
String getShowPageRange()
Flag indicating whether and where the range pages should rendered in the sheet's footer.
String getShowRowRange()
Flag indicating whether or not the range of displayed rows should rendered in the sheet's footer.
MethodBinding getSortActionListener()
MethodExpression getSortActionListenerExpression()
MethodBinding getStateChangeListener()
Measure getTop()
This value will usually be set by the layout manager.
Integer getVerticalIndex()
This attribute is for internal use only.
Measure getWidth()
This value will usually be set by the layout manager.
boolean isOverflowX()
This attribute is for internal use only.
boolean isOverflowY()
This attribute is for internal use only.
boolean isShowHeader()
Flag indicating the header should be rendered.
boolean isShowPagingAlways()
Flag indicating whether or not the paging panel should be display, if it is not needed for paging.
void restoreState(FacesContext context, Object componentState)
Object saveState(FacesContext context)
void setBorderBottom(Measure borderBottom)
void setBorderLeft(Measure borderLeft)
void setBorderRight(Measure borderRight)
void setBorderTop(Measure borderTop)
void setColumnSpan(Integer columnSpan)
void setColumns(String columns)
void setCurrentHeight(Measure currentHeight)
void setCurrentMarkup(Markup currentMarkup)
void setCurrentWidth(Measure currentWidth)
void setDirectLinkCount(Integer directLinkCount)
void setDisplay(Display display)
void setForceVerticalScrollbar(String forceVerticalScrollbar)
void setHeight(Measure height)
void setHorizontalIndex(Integer horizontalIndex)
void setLeft(Measure left)
void setMarginBottom(Measure marginBottom)
void setMarginLeft(Measure marginLeft)
void setMarginRight(Measure marginRight)
void setMarginTop(Measure marginTop)
void setMarkup(Markup markup)
void setMaximumHeight(Measure maximumHeight)
void setMaximumWidth(Measure maximumWidth)
void setMinimumHeight(Measure minimumHeight)
void setMinimumWidth(Measure minimumWidth)
void setOverflowX(boolean overflowX)
void setOverflowY(boolean overflowY)
void setPaddingBottom(Measure paddingBottom)
void setPaddingLeft(Measure paddingLeft)
void setPaddingRight(Measure paddingRight)
void setPaddingTop(Measure paddingTop)
void setPreferredHeight(Measure preferredHeight)
void setPreferredWidth(Measure preferredWidth)
void setRenderedPartially(String[] renderedPartially)
void setRowSpan(Integer rowSpan)
void setSelectable(String selectable)
void setShowDirectLinks(String showDirectLinks)
void setShowHeader(boolean showHeader)
void setShowPageRange(String showPageRange)
void setShowPagingAlways(boolean showPagingAlways)
void setShowRowRange(String showRowRange)
void setSortActionListener(MethodBinding sortActionListener)
void setSortActionListenerExpression(MethodExpression sortActionListenerExpression)
void setStateChangeListener(MethodBinding stateChangeListener)
void setTop(Measure top)
void setVerticalIndex(Integer verticalIndex)
void setWidth(Measure width)
[Expand]
Inherited Methods
From class org.apache.myfaces.tobago.internal.component.AbstractUISheet
From class javax.faces.component.UIData
From class javax.faces.component.UIComponentBase
From class javax.faces.component.UIComponent
From class java.lang.Object
From interface javax.faces.component.StateHolder
From interface org.apache.myfaces.tobago.compat.InvokeOnComponent
From interface org.apache.myfaces.tobago.component.OnComponentPopulated
From interface org.apache.myfaces.tobago.component.SupportsMarkup
From interface org.apache.myfaces.tobago.component.SupportsRenderedPartially
From interface org.apache.myfaces.tobago.config.Configurable
From interface org.apache.myfaces.tobago.event.SheetStateChangeSource
From interface org.apache.myfaces.tobago.event.SortActionSource
From interface org.apache.myfaces.tobago.event.SortActionSource2
From interface org.apache.myfaces.tobago.layout.LayoutBase
From interface org.apache.myfaces.tobago.layout.LayoutBox
From interface org.apache.myfaces.tobago.layout.LayoutComponent
From interface org.apache.myfaces.tobago.layout.LayoutContainer

Constants

public static final String COMPONENT_TYPE

Constant Value: "org.apache.myfaces.tobago.Sheet"

Public Constructors

public UISheet ()

Public Methods

public Measure getBorderBottom ()

This attribute is for internal use only.

public Measure getBorderLeft ()

This attribute is for internal use only.

public Measure getBorderRight ()

This attribute is for internal use only.

public Measure getBorderTop ()

This attribute is for internal use only.

public Integer getColumnSpan ()

public String getColumns ()

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

public Measure getCurrentHeight ()

This value will usually be set by the layout manager. It holds the current height computed by the layout manager.

public Markup getCurrentMarkup ()

public Measure getCurrentWidth ()

This value will usually be set by the layout manager. It holds the current width computed by the layout manager.

public Integer getDirectLinkCount ()

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

Default: 9

public Display getDisplay ()

This attribute is for internal use only.

public String getForceVerticalScrollbar ()

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.
        

Default: auto
Allowed Values: auto,true,false

public Measure getHeight ()

This value will usually be set by the layout manager.

public Integer getHorizontalIndex ()

This attribute is for internal use only.

public Measure getLeft ()

This value will usually be set by the layout manager.

public Measure getMarginBottom ()

public Measure getMarginLeft ()

public Measure getMarginRight ()

public Measure getMarginTop ()

public Markup getMarkup ()

public Measure getMaximumHeight ()

public Measure getMaximumWidth ()

public Measure getMinimumHeight ()

public Measure getMinimumWidth ()

public Measure getPaddingBottom ()

This attribute is for internal use only.

public Measure getPaddingLeft ()

This attribute is for internal use only.

public Measure getPaddingRight ()

This attribute is for internal use only.

public Measure getPaddingTop ()

This attribute is for internal use only.

public Measure getPreferredHeight ()

public Measure getPreferredWidth ()

public String[] getRenderedPartially ()

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

public Integer getRowSpan ()

public String getSelectable ()

Flag indicating whether or not the sheet should be selectable.
Default: multi
Allowed Values: none,single,singleOrNone,multi

public String getShowDirectLinks ()

Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.
Default: center
Allowed Values: left,center,right,none

public String getShowPageRange ()

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.
Default: right
Allowed Values: left,center,right,none

public String getShowRowRange ()

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.
Default: left
Allowed Values: left,center,right,none

public MethodBinding getSortActionListener ()

public MethodExpression getSortActionListenerExpression ()

public MethodBinding getStateChangeListener ()

public Measure getTop ()

This value will usually be set by the layout manager.

public Integer getVerticalIndex ()

This attribute is for internal use only.

public Measure getWidth ()

This value will usually be set by the layout manager.

public boolean isOverflowX ()

This attribute is for internal use only.

public boolean isOverflowY ()

This attribute is for internal use only.

public boolean isShowHeader ()

Flag indicating the header should be rendered.
Default: true

public boolean isShowPagingAlways ()

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.

Default: false

public void restoreState (FacesContext context, Object componentState)

public Object saveState (FacesContext context)

public void setBorderBottom (Measure borderBottom)

public void setBorderLeft (Measure borderLeft)

public void setBorderRight (Measure borderRight)

public void setBorderTop (Measure borderTop)

public void setColumnSpan (Integer columnSpan)

public void setColumns (String columns)

public void setCurrentHeight (Measure currentHeight)

public void setCurrentMarkup (Markup currentMarkup)

public void setCurrentWidth (Measure currentWidth)

public void setDirectLinkCount (Integer directLinkCount)

public void setDisplay (Display display)

public void setForceVerticalScrollbar (String forceVerticalScrollbar)

public void setHeight (Measure height)

public void setHorizontalIndex (Integer horizontalIndex)

public void setLeft (Measure left)

public void setMarginBottom (Measure marginBottom)

public void setMarginLeft (Measure marginLeft)

public void setMarginRight (Measure marginRight)

public void setMarginTop (Measure marginTop)

public void setMarkup (Markup markup)

public void setMaximumHeight (Measure maximumHeight)

public void setMaximumWidth (Measure maximumWidth)

public void setMinimumHeight (Measure minimumHeight)

public void setMinimumWidth (Measure minimumWidth)

public void setOverflowX (boolean overflowX)

public void setOverflowY (boolean overflowY)

public void setPaddingBottom (Measure paddingBottom)

public void setPaddingLeft (Measure paddingLeft)

public void setPaddingRight (Measure paddingRight)

public void setPaddingTop (Measure paddingTop)

public void setPreferredHeight (Measure preferredHeight)

public void setPreferredWidth (Measure preferredWidth)

public void setRenderedPartially (String[] renderedPartially)

public void setRowSpan (Integer rowSpan)

public void setSelectable (String selectable)

public void setShowDirectLinks (String showDirectLinks)

public void setShowHeader (boolean showHeader)

public void setShowPageRange (String showPageRange)

public void setShowPagingAlways (boolean showPagingAlways)

public void setShowRowRange (String showRowRange)

public void setSortActionListener (MethodBinding sortActionListener)

public void setSortActionListenerExpression (MethodExpression sortActionListenerExpression)

public void setStateChangeListener (MethodBinding stateChangeListener)

public void setTop (Measure top)

public void setVerticalIndex (Integer verticalIndex)

public void setWidth (Measure width)