Class UISheet
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIData
org.apache.myfaces.tobago.internal.component.AbstractUIData
org.apache.myfaces.tobago.internal.component.AbstractUISheet
org.apache.myfaces.tobago.component.UISheet
- All Implemented Interfaces:
- jakarta.faces.component.behavior.ClientBehaviorHolder,- jakarta.faces.component.NamingContainer,- jakarta.faces.component.PartialStateHolder,- jakarta.faces.component.StateHolder,- jakarta.faces.component.TransientStateHolder,- jakarta.faces.component.UniqueIdVendor,- jakarta.faces.event.ComponentSystemEventListener,- jakarta.faces.event.FacesListener,- jakarta.faces.event.SystemEventListenerHolder,- EventListener,- Visual,- SheetStateChangeSource,- SortActionSource
Render a sheet element.
 UIComponent class, generated from template 
component.stg with class
 SheetTagDeclaration.- 
Field SummaryFieldsFields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISheetNOT_SORTABLE_COL_MESSAGE_ID, NOT_SORTABLE_MESSAGE_ID, SORTER_IDFields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIDataSUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTEDFields inherited from class jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEYFields inherited from interface jakarta.faces.component.NamingContainerSEPARATOR_CHAR
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionLayoutConstraints for column layout.Sets a CSS class in its parent, if the parent supports it.Deprecated.Indicate how many rows are loaded at once when lazy loading is enabled.The maximum count of multi-sorted columns to indicate.Create paginator components automatically or do it manually.Indicating the selection mode of the sheet.Deprecated.Deprecated.Deprecated.jakarta.el.MethodExpressionjakarta.el.MethodExpressionbooleanisLazy()Lazy loading by scroll event.booleanFlag indicating that the rows of the sheet are readonly.booleanDeprecated.booleanFlag indicating the header should be rendered.booleanDeprecated.booleanDeprecated.booleanOnly applicable in the case that the data model is a tree.booleanOnly applicable in the case that the data model is a tree.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetColumns(String columns) voidsetCustomClass(CustomClass customClass) voidsetDirectLinkCount(Integer directLinkCount) Deprecated.voidsetLazy(boolean lazy) voidsetLazyRows(Integer lazyRows) voidvoidsetMaxSortColumns(Integer maxSortColumns) voidsetPaginator(PaginatorMode paginator) voidsetReadonlyRows(boolean readonlyRows) voidsetSelectable(Selectable selectable) voidsetShowDirectLinks(ShowPosition showDirectLinks) Deprecated.voidsetShowDirectLinksArrows(boolean showDirectLinksArrows) Deprecated.voidsetShowHeader(boolean showHeader) voidsetShowPageRange(ShowPosition showPageRange) Deprecated.voidsetShowPageRangeArrows(boolean showPageRangeArrows) Deprecated.voidsetShowPagingAlways(boolean showPagingAlways) Deprecated.voidsetShowRoot(boolean showRoot) voidsetShowRootJunction(boolean showRootJunction) voidsetShowRowRange(ShowPosition showRowRange) Deprecated.voidsetSortActionListenerExpression(jakarta.el.MethodExpression sortActionListener) voidsetStateChangeListenerExpression(jakarta.el.MethodExpression stateChangeListener) Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISheetaddStateChangeListener, broadcast, createReloadBehavior, encodeAll, encodeBegin, getAllColumns, getColumnLayout, getCurrentPage, getExpandedState, getFirstRowIndexOfLastPage, getHeaderGrid, getLastRowIndexOfCurrentPage, getLazyFirstRow, getLazyUpdate, getPages, getRenderedChildrenOf, getSelectedState, getSheetState, getState, getStateChangeListeners, hasRowCount, init, isAtBeginning, isAtEnd, isAutoLayout, isLazyUpdate, isPagingVisible, isRendersRowContainer, needMoreThanOnePage, performPaging, processDecodes, processEvent, processUpdates, processValidators, queueEvent, removeStateChangeListener, saveState, setHeaderGrid, setLazyFirstRow, setLazyUpdate, setState, sort, visitTreeMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIDatacreateTreeDataModel, findComponent, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, invokeOnComponent, isFolder, isRowsUnlimited, isRowVisible, isTreeModel, stripRowIndexMethods inherited from class jakarta.faces.component.UIDatacreateUniqueId, encodeEnd, getContainerClientId, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, isRowStatePreserved, markInitialState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueExpression, setVarMethods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransientMethods inherited from class jakarta.faces.component.UIComponentgetClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviorsMethods inherited from interface org.apache.myfaces.tobago.component.VisualgetRendererType, isPlain
- 
Field Details- 
COMPONENT_TYPE
- 
COMPONENT_FAMILY- See Also:
 
 
- 
- 
Constructor Details- 
UISheetpublic UISheet()
 
- 
- 
Method Details- 
getEventNames- Specified by:
- getEventNamesin interface- jakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getEventNamesin class- jakarta.faces.component.UIComponentBase
 
- 
getDefaultEventName- Specified by:
- getDefaultEventNamein interface- jakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getDefaultEventNamein class- jakarta.faces.component.UIComponentBase
 
- 
getFamily- Overrides:
- getFamilyin class- jakarta.faces.component.UIData
 
- 
getShowPageRangeDeprecated.Flag indicating whether and where the range pages should be 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- Specified by:
- getShowPageRangein class- AbstractUISheet
 
- 
setShowPageRangeDeprecated.
- 
getColumnsLayoutConstraints for column layout. Contains a space separated list of layout tokens '<n>fr', '<x>px', '<x>%' or 'auto', where x is a number and n is an integer. - Specified by:
- getColumnsin class- AbstractUISheet
 
- 
setColumns
- 
isLazypublic boolean isLazy()Lazy loading by scroll event.
 Default:false- Specified by:
- isLazyin class- AbstractUISheet
 
- 
setLazypublic void setLazy(boolean lazy) 
- 
getSelectableIndicating the selection mode of the sheet.
 Default:multi
 Allowed Values:none,single,singleOrNone,multi- Specified by:
- getSelectablein class- AbstractUIData
 
- 
setSelectable
- 
getShowDirectLinksDeprecated.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- Specified by:
- getShowDirectLinksin class- AbstractUISheet
 
- 
setShowDirectLinksDeprecated.
- 
getLazyRowsIndicate how many rows are loaded at once when lazy loading is enabled. Default is 50.
 Default:50- Specified by:
- getLazyRowsin class- AbstractUISheet
 
- 
setLazyRows
- 
getStateChangeListenerExpressionpublic jakarta.el.MethodExpression getStateChangeListenerExpression()
- 
setStateChangeListenerExpressionpublic void setStateChangeListenerExpression(jakarta.el.MethodExpression stateChangeListener) 
- 
getPaginatorCreate paginator components automatically or do it manually.- 
        custom: no paginator is created automatically, you have to do it manually.
        This can be done
        using a <tc:paginatorPanel>with e.g. a<tc:paginatorList>and/or some other paginator components.
- auto: a appropriate paginator is used.
- 
       list: a <tc:paginatorList>is used.
- 
       page: a <tc:paginatorPage>is used.
- 
       row: a <tc:paginatorRow>is used.
- 
       useShowAttributes (default):
       is deprecated, use for compatibility.
       The used paginators are defined by the show-attributes:
       showDirectLinks,showPageRange,showRowRange,directLinkCount,showDirectLinksArrows,showPageRangeArrows,showPagingAlways.
 
 Default:useShowAttributes
 Allowed Values:auto,custom,list,page,row,useShowAttributes- Specified by:
- getPaginatorin class- AbstractUISheet
 
- 
        custom: no paginator is created automatically, you have to do it manually.
        This can be done
        using a 
- 
setPaginator
- 
getMarkup
- 
setMarkup
- 
isShowPagingAlwaysDeprecated.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- Specified by:
- isShowPagingAlwaysin class- AbstractUISheet
 
- showPagingAlways="false" which is the default means, that the paging footer should be displayed,
   only when it is needed.
   
- 
setShowPagingAlwaysDeprecated.
- 
getDirectLinkCountDeprecated.The count of rendered direct paging links in the sheet's footer.
 Default:9- Specified by:
- getDirectLinkCountin class- AbstractUISheet
 
- 
setDirectLinkCountDeprecated.
- 
isShowRootJunctionpublic boolean isShowRootJunction()Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed with an open-close-switch.
 Default:false- Overrides:
- isShowRootJunctionin class- AbstractUIData
 
- 
setShowRootJunctionpublic void setShowRootJunction(boolean showRootJunction) 
- 
isShowHeaderpublic boolean isShowHeader()Flag indicating the header should be rendered.
 Default:true- Specified by:
- isShowHeaderin class- AbstractUISheet
 
- 
setShowHeaderpublic void setShowHeader(boolean showHeader) 
- 
isShowPageRangeArrowsDeprecated.Flag indicating if paging arrows are shown near page range
 Default:true- Specified by:
- isShowPageRangeArrowsin class- AbstractUISheet
 
- 
setShowPageRangeArrowsDeprecated.
- 
getSortActionListenerExpressionpublic jakarta.el.MethodExpression getSortActionListenerExpression()
- 
setSortActionListenerExpressionpublic void setSortActionListenerExpression(jakarta.el.MethodExpression sortActionListener) 
- 
isShowDirectLinksArrowsDeprecated.Flag indicating if paging arrows are shown near direct links
 Default:false- Specified by:
- isShowDirectLinksArrowsin class- AbstractUISheet
 
- 
setShowDirectLinksArrowsDeprecated.
- 
isReadonlyRowspublic boolean isReadonlyRows()Flag indicating that the rows of the sheet are readonly. The readonly attribute is a performance optimization hint used during {
 Default:false- Specified by:
- isReadonlyRowsin class- AbstractUISheet
 
- 
setReadonlyRowspublic void setReadonlyRows(boolean readonlyRows) 
- 
isShowRootpublic boolean isShowRoot()Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed. Often in tree structures the root node is special and should not be displayed.
 Default:false- Specified by:
- isShowRootin class- AbstractUIData
 
- 
setShowRootpublic void setShowRoot(boolean showRoot) 
- 
getShowRowRangeDeprecated.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- Specified by:
- getShowRowRangein class- AbstractUISheet
 
- 
setShowRowRangeDeprecated.
- 
getMaxSortColumnsThe maximum count of multi-sorted columns to indicate.
 Default:0- Specified by:
- getMaxSortColumnsin class- AbstractUISheet
 
- 
setMaxSortColumns
- 
getCustomClassSets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>One capability is, to used external CSS libs.
 This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.
- 
setCustomClass
- 
restoreState- Specified by:
- restoreStatein interface- jakarta.faces.component.StateHolder
- Overrides:
- restoreStatein class- AbstractUISheet
 
 
-