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 String
Deprecated.since 4.4.0.static final String
static final String
static final String
Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData
SUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTED
Fields inherited from class jakarta.faces.component.UIData
COMPONENT_FAMILY
Fields 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_KEY
Fields inherited from interface jakarta.faces.component.NamingContainer
SEPARATOR_CHAR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
broadcast
(jakarta.faces.event.FacesEvent facesEvent) void
encodeAll
(jakarta.faces.context.FacesContext facesContext) void
encodeBegin
(jakarta.faces.context.FacesContext facesContext) abstract String
int
int
Determines the beginning of the last page in the model.int
The rowIndex of the last row on the current page plus one (because of zero based iterating).int
abstract Integer
boolean
abstract Integer
int
getPages()
The number of pages to render.List
<jakarta.faces.component.UIComponent> getRenderedChildrenOf
(jakarta.faces.component.UIColumn column) getSheetState
(jakarta.faces.context.FacesContext facesContext) abstract ShowPosition
abstract ShowPosition
abstract ShowPosition
getState()
boolean
void
init
(jakarta.faces.context.FacesContext facesContext) boolean
boolean
isAtEnd()
boolean
abstract boolean
isLazy()
boolean
boolean
The value describes, if the UIData renderer creates container elements to hold the row information.abstract boolean
abstract boolean
abstract boolean
abstract boolean
boolean
void
performPaging
(PageActionEvent pageEvent) void
processEvent
(jakarta.faces.event.ComponentSystemEvent event) void
processUpdates
(jakarta.faces.context.FacesContext context) void
queueEvent
(jakarta.faces.event.FacesEvent facesEvent) void
void
restoreState
(jakarta.faces.context.FacesContext context, Object savedState) saveState
(jakarta.faces.context.FacesContext context) void
setHeaderGrid
(Grid headerGrid) void
setLazyFirstRow
(int lazyFirstRow) void
setLazyUpdate
(boolean lazyUpdate) void
setState
(SheetState state) protected void
sort
(jakarta.faces.context.FacesContext facesContext, SortActionEvent event) 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, stripRowIndex, visitTree
Methods inherited from class jakarta.faces.component.UIData
createUniqueId, encodeEnd, getContainerClientId, getFamily, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, isRowStatePreserved, markInitialState, processDecodes, processValidators, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueExpression, setVar
Methods 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, setTransient
Methods 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, unsubscribeFromEvent
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
Methods inherited from interface org.apache.myfaces.tobago.event.SheetStateChangeSource
getStateChangeListenerExpression, setStateChangeListenerExpression
Methods inherited from interface org.apache.myfaces.tobago.event.SortActionSource
getSortActionListenerExpression, setSortActionListenerExpression
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getCustomClass, getMarkup, getRendererType, isPlain, setCustomClass, setMarkup
-
Field Details
-
COMPONENT_TYPE
-
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:
encodeAll
in classjakarta.faces.component.UIComponentBase
- Throws:
IOException
-
encodeBegin
- Overrides:
encodeBegin
in classAbstractUIData
- Throws:
IOException
-
setState
-
getState
-
getSheetState
-
getColumns
-
processEvent
public void processEvent(jakarta.faces.event.ComponentSystemEvent event) throws jakarta.faces.event.AbortProcessingException - Specified by:
processEvent
in interfacejakarta.faces.event.ComponentSystemEventListener
- Overrides:
processEvent
in 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).
-
processUpdates
public void processUpdates(jakarta.faces.context.FacesContext context) - Overrides:
processUpdates
in classjakarta.faces.component.UIData
-
saveState
- Specified by:
saveState
in interfacejakarta.faces.component.StateHolder
- Overrides:
saveState
in classjakarta.faces.component.UIData
-
restoreState
- Specified by:
restoreState
in interfacejakarta.faces.component.StateHolder
- Overrides:
restoreState
in classjakarta.faces.component.UIData
-
getAllColumns
-
queueEvent
public void queueEvent(jakarta.faces.event.FacesEvent facesEvent) - Overrides:
queueEvent
in classjakarta.faces.component.UIData
-
broadcast
public void broadcast(jakarta.faces.event.FacesEvent facesEvent) throws jakarta.faces.event.AbortProcessingException - Overrides:
broadcast
in classjakarta.faces.component.UIData
- Throws:
jakarta.faces.event.AbortProcessingException
-
init
public void init(jakarta.faces.context.FacesContext facesContext) -
sort
-
addStateChangeListener
- Specified by:
addStateChangeListener
in interfaceSheetStateChangeSource
-
getStateChangeListeners
- Specified by:
getStateChangeListeners
in interfaceSheetStateChangeSource
-
removeStateChangeListener
- Specified by:
removeStateChangeListener
in interfaceSheetStateChangeSource
-
performPaging
-
getLazyUpdate
public boolean getLazyUpdate() -
setLazyUpdate
public void setLazyUpdate(boolean lazyUpdate) -
getLazyFirstRow
public int getLazyFirstRow() -
setLazyFirstRow
public void setLazyFirstRow(int lazyFirstRow) -
isRendersRowContainer
public boolean isRendersRowContainer()Description copied from class:AbstractUIData
The 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:
isRendersRowContainer
in classAbstractUIData
-
isShowHeader
public abstract boolean isShowHeader() -
getExpandedState
- Specified by:
getExpandedState
in classAbstractUIData
-
getSelectedState
- Specified by:
getSelectedState
in classAbstractUIData
-
getHeaderGrid
-
setHeaderGrid
-
isShowDirectLinksArrows
public abstract boolean isShowDirectLinksArrows() -
isShowPageRangeArrows
public abstract boolean isShowPageRangeArrows() -
getShowRowRange
-
getShowPageRange
-
getShowDirectLinks
-
isLazy
public abstract boolean isLazy() -
getMaxSortColumns
-
getLazyRows
-