Klasse 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
- Alle implementierten Schnittstellen:
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
- Bekannte direkte Unterklassen:
UISheet
public abstract class AbstractUISheet
extends AbstractUIData
implements SheetStateChangeSource, SortActionSource, jakarta.faces.component.behavior.ClientBehaviorHolder, Visual, jakarta.faces.event.ComponentSystemEventListener
-
Feldübersicht
FelderModifizierer und TypFeldBeschreibungstatic final StringVeraltet.since 4.4.0.static final Stringstatic final Stringstatic final StringVon Klasse geerbte Felder org.apache.myfaces.tobago.internal.component.AbstractUIData
SUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTEDVon Klasse geerbte Felder jakarta.faces.component.UIData
COMPONENT_FAMILYVon Klasse geerbte Felder jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEYVon Schnittstelle geerbte Felder jakarta.faces.component.NamingContainer
SEPARATOR_CHAR -
Konstruktorübersicht
Konstruktoren -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungvoidvoidbroadcast(jakarta.faces.event.FacesEvent facesEvent) voidencodeAll(jakarta.faces.context.FacesContext facesContext) voidencodeBegin(jakarta.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).intabstract Integerbooleanabstract IntegerintgetPages()The number of pages to render.List<jakarta.faces.component.UIComponent> getRenderedChildrenOf(jakarta.faces.component.UIColumn column) getSheetState(jakarta.faces.context.FacesContext facesContext) abstract ShowPositionabstract ShowPositionabstract ShowPositiongetState()booleanvoidinit(jakarta.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(jakarta.faces.event.ComponentSystemEvent event) voidprocessUpdates(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) Von Klasse geerbte Methoden 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, visitTreeVon Klasse geerbte Methoden 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, setVarVon Klasse geerbte Methoden 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, setTransientVon Klasse geerbte Methoden 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, unsubscribeFromEventVon Klasse geerbte Methoden java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitVon Schnittstelle geerbte Methoden jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNamesVon Schnittstelle geerbte Methoden org.apache.myfaces.tobago.event.SheetStateChangeSource
getStateChangeListenerExpression, setStateChangeListenerExpressionVon Schnittstelle geerbte Methoden org.apache.myfaces.tobago.event.SortActionSource
getSortActionListenerExpression, setSortActionListenerExpressionVon Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.Visual
getCustomClass, getMarkup, getRendererType, isPlain, setCustomClass, setMarkup
-
Felddetails
-
COMPONENT_TYPE
Veraltet.since 4.4.0.- Siehe auch:
-
SORTER_ID
- Siehe auch:
-
NOT_SORTABLE_COL_MESSAGE_ID
- Siehe auch:
-
NOT_SORTABLE_MESSAGE_ID
- Siehe auch:
-
-
Konstruktordetails
-
AbstractUISheet
public AbstractUISheet()
-
-
Methodendetails
-
encodeAll
- Setzt außer Kraft:
encodeAllin Klassejakarta.faces.component.UIComponentBase- Löst aus:
IOException
-
encodeBegin
- Setzt außer Kraft:
encodeBeginin KlasseAbstractUIData- Löst aus:
IOException
-
setState
-
getState
-
getSheetState
-
getColumns
-
processEvent
public void processEvent(jakarta.faces.event.ComponentSystemEvent event) throws jakarta.faces.event.AbortProcessingException - Angegeben von:
processEventin Schnittstellejakarta.faces.event.ComponentSystemEventListener- Setzt außer Kraft:
processEventin Klassejakarta.faces.component.UIComponent- Löst aus:
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).- Löst aus:
IllegalArgumentException- If the number of rows in the model returned byUIData.getRowCount()is -1 (undefined).
-
getCurrentPage
public int getCurrentPage()- Gibt zurück:
- returns the current page (based by 0).
-
getPages
public int getPages()The number of pages to render.- Löst aus:
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()- Gibt zurück:
- Is the interval to display starting with the first row?
-
hasRowCount
public boolean hasRowCount()- Gibt zurück:
- Does the data model knows the number of rows?
-
isPagingVisible
public boolean isPagingVisible()- Gibt zurück:
- 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()- Gibt zurück:
- 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).- Gibt zurück:
- The index of the first row of the last paging page.
- Löst aus:
IllegalArgumentException- If the number of rows in the model returned byUIData.getRowCount()is -1 (undefined).
-
processUpdates
public void processUpdates(jakarta.faces.context.FacesContext context) - Setzt außer Kraft:
processUpdatesin Klassejakarta.faces.component.UIData
-
saveState
- Angegeben von:
saveStatein Schnittstellejakarta.faces.component.StateHolder- Setzt außer Kraft:
saveStatein Klassejakarta.faces.component.UIData
-
restoreState
- Angegeben von:
restoreStatein Schnittstellejakarta.faces.component.StateHolder- Setzt außer Kraft:
restoreStatein Klassejakarta.faces.component.UIData
-
getAllColumns
-
queueEvent
public void queueEvent(jakarta.faces.event.FacesEvent facesEvent) - Setzt außer Kraft:
queueEventin Klassejakarta.faces.component.UIData
-
broadcast
public void broadcast(jakarta.faces.event.FacesEvent facesEvent) throws jakarta.faces.event.AbortProcessingException - Setzt außer Kraft:
broadcastin Klassejakarta.faces.component.UIData- Löst aus:
jakarta.faces.event.AbortProcessingException
-
init
public void init(jakarta.faces.context.FacesContext facesContext) -
sort
-
addStateChangeListener
- Angegeben von:
addStateChangeListenerin SchnittstelleSheetStateChangeSource
-
getStateChangeListeners
- Angegeben von:
getStateChangeListenersin SchnittstelleSheetStateChangeSource
-
removeStateChangeListener
- Angegeben von:
removeStateChangeListenerin SchnittstelleSheetStateChangeSource
-
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()Beschreibung aus Klasse kopiert: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.- Setzt außer Kraft:
isRendersRowContainerin KlasseAbstractUIData
-
isShowHeader
public abstract boolean isShowHeader() -
getExpandedState
- Angegeben von:
getExpandedStatein KlasseAbstractUIData
-
getSelectedState
- Angegeben von:
getSelectedStatein KlasseAbstractUIData
-
getHeaderGrid
-
setHeaderGrid
-
isShowDirectLinksArrows
public abstract boolean isShowDirectLinksArrows() -
isShowPageRangeArrows
public abstract boolean isShowPageRangeArrows() -
getShowRowRange
-
getShowPageRange
-
getShowDirectLinks
-
isLazy
public abstract boolean isLazy() -
getMaxSortColumns
-
getLazyRows
-