org.apache.myfaces.tobago.component
Class UISheet

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIData
              extended by org.apache.myfaces.tobago.internal.component.AbstractUISheet
                  extended by org.apache.myfaces.tobago.component.UISheet
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder, InvokeOnComponent, OnComponentPopulated, SupportsMarkup, SupportsRenderedPartially, Configurable, SheetStateChangeSource, SortActionSource, SortActionSource2, LayoutBase, LayoutBox, LayoutComponent, LayoutContainer

public class UISheet
extends AbstractUISheet
implements SortActionSource, SortActionSource2, SupportsMarkup

Render a sheet element. UIComponent class, generated from template component1.2.stg with class SheetTagDeclaration.


Field Summary
static String COMPONENT_TYPE
           
 
Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISheet
ATTR_SCROLL_POSITION, FACET_SORTER, MULTI, NONE, SINGLE, SORTER_ID
 
Fields inherited from class javax.faces.component.UIData
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface org.apache.myfaces.tobago.component.OnComponentPopulated
MARKER
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
UISheet()
           
 
Method Summary
 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.
 String getColumns()
          LayoutConstraints for column layout.
 Integer getColumnSpan()
           
 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.
 javax.faces.el.MethodBinding getSortActionListener()
           
 javax.el.MethodExpression getSortActionListenerExpression()
           
 javax.faces.el.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(javax.faces.context.FacesContext context, Object componentState)
           
 Object saveState(javax.faces.context.FacesContext context)
           
 void setBorderBottom(Measure borderBottom)
           
 void setBorderLeft(Measure borderLeft)
           
 void setBorderRight(Measure borderRight)
           
 void setBorderTop(Measure borderTop)
           
 void setColumns(String columns)
           
 void setColumnSpan(Integer columnSpan)
           
 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(javax.faces.el.MethodBinding sortActionListener)
           
 void setSortActionListenerExpression(javax.el.MethodExpression sortActionListenerExpression)
           
 void setStateChangeListener(javax.faces.el.MethodBinding stateChangeListener)
           
 void setTop(Measure top)
           
 void setVerticalIndex(Integer verticalIndex)
           
 void setWidth(Measure width)
           
 
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISheet
addStateChangeListener, broadcast, encodeBegin, findComponent, getAllColumns, getColumnLayout, getComponents, getCurrentPage, getFirstRowIndexOfLastPage, getLast, getLastPageIndex, getLastRowIndexOfCurrentPage, getLayoutComponentRenderer, getLayoutManager, getNeedVerticalScrollbar, getPage, getPages, getRenderedChildrenOf, getRenderedColumns, getScrollPosition, getSheetState, getState, getStateChangeListeners, getWidthList, hasRowCount, hasRows, invokeOnComponent, isAtBeginning, isAtEnd, isLayoutChildren, isPagingVisible, isRowsUnlimited, needMoreThanOnePage, onComponentPopulated, performPaging, processUpdates, queueEvent, removeStateChangeListener, resetColumnWidths, setLayoutManager, setNeedVerticalScrollbar, setState, setWidthList, stripRowIndex
 
Methods inherited from class javax.faces.component.UIData
encodeEnd, getClientId, getDataModel, getFamily, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, processDecodes, processValidators, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setValue, setValueExpression, setVar
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeChildren, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.myfaces.tobago.layout.LayoutComponent
isRendered
 
Methods inherited from interface org.apache.myfaces.tobago.config.Configurable
getRendererType
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

UISheet

public UISheet()
Method Detail

getMarkup

public Markup getMarkup()
Specified by:
getMarkup in interface SupportsMarkup

setMarkup

public void setMarkup(Markup markup)
Specified by:
setMarkup in interface SupportsMarkup

getMarginLeft

public Measure getMarginLeft()
Specified by:
getMarginLeft in interface LayoutBase

setMarginLeft

public void setMarginLeft(Measure marginLeft)
Specified by:
setMarginLeft in interface LayoutBase

getColumns

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

Specified by:
getColumns in class AbstractUISheet

setColumns

public void setColumns(String columns)

getBorderLeft

public Measure getBorderLeft()
This attribute is for internal use only.

Specified by:
getBorderLeft in interface LayoutBox

setBorderLeft

public void setBorderLeft(Measure borderLeft)
Specified by:
setBorderLeft in interface LayoutBox

getHeight

public Measure getHeight()
This value will usually be set by the layout manager.

Specified by:
getHeight in interface LayoutBase

setHeight

public void setHeight(Measure height)
Specified by:
setHeight in interface LayoutBase

getMinimumWidth

public Measure getMinimumWidth()
Specified by:
getMinimumWidth in interface LayoutBase

setMinimumWidth

public void setMinimumWidth(Measure minimumWidth)
Specified by:
setMinimumWidth in interface LayoutBase

getShowDirectLinks

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


setShowDirectLinks

public void setShowDirectLinks(String showDirectLinks)

getShowPageRange

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


setShowPageRange

public void setShowPageRange(String showPageRange)

isOverflowX

public boolean isOverflowX()
This attribute is for internal use only.

Specified by:
isOverflowX in interface LayoutContainer

setOverflowX

public void setOverflowX(boolean overflowX)
Specified by:
setOverflowX in interface LayoutContainer

isOverflowY

public boolean isOverflowY()
This attribute is for internal use only.

Specified by:
isOverflowY in interface LayoutContainer

setOverflowY

public void setOverflowY(boolean overflowY)
Specified by:
setOverflowY in interface LayoutContainer

getForceVerticalScrollbar

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

Default: auto
Allowed Values: auto,true,false


setForceVerticalScrollbar

public void setForceVerticalScrollbar(String forceVerticalScrollbar)

getStateChangeListener

public javax.faces.el.MethodBinding getStateChangeListener()
Specified by:
getStateChangeListener in interface SheetStateChangeSource

setStateChangeListener

public void setStateChangeListener(javax.faces.el.MethodBinding stateChangeListener)
Specified by:
setStateChangeListener in interface SheetStateChangeSource

getBorderRight

public Measure getBorderRight()
This attribute is for internal use only.

Specified by:
getBorderRight in interface LayoutBox

setBorderRight

public void setBorderRight(Measure borderRight)
Specified by:
setBorderRight in interface LayoutBox

getMaximumHeight

public Measure getMaximumHeight()
Specified by:
getMaximumHeight in interface LayoutBase

setMaximumHeight

public void setMaximumHeight(Measure maximumHeight)
Specified by:
setMaximumHeight in interface LayoutBase

getCurrentWidth

public Measure getCurrentWidth()
This value will usually be set by the layout manager. It holds the current width computed by the layout manager.

Specified by:
getCurrentWidth in interface LayoutBase

setCurrentWidth

public void setCurrentWidth(Measure currentWidth)
Specified by:
setCurrentWidth in interface LayoutBase

getPaddingTop

public Measure getPaddingTop()
This attribute is for internal use only.

Specified by:
getPaddingTop in interface LayoutBox

setPaddingTop

public void setPaddingTop(Measure paddingTop)
Specified by:
setPaddingTop in interface LayoutBox

getMarginTop

public Measure getMarginTop()
Specified by:
getMarginTop in interface LayoutBase

setMarginTop

public void setMarginTop(Measure marginTop)
Specified by:
setMarginTop in interface LayoutBase

getWidth

public Measure getWidth()
This value will usually be set by the layout manager.

Specified by:
getWidth in interface LayoutBase

setWidth

public void setWidth(Measure width)
Specified by:
setWidth in interface LayoutBase

getCurrentHeight

public Measure getCurrentHeight()
This value will usually be set by the layout manager. It holds the current height computed by the layout manager.

Specified by:
getCurrentHeight in interface LayoutBase

setCurrentHeight

public void setCurrentHeight(Measure currentHeight)
Specified by:
setCurrentHeight in interface LayoutBase

getBorderBottom

public Measure getBorderBottom()
This attribute is for internal use only.

Specified by:
getBorderBottom in interface LayoutBox

setBorderBottom

public void setBorderBottom(Measure borderBottom)
Specified by:
setBorderBottom in interface LayoutBox

getDisplay

public Display getDisplay()
This attribute is for internal use only.

Specified by:
getDisplay in interface LayoutComponent

setDisplay

public void setDisplay(Display display)
Specified by:
setDisplay in interface LayoutComponent

getPaddingLeft

public Measure getPaddingLeft()
This attribute is for internal use only.

Specified by:
getPaddingLeft in interface LayoutBox

setPaddingLeft

public void setPaddingLeft(Measure paddingLeft)
Specified by:
setPaddingLeft in interface LayoutBox

getPreferredWidth

public Measure getPreferredWidth()
Specified by:
getPreferredWidth in interface LayoutBase

setPreferredWidth

public void setPreferredWidth(Measure preferredWidth)
Specified by:
setPreferredWidth in interface LayoutBase

getBorderTop

public Measure getBorderTop()
This attribute is for internal use only.

Specified by:
getBorderTop in interface LayoutBox

setBorderTop

public void setBorderTop(Measure borderTop)
Specified by:
setBorderTop in interface LayoutBox

getVerticalIndex

public Integer getVerticalIndex()
This attribute is for internal use only.

Specified by:
getVerticalIndex in interface LayoutComponent

setVerticalIndex

public void setVerticalIndex(Integer verticalIndex)
Specified by:
setVerticalIndex in interface LayoutComponent

isShowPagingAlways

public boolean isShowPagingAlways()
Flag indicating whether or not the paging panel should be display, if it is not needed for paging.

Default: false

Specified by:
isShowPagingAlways in class AbstractUISheet

setShowPagingAlways

public void setShowPagingAlways(boolean showPagingAlways)

getCurrentMarkup

public Markup getCurrentMarkup()
Specified by:
getCurrentMarkup in interface SupportsMarkup
Specified by:
getCurrentMarkup in interface Configurable

setCurrentMarkup

public void setCurrentMarkup(Markup currentMarkup)
Specified by:
setCurrentMarkup in interface SupportsMarkup

getRenderedPartially

public String[] getRenderedPartially()
Indicate the partially rendered Components in a case of a submit.

Specified by:
getRenderedPartially in interface SupportsRenderedPartially

setRenderedPartially

public void setRenderedPartially(String[] renderedPartially)
Specified by:
setRenderedPartially in interface SupportsRenderedPartially

getMinimumHeight

public Measure getMinimumHeight()
Specified by:
getMinimumHeight in interface LayoutBase

setMinimumHeight

public void setMinimumHeight(Measure minimumHeight)
Specified by:
setMinimumHeight in interface LayoutBase

getRowSpan

public Integer getRowSpan()
Specified by:
getRowSpan in interface LayoutComponent

setRowSpan

public void setRowSpan(Integer rowSpan)
Specified by:
setRowSpan in interface LayoutComponent

getLeft

public Measure getLeft()
This value will usually be set by the layout manager.

Specified by:
getLeft in interface LayoutBase

setLeft

public void setLeft(Measure left)
Specified by:
setLeft in interface LayoutBase

getColumnSpan

public Integer getColumnSpan()
Specified by:
getColumnSpan in interface LayoutComponent

setColumnSpan

public void setColumnSpan(Integer columnSpan)
Specified by:
setColumnSpan in interface LayoutComponent

getPaddingBottom

public Measure getPaddingBottom()
This attribute is for internal use only.

Specified by:
getPaddingBottom in interface LayoutBox

setPaddingBottom

public void setPaddingBottom(Measure paddingBottom)
Specified by:
setPaddingBottom in interface LayoutBox

getTop

public Measure getTop()
This value will usually be set by the layout manager.

Specified by:
getTop in interface LayoutBase

setTop

public void setTop(Measure top)
Specified by:
setTop in interface LayoutBase

getShowRowRange

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


setShowRowRange

public void setShowRowRange(String showRowRange)

getMarginRight

public Measure getMarginRight()
Specified by:
getMarginRight in interface LayoutBase

setMarginRight

public void setMarginRight(Measure marginRight)
Specified by:
setMarginRight in interface LayoutBase

getPreferredHeight

public Measure getPreferredHeight()
Specified by:
getPreferredHeight in interface LayoutBase

setPreferredHeight

public void setPreferredHeight(Measure preferredHeight)
Specified by:
setPreferredHeight in interface LayoutBase

getMaximumWidth

public Measure getMaximumWidth()
Specified by:
getMaximumWidth in interface LayoutBase

setMaximumWidth

public void setMaximumWidth(Measure maximumWidth)
Specified by:
setMaximumWidth in interface LayoutBase

getPaddingRight

public Measure getPaddingRight()
This attribute is for internal use only.

Specified by:
getPaddingRight in interface LayoutBox

setPaddingRight

public void setPaddingRight(Measure paddingRight)
Specified by:
setPaddingRight in interface LayoutBox

getMarginBottom

public Measure getMarginBottom()
Specified by:
getMarginBottom in interface LayoutBase

setMarginBottom

public void setMarginBottom(Measure marginBottom)
Specified by:
setMarginBottom in interface LayoutBase

getSelectable

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


setSelectable

public void setSelectable(String selectable)

isShowHeader

public boolean isShowHeader()
Flag indicating the header should be rendered.
Default: true

Specified by:
isShowHeader in class AbstractUISheet

setShowHeader

public void setShowHeader(boolean showHeader)

getDirectLinkCount

public Integer getDirectLinkCount()
The count of rendered direct paging links in the sheet's footer.

Default: 9


setDirectLinkCount

public void setDirectLinkCount(Integer directLinkCount)

getSortActionListener

public javax.faces.el.MethodBinding getSortActionListener()
Specified by:
getSortActionListener in interface SortActionSource

setSortActionListener

public void setSortActionListener(javax.faces.el.MethodBinding sortActionListener)
Specified by:
setSortActionListener in interface SortActionSource

getSortActionListenerExpression

public javax.el.MethodExpression getSortActionListenerExpression()
Specified by:
getSortActionListenerExpression in interface SortActionSource2

setSortActionListenerExpression

public void setSortActionListenerExpression(javax.el.MethodExpression sortActionListenerExpression)
Specified by:
setSortActionListenerExpression in interface SortActionSource2

getHorizontalIndex

public Integer getHorizontalIndex()
This attribute is for internal use only.

Specified by:
getHorizontalIndex in interface LayoutComponent

setHorizontalIndex

public void setHorizontalIndex(Integer horizontalIndex)
Specified by:
setHorizontalIndex in interface LayoutComponent

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object componentState)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class AbstractUISheet

saveState

public Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class AbstractUISheet


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