Class AbstractUISheet
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIData
org.apache.myfaces.tobago.internal.component.AbstractUIData
org.apache.myfaces.tobago.internal.component.AbstractUISheet
- All Implemented Interfaces:
EventListener,javax.faces.component.behavior.ClientBehaviorHolder,javax.faces.component.NamingContainer,javax.faces.component.PartialStateHolder,javax.faces.component.StateHolder,javax.faces.component.TransientStateHolder,javax.faces.component.UniqueIdVendor,javax.faces.event.ComponentSystemEventListener,javax.faces.event.FacesListener,javax.faces.event.SystemEventListenerHolder,Visual,SheetStateChangeSource,SortActionSource
- Direct Known Subclasses:
UISheet
public abstract class AbstractUISheet
extends AbstractUIData
implements SheetStateChangeSource, SortActionSource, javax.faces.component.behavior.ClientBehaviorHolder, Visual, javax.faces.event.ComponentSystemEventListener
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.since 4.4.0.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 javax.faces.component.UIData
COMPONENT_FAMILYFields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEYFields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidbroadcast(javax.faces.event.FacesEvent facesEvent) voidencodeAll(javax.faces.context.FacesContext facesContext) voidencodeBegin(javax.faces.context.FacesContext facesContext) abstract StringintintDetermines 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).abstract IntegerintgetPages()The number of pages to render.List<javax.faces.component.UIComponent>getRenderedChildrenOf(javax.faces.component.UIColumn column) getSheetState(javax.faces.context.FacesContext facesContext) abstract ShowPositionabstract ShowPositionabstract ShowPositiongetState()booleanvoidinit(javax.faces.context.FacesContext facesContext) booleanbooleanisAtEnd()booleanabstract booleanisLazy()booleanbooleanThe value describes, if the UIData renderer creates container elements to hold the row information.abstract booleanabstract booleanabstract booleanabstract booleanbooleanvoidperformPaging(PageActionEvent pageEvent) voidprocessEvent(javax.faces.event.ComponentSystemEvent event) voidprocessUpdates(javax.faces.context.FacesContext context) voidqueueEvent(javax.faces.event.FacesEvent facesEvent) voidvoidrestoreState(javax.faces.context.FacesContext context, Object savedState) saveState(javax.faces.context.FacesContext context) voidsetHeaderGrid(Grid headerGrid) voidsetState(SheetState state) protected voidsort(javax.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, visitTreeMethods inherited from class javax.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, setValueBinding, setValueExpression, setVarMethods inherited from class javax.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, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransientMethods inherited from class javax.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 javax.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.since 4.4.0.- 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 classjavax.faces.component.UIComponentBase- Throws:
IOException
-
encodeBegin
- Overrides:
encodeBeginin classAbstractUIData- Throws:
IOException
-
setState
-
getState
-
getSheetState
-
getColumns
-
processEvent
public void processEvent(javax.faces.event.ComponentSystemEvent event) throws javax.faces.event.AbortProcessingException - Specified by:
processEventin interfacejavax.faces.event.ComponentSystemEventListener- Overrides:
processEventin classjavax.faces.component.UIComponent- Throws:
javax.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<javax.faces.component.UIComponent> getRenderedChildrenOf(javax.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(javax.faces.context.FacesContext context) - Overrides:
processUpdatesin classjavax.faces.component.UIData
-
saveState
- Specified by:
saveStatein interfacejavax.faces.component.StateHolder- Overrides:
saveStatein classjavax.faces.component.UIData
-
restoreState
- Specified by:
restoreStatein interfacejavax.faces.component.StateHolder- Overrides:
restoreStatein classjavax.faces.component.UIData
-
getAllColumns
-
queueEvent
public void queueEvent(javax.faces.event.FacesEvent facesEvent) - Overrides:
queueEventin classjavax.faces.component.UIData
-
broadcast
public void broadcast(javax.faces.event.FacesEvent facesEvent) throws javax.faces.event.AbortProcessingException - Overrides:
broadcastin classjavax.faces.component.UIData- Throws:
javax.faces.event.AbortProcessingException
-
init
public void init(javax.faces.context.FacesContext facesContext) -
sort
-
addStateChangeListener
- Specified by:
addStateChangeListenerin interfaceSheetStateChangeSource
-
getStateChangeListeners
- Specified by:
getStateChangeListenersin interfaceSheetStateChangeSource
-
removeStateChangeListener
- Specified by:
removeStateChangeListenerin interfaceSheetStateChangeSource
-
performPaging
-
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
public abstract boolean isShowDirectLinksArrows() -
isShowPageRangeArrows
public abstract boolean isShowPageRangeArrows() -
getShowRowRange
-
getShowPageRange
-
getShowDirectLinks
-
isLazy
public abstract boolean isLazy() -
getMaxSortColumns
-