Class AbstractUISheet
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
- 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
- Direct Known Subclasses:
- UISheet
public abstract class AbstractUISheet
extends AbstractUIData
implements SheetStateChangeSource, SortActionSource, jakarta.faces.component.behavior.ClientBehaviorHolder, Visual, jakarta.faces.event.ComponentSystemEventListener
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringDeprecated, for removal: This API element is subject to removal in a future version.static final Stringstatic final Stringstatic final StringFields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIDataSUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTEDFields inherited from class jakarta.faces.component.UIDataCOMPONENT_FAMILYFields 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 TypeMethodDescriptionvoidvoidbroadcast(jakarta.faces.event.FacesEvent facesEvent) jakarta.faces.component.behavior.AjaxBehaviorvoidencodeAll(jakarta.faces.context.FacesContext facesContext) voidencodeBegin(jakarta.faces.context.FacesContext facesContext) abstract Stringintabstract IntegerDeprecated, for removal: This API element is subject to removal in a future version.intDetermines the beginning of the last page in the model.intThe rowIndex of the last row on the current page plus one (because of zero based iterating).intabstract Integerbooleanabstract IntegerintgetPages()The number of pages to render.abstract PaginatorModeList<jakarta.faces.component.UIComponent> getRenderedChildrenOf(jakarta.faces.component.UIColumn column) getSheetState(jakarta.faces.context.FacesContext facesContext) abstract ShowPositionDeprecated, for removal: This API element is subject to removal in a future version.abstract ShowPositionDeprecated, for removal: This API element is subject to removal in a future version.abstract ShowPositionDeprecated, for removal: This API element is subject to removal in a future version.getState()booleanvoidinit(jakarta.faces.context.FacesContext facesContext) booleanbooleanisAtEnd()booleanabstract booleanisLazy()booleanisLazyUpdate(jakarta.faces.context.FacesContext facesContext) booleanabstract booleanbooleanThe value describes, if the UIData renderer creates container elements to hold the row information.abstract booleanDeprecated, for removal: This API element is subject to removal in a future version.abstract booleanabstract booleanDeprecated, for removal: This API element is subject to removal in a future version.abstract booleanbooleanvoidperformPaging(PageActionEvent pageEvent) voidprocessDecodes(jakarta.faces.context.FacesContext context) voidprocessEvent(jakarta.faces.event.ComponentSystemEvent event) voidprocessUpdates(jakarta.faces.context.FacesContext context) voidprocessValidators(jakarta.faces.context.FacesContext context) voidqueueEvent(jakarta.faces.event.FacesEvent facesEvent) voidvoidrestoreState(jakarta.faces.context.FacesContext context, Object savedState) saveState(jakarta.faces.context.FacesContext context) voidsetHeaderGrid(Grid headerGrid) voidsetLazyFirstRow(int lazyFirstRow) voidsetLazyUpdate(boolean lazyUpdate) voidsetState(SheetState state) protected voidsort(jakarta.faces.context.FacesContext facesContext, SortActionEvent event) booleanvisitTree(jakarta.faces.component.visit.VisitContext context, jakarta.faces.component.visit.VisitCallback callback) Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIDatacreateTreeDataModel, findComponent, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectable, getSelectableAsEnum, getTreeDataModel, invokeOnComponent, isFolder, isRowsUnlimited, isRowVisible, isShowRoot, isShowRootJunction, isTreeModel, stripRowIndexMethods inherited from class jakarta.faces.component.UIDatacreateUniqueId, encodeEnd, getContainerClientId, getFamily, 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, getDefaultEventName, getEventNames, 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, getClientBehaviors, getDefaultEventName, getEventNamesMethods inherited from interface org.apache.myfaces.tobago.event.SheetStateChangeSourcegetStateChangeListenerExpression, setStateChangeListenerExpressionMethods inherited from interface org.apache.myfaces.tobago.event.SortActionSourcegetSortActionListenerExpression, setSortActionListenerExpressionMethods inherited from interface org.apache.myfaces.tobago.component.VisualgetCustomClass, getMarkup, getRendererType, isPlain, setCustomClass, setMarkup
- 
Field Details- 
COMPONENT_TYPEDeprecated, for removal: This API element is subject to removal in a future version.- See Also:
 
- 
SORTER_ID- See Also:
 
- 
NOT_SORTABLE_COL_MESSAGE_ID- See Also:
 
- 
NOT_SORTABLE_MESSAGE_ID- See Also:
 
 
- 
- 
Constructor Details- 
AbstractUISheetpublic AbstractUISheet()
 
- 
- 
Method Details- 
encodeAll- Overrides:
- encodeAllin class- jakarta.faces.component.UIComponentBase
- Throws:
- IOException
 
- 
encodeBegin- Overrides:
- encodeBeginin class- AbstractUIData
- Throws:
- IOException
 
- 
setState
- 
getState
- 
getSheetState
- 
getColumns
- 
processEventpublic void processEvent(jakarta.faces.event.ComponentSystemEvent event) throws jakarta.faces.event.AbortProcessingException - Specified by:
- processEventin interface- jakarta.faces.event.ComponentSystemEventListener
- Overrides:
- processEventin class- jakarta.faces.component.UIComponent
- Throws:
- jakarta.faces.event.AbortProcessingException
 
- 
getColumnLayout
- 
isAutoLayoutpublic boolean isAutoLayout()
- 
getLastRowIndexOfCurrentPagepublic int getLastRowIndexOfCurrentPage()The rowIndex of the last row on the current page plus one (because of zero based iterating).- Throws:
- IllegalArgumentException- If the number of rows in the model returned by- UIData.getRowCount()is -1 (undefined).
 
- 
getCurrentPagepublic int getCurrentPage()- Returns:
- returns the current page (based by 0).
 
- 
getPagespublic int getPages()The number of pages to render.- Throws:
- IllegalArgumentException- If the number of rows in the model returned by- UIData.getRowCount()is -1 (undefined).
 
- 
getRenderedChildrenOfpublic List<jakarta.faces.component.UIComponent> getRenderedChildrenOf(jakarta.faces.component.UIColumn column) 
- 
isAtBeginningpublic boolean isAtBeginning()- Returns:
- Is the interval to display starting with the first row?
 
- 
hasRowCountpublic boolean hasRowCount()- Returns:
- Does the data model knows the number of rows?
 
- 
isPagingVisiblepublic boolean isPagingVisible()- Returns:
- Should the paging controls be rendered? Either because of the need of paging or because the show is
 enforced by isShowPagingAlways()
 
- 
needMoreThanOnePagepublic boolean needMoreThanOnePage()- Returns:
- Is panging needed to display all rows? If the number of rows is unknown this method returns true.
 
- 
isShowPagingAlwayspublic abstract boolean isShowPagingAlways()
- 
isAtEndpublic boolean isAtEnd()
- 
getFirstRowIndexOfLastPagepublic int getFirstRowIndexOfLastPage()Determines the beginning of the last page in the model. If the number of rows to display on one page is unlimited, the value is 0 (there is only one page).- Returns:
- The index of the first row of the last paging page.
- Throws:
- IllegalArgumentException- If the number of rows in the model returned by- UIData.getRowCount()is -1 (undefined).
 
- 
processDecodespublic void processDecodes(jakarta.faces.context.FacesContext context) - Overrides:
- processDecodesin class- jakarta.faces.component.UIData
 
- 
processValidatorspublic void processValidators(jakarta.faces.context.FacesContext context) - Overrides:
- processValidatorsin class- jakarta.faces.component.UIData
 
- 
processUpdatespublic void processUpdates(jakarta.faces.context.FacesContext context) - Overrides:
- processUpdatesin class- jakarta.faces.component.UIData
 
- 
saveState- Specified by:
- saveStatein interface- jakarta.faces.component.StateHolder
- Overrides:
- saveStatein class- jakarta.faces.component.UIData
 
- 
restoreState- Specified by:
- restoreStatein interface- jakarta.faces.component.StateHolder
- Overrides:
- restoreStatein class- jakarta.faces.component.UIData
 
- 
getAllColumns
- 
queueEventpublic void queueEvent(jakarta.faces.event.FacesEvent facesEvent) - Overrides:
- queueEventin class- jakarta.faces.component.UIData
 
- 
broadcastpublic void broadcast(jakarta.faces.event.FacesEvent facesEvent) throws jakarta.faces.event.AbortProcessingException - Overrides:
- broadcastin class- jakarta.faces.component.UIData
- Throws:
- jakarta.faces.event.AbortProcessingException
 
- 
visitTreepublic boolean visitTree(jakarta.faces.component.visit.VisitContext context, jakarta.faces.component.visit.VisitCallback callback) - Overrides:
- visitTreein class- jakarta.faces.component.UIData
 
- 
isLazyUpdatepublic boolean isLazyUpdate(jakarta.faces.context.FacesContext facesContext) 
- 
initpublic void init(jakarta.faces.context.FacesContext facesContext) 
- 
sort
- 
addStateChangeListener- Specified by:
- addStateChangeListenerin interface- SheetStateChangeSource
 
- 
getStateChangeListeners- Specified by:
- getStateChangeListenersin interface- SheetStateChangeSource
 
- 
removeStateChangeListener- Specified by:
- removeStateChangeListenerin interface- SheetStateChangeSource
 
- 
performPaging
- 
getLazyUpdatepublic boolean getLazyUpdate()
- 
setLazyUpdatepublic void setLazyUpdate(boolean lazyUpdate) 
- 
getLazyFirstRowpublic int getLazyFirstRow()
- 
setLazyFirstRowpublic void setLazyFirstRow(int lazyFirstRow) 
- 
createReloadBehavior
- 
isRendersRowContainerpublic boolean isRendersRowContainer()Description copied from class:AbstractUIDataThe value describes, if the UIData renderer creates container elements to hold the row information. This information is important for the TreeNodeRenderer to set the visible state in the output or not. Typically the Sheet returns true and a Tree returns false, because the sheet renders the HTML TR tags, the the sheet also is responsible for the visible state.- Overrides:
- isRendersRowContainerin class- AbstractUIData
 
- 
isShowHeaderpublic abstract boolean isShowHeader()
- 
getExpandedState- Specified by:
- getExpandedStatein class- AbstractUIData
 
- 
getSelectedState- Specified by:
- getSelectedStatein class- AbstractUIData
 
- 
getHeaderGrid
- 
setHeaderGrid
- 
isShowDirectLinksArrows@Deprecated(since="5.15.0, 6.7.0", forRemoval=true) public abstract boolean isShowDirectLinksArrows()Deprecated, for removal: This API element is subject to removal in a future version.
- 
isShowPageRangeArrowsDeprecated, for removal: This API element is subject to removal in a future version.
- 
getShowRowRangeDeprecated, for removal: This API element is subject to removal in a future version.
- 
getShowPageRangeDeprecated, for removal: This API element is subject to removal in a future version.
- 
getShowDirectLinks@Deprecated(since="5.15.0, 6.7.0", forRemoval=true) public abstract ShowPosition getShowDirectLinks()Deprecated, for removal: This API element is subject to removal in a future version.
- 
getDirectLinkCountDeprecated, for removal: This API element is subject to removal in a future version.
- 
isLazypublic abstract boolean isLazy()
- 
getMaxSortColumns
- 
getLazyRows
- 
getPaginator
- 
isReadonlyRowspublic abstract boolean isReadonlyRows()
 
-