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 Summary
FieldsModifier 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.AbstractUIData
SUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTEDFields inherited from class jakarta.faces.component.UIData
COMPONENT_FAMILYFields inherited from class jakarta.faces.component.UIComponent
ATTRS_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.NamingContainer
SEPARATOR_CHAR -
Constructor Summary
Constructors -
Method Summary
Modifier 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.AbstractUIData
createTreeDataModel, findComponent, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectable, getSelectableAsEnum, getTreeDataModel, invokeOnComponent, isFolder, isRowsUnlimited, isRowVisible, isShowRoot, isShowRootJunction, isTreeModel, stripRowIndexMethods inherited from class jakarta.faces.component.UIData
createUniqueId, 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.UIComponentBase
addClientBehavior, 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.UIComponent
getClientId, 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.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNamesMethods inherited from interface org.apache.myfaces.tobago.event.SheetStateChangeSource
getStateChangeListenerExpression, setStateChangeListenerExpressionMethods inherited from interface org.apache.myfaces.tobago.event.SortActionSource
getSortActionListenerExpression, setSortActionListenerExpressionMethods inherited from interface org.apache.myfaces.tobago.component.Visual
getCustomClass, getMarkup, getRendererType, isPlain, setCustomClass, setMarkup
-
Field Details
-
COMPONENT_TYPE
Deprecated, 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
-
AbstractUISheet
public AbstractUISheet()
-
-
Method Details
-
encodeAll
- Overrides:
encodeAllin classjakarta.faces.component.UIComponentBase- Throws:
IOException
-
encodeBegin
- Overrides:
encodeBeginin classAbstractUIData- Throws:
IOException
-
setState
-
getState
-
getSheetState
-
getColumns
-
processEvent
public void processEvent(jakarta.faces.event.ComponentSystemEvent event) throws jakarta.faces.event.AbortProcessingException - Specified by:
processEventin interfacejakarta.faces.event.ComponentSystemEventListener- Overrides:
processEventin classjakarta.faces.component.UIComponent- Throws:
jakarta.faces.event.AbortProcessingException
-
getColumnLayout
-
isAutoLayout
public boolean isAutoLayout() -
getLastRowIndexOfCurrentPage
public 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 byUIData.getRowCount()is -1 (undefined).
-
getCurrentPage
public int getCurrentPage()- Returns:
- returns the current page (based by 0).
-
getPages
public int getPages()The number of pages to render.- Throws:
IllegalArgumentException- If the number of rows in the model returned byUIData.getRowCount()is -1 (undefined).
-
getRenderedChildrenOf
public List<jakarta.faces.component.UIComponent> getRenderedChildrenOf(jakarta.faces.component.UIColumn column) -
isAtBeginning
public boolean isAtBeginning()- Returns:
- Is the interval to display starting with the first row?
-
hasRowCount
public boolean hasRowCount()- Returns:
- Does the data model knows the number of rows?
-
isPagingVisible
public boolean isPagingVisible()- Returns:
- Should the paging controls be rendered? Either because of the need of paging or because the show is
enforced by
isShowPagingAlways()
-
needMoreThanOnePage
public boolean needMoreThanOnePage()- Returns:
- Is panging needed to display all rows? If the number of rows is unknown this method returns true.
-
isShowPagingAlways
public abstract boolean isShowPagingAlways() -
isAtEnd
public boolean isAtEnd() -
getFirstRowIndexOfLastPage
public 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 byUIData.getRowCount()is -1 (undefined).
-
processDecodes
public void processDecodes(jakarta.faces.context.FacesContext context) - Overrides:
processDecodesin classjakarta.faces.component.UIData
-
processValidators
public void processValidators(jakarta.faces.context.FacesContext context) - Overrides:
processValidatorsin classjakarta.faces.component.UIData
-
processUpdates
public void processUpdates(jakarta.faces.context.FacesContext context) - Overrides:
processUpdatesin classjakarta.faces.component.UIData
-
saveState
- Specified by:
saveStatein interfacejakarta.faces.component.StateHolder- Overrides:
saveStatein classjakarta.faces.component.UIData
-
restoreState
- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIData
-
getAllColumns
-
queueEvent
public void queueEvent(jakarta.faces.event.FacesEvent facesEvent) - Overrides:
queueEventin classjakarta.faces.component.UIData
-
broadcast
public void broadcast(jakarta.faces.event.FacesEvent facesEvent) throws jakarta.faces.event.AbortProcessingException - Overrides:
broadcastin classjakarta.faces.component.UIData- Throws:
jakarta.faces.event.AbortProcessingException
-
visitTree
public boolean visitTree(jakarta.faces.component.visit.VisitContext context, jakarta.faces.component.visit.VisitCallback callback) - Overrides:
visitTreein classjakarta.faces.component.UIData
-
isLazyUpdate
public boolean isLazyUpdate(jakarta.faces.context.FacesContext facesContext) -
init
public void init(jakarta.faces.context.FacesContext facesContext) -
sort
-
addStateChangeListener
- Specified by:
addStateChangeListenerin interfaceSheetStateChangeSource
-
getStateChangeListeners
- Specified by:
getStateChangeListenersin interfaceSheetStateChangeSource
-
removeStateChangeListener
- Specified by:
removeStateChangeListenerin interfaceSheetStateChangeSource
-
performPaging
-
getLazyUpdate
public boolean getLazyUpdate() -
setLazyUpdate
public void setLazyUpdate(boolean lazyUpdate) -
getLazyFirstRow
public int getLazyFirstRow() -
setLazyFirstRow
public void setLazyFirstRow(int lazyFirstRow) -
createReloadBehavior
-
isRendersRowContainer
public 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 classAbstractUIData
-
isShowHeader
public abstract boolean isShowHeader() -
getExpandedState
- Specified by:
getExpandedStatein classAbstractUIData
-
getSelectedState
- Specified by:
getSelectedStatein classAbstractUIData
-
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. -
isShowPageRangeArrows
Deprecated, for removal: This API element is subject to removal in a future version. -
getShowRowRange
Deprecated, for removal: This API element is subject to removal in a future version. -
getShowPageRange
Deprecated, 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. -
getDirectLinkCount
Deprecated, for removal: This API element is subject to removal in a future version. -
isLazy
public abstract boolean isLazy() -
getMaxSortColumns
-
getLazyRows
-
getPaginator
-
isReadonlyRows
public abstract boolean isReadonlyRows()
-