Klasse UISheet
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
org.apache.myfaces.tobago.component.UISheet
- 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
Render a sheet element.
 UIComponent class, generated from template 
component.stg with class
 SheetTagDeclaration.- 
FeldübersichtFelderVon Klasse geerbte Felder org.apache.myfaces.tobago.internal.component.AbstractUISheetNOT_SORTABLE_COL_MESSAGE_ID, NOT_SORTABLE_MESSAGE_ID, SORTER_IDVon Klasse geerbte Felder org.apache.myfaces.tobago.internal.component.AbstractUIDataSUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTEDVon Klasse geerbte Felder jakarta.faces.component.UIComponentATTRS_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.NamingContainerSEPARATOR_CHAR
- 
KonstruktorübersichtKonstruktoren
- 
MethodenübersichtModifizierer und TypMethodeBeschreibungLayoutConstraints for column layout.Sets a CSS class in its parent, if the parent supports it.The count of rendered direct paging links in the sheet's footer.
 
 Default:9Indicate how many rows are loaded at once when lazy loading is enabled.The maximum count of multi-sorted columns to indicate.Indicating the selection mode of the sheet.Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.Flag indicating whether and where the range pages should rendered in the sheet's footer.Flag indicating whether or not the range of displayed rows should rendered in the sheet's footer.jakarta.el.MethodExpressionjakarta.el.MethodExpressionbooleanisLazy()Lazy loading by scroll event.booleanFlag indicating if paging arrows are shown near direct links
 Default:falsebooleanFlag indicating the header should be rendered.booleanFlag indicating if paging arrows are shown near page range
 Default:truebooleanFlag indicating whether or not the paging panel should be display, if it is not needed for paging.
 showPagingAlways="false" which is the default means, that the paging footer should be displayed, only when it is needed.booleanOnly applicable in the case that the data model is a tree.booleanOnly applicable in the case that the data model is a tree.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetColumns(String columns) voidsetCustomClass(CustomClass customClass) voidsetDirectLinkCount(Integer directLinkCount) voidsetLazy(boolean lazy) voidsetLazyRows(Integer lazyRows) voidvoidsetMaxSortColumns(Integer maxSortColumns) voidsetSelectable(Selectable selectable) voidsetShowDirectLinks(ShowPosition showDirectLinks) voidsetShowDirectLinksArrows(boolean showDirectLinksArrows) voidsetShowHeader(boolean showHeader) voidsetShowPageRange(ShowPosition showPageRange) voidsetShowPageRangeArrows(boolean showPageRangeArrows) voidsetShowPagingAlways(boolean showPagingAlways) voidsetShowRoot(boolean showRoot) voidsetShowRootJunction(boolean showRootJunction) voidsetShowRowRange(ShowPosition showRowRange) voidsetSortActionListenerExpression(jakarta.el.MethodExpression sortActionListener) voidsetStateChangeListenerExpression(jakarta.el.MethodExpression stateChangeListener) Von Klasse geerbte Methoden org.apache.myfaces.tobago.internal.component.AbstractUISheetaddStateChangeListener, broadcast, encodeAll, encodeBegin, getAllColumns, getColumnLayout, getCurrentPage, getExpandedState, getFirstRowIndexOfLastPage, getHeaderGrid, getLastRowIndexOfCurrentPage, getLazyFirstRow, getLazyUpdate, getPages, getRenderedChildrenOf, getSelectedState, getSheetState, getState, getStateChangeListeners, hasRowCount, init, isAtBeginning, isAtEnd, isAutoLayout, isPagingVisible, isRendersRowContainer, needMoreThanOnePage, performPaging, processEvent, processUpdates, queueEvent, removeStateChangeListener, saveState, setHeaderGrid, setLazyFirstRow, setLazyUpdate, setState, sortVon Klasse geerbte Methoden org.apache.myfaces.tobago.internal.component.AbstractUIDatacreateTreeDataModel, findComponent, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, invokeOnComponent, isFolder, isRowsUnlimited, isRowVisible, isTreeModel, stripRowIndex, visitTreeVon Klasse geerbte Methoden jakarta.faces.component.UIDatacreateUniqueId, encodeEnd, getContainerClientId, 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.UIComponentBaseaddClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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.UIComponentgetClientId, 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitVon Schnittstelle geerbte Methoden jakarta.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviorsVon Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.VisualgetRendererType, isPlain
- 
Felddetails- 
COMPONENT_TYPE
- 
COMPONENT_FAMILY- Siehe auch:
 
 
- 
- 
Konstruktordetails- 
UISheetpublic UISheet()
 
- 
- 
Methodendetails- 
getEventNames- Angegeben von:
- getEventNamesin Schnittstelle- jakarta.faces.component.behavior.ClientBehaviorHolder
- Setzt außer Kraft:
- getEventNamesin Klasse- jakarta.faces.component.UIComponentBase
 
- 
getDefaultEventName- Angegeben von:
- getDefaultEventNamein Schnittstelle- jakarta.faces.component.behavior.ClientBehaviorHolder
- Setzt außer Kraft:
- getDefaultEventNamein Klasse- jakarta.faces.component.UIComponentBase
 
- 
getFamily- Setzt außer Kraft:
- getFamilyin Klasse- jakarta.faces.component.UIData
 
- 
getMarkup
- 
setMarkup
- 
getShowPageRangeFlag indicating whether and where the range pages should rendered in the sheet's footer. Rendering this range also offers the capability to enter the index displayed page directly.
 Default:right
 Allowed Values:left,center,right,none- Angegeben von:
- getShowPageRangein Klasse- AbstractUISheet
 
- 
setShowPageRange
- 
isShowPagingAlwayspublic boolean isShowPagingAlways()Flag indicating whether or not the paging panel should be display, if it is not needed for paging.
 - showPagingAlways="false" which is the default means, that the paging footer should be displayed,
   only when it is needed.
   - When the rows="0" paging is not needed, so the footer will not be rendered,
- when rows="N", N > 0 and the size of the data value is <= N paging is not needed and the footer will not be rendered,
- in any other case the paging footer will be displayed.
 
- showPagingAlways="true" means, that the paging footer should be displayed in any case.
 
 Default:false- Angegeben von:
- isShowPagingAlwaysin Klasse- AbstractUISheet
 
- showPagingAlways="false" which is the default means, that the paging footer should be displayed,
   only when it is needed.
   
- 
setShowPagingAlwayspublic void setShowPagingAlways(boolean showPagingAlways) 
- 
getDirectLinkCountThe count of rendered direct paging links in the sheet's footer.
 
 Default:9
- 
setDirectLinkCount
- 
isShowRootJunctionpublic boolean isShowRootJunction()Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed with an open-close-switch.
 Default:false- Setzt außer Kraft:
- isShowRootJunctionin Klasse- AbstractUIData
 
- 
setShowRootJunctionpublic void setShowRootJunction(boolean showRootJunction) 
- 
getColumnsLayoutConstraints for column layout. Contains a space separated list of layout tokens '<n>fr', '<x>px', '<x>%' or 'auto', where x is a number and n is an integer. - Angegeben von:
- getColumnsin Klasse- AbstractUISheet
 
- 
setColumns
- 
isShowHeaderpublic boolean isShowHeader()Flag indicating the header should be rendered.
 Default:true- Angegeben von:
- isShowHeaderin Klasse- AbstractUISheet
 
- 
setShowHeaderpublic void setShowHeader(boolean showHeader) 
- 
isLazypublic boolean isLazy()Lazy loading by scroll event.
 Default:false- Angegeben von:
- isLazyin Klasse- AbstractUISheet
 
- 
setLazypublic void setLazy(boolean lazy) 
- 
isShowPageRangeArrowspublic boolean isShowPageRangeArrows()Flag indicating if paging arrows are shown near page range
 Default:true- Angegeben von:
- isShowPageRangeArrowsin Klasse- AbstractUISheet
 
- 
setShowPageRangeArrowspublic void setShowPageRangeArrows(boolean showPageRangeArrows) 
- 
getSelectableIndicating the selection mode of the sheet.
 Default:multi
 Allowed Values:none,single,singleOrNone,multi- Angegeben von:
- getSelectablein Klasse- AbstractUIData
 
- 
setSelectable
- 
getSortActionListenerExpressionpublic jakarta.el.MethodExpression getSortActionListenerExpression()
- 
setSortActionListenerExpressionpublic void setSortActionListenerExpression(jakarta.el.MethodExpression sortActionListener) 
- 
getShowDirectLinksFlag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.
 Default:center
 Allowed Values:left,center,right,none- Angegeben von:
- getShowDirectLinksin Klasse- AbstractUISheet
 
- 
setShowDirectLinks
- 
isShowDirectLinksArrowspublic boolean isShowDirectLinksArrows()Flag indicating if paging arrows are shown near direct links
 Default:false- Angegeben von:
- isShowDirectLinksArrowsin Klasse- AbstractUISheet
 
- 
setShowDirectLinksArrowspublic void setShowDirectLinksArrows(boolean showDirectLinksArrows) 
- 
isShowRootpublic boolean isShowRoot()Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed. Often in tree structures the root node is special and should not be displayed.
 Default:false- Angegeben von:
- isShowRootin Klasse- AbstractUIData
 
- 
setShowRootpublic void setShowRoot(boolean showRoot) 
- 
getShowRowRangeFlag indicating whether or not the range of displayed rows should rendered in the sheet's footer. Rendering this range also offers the capability to enter the index of the start row directly.
 Default:left
 Allowed Values:left,center,right,none- Angegeben von:
- getShowRowRangein Klasse- AbstractUISheet
 
- 
setShowRowRange
- 
getMaxSortColumnsThe maximum count of multi-sorted columns to indicate.
 Default:0- Angegeben von:
- getMaxSortColumnsin Klasse- AbstractUISheet
 
- 
setMaxSortColumns
- 
getLazyRowsIndicate how many rows are loaded at once when lazy loading is enabled. Default is 50.
 Default:50- Angegeben von:
- getLazyRowsin Klasse- AbstractUISheet
 
- 
setLazyRows
- 
getCustomClassSets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>One capability is, to used external CSS libs.
 This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.
- 
setCustomClass
- 
getStateChangeListenerExpressionpublic jakarta.el.MethodExpression getStateChangeListenerExpression()
- 
setStateChangeListenerExpressionpublic void setStateChangeListenerExpression(jakarta.el.MethodExpression stateChangeListener) 
- 
restoreState- Angegeben von:
- restoreStatein Schnittstelle- jakarta.faces.component.StateHolder
- Setzt außer Kraft:
- restoreStatein Klasse- AbstractUISheet
 
 
-