Class UISheet
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
org.apache.myfaces.tobago.component.UISheet
- 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
Render a sheet element.
 UIComponent class, generated from template 
component.stg with class
 SheetTagDeclaration.- 
Field SummaryFieldsFields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISheetNOT_SORTABLE_COL_MESSAGE_ID, NOT_SORTABLE_MESSAGE_ID, SORTER_IDFields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIDataSUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTEDFields inherited from class javax.faces.component.UIComponentATTRS_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.NamingContainerSEPARATOR_CHAR
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionLayoutConstraints 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:9The 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.javax.el.MethodExpressionjavax.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(javax.faces.context.FacesContext context, Object state) voidsetColumns(String columns) voidsetCustomClass(CustomClass customClass) voidsetDirectLinkCount(Integer directLinkCount) voidsetLazy(boolean lazy) 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(javax.el.MethodExpression sortActionListener) voidsetStateChangeListenerExpression(javax.el.MethodExpression stateChangeListener) Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISheetaddStateChangeListener, broadcast, encodeAll, encodeBegin, getAllColumns, getColumnLayout, getCurrentPage, getExpandedState, getFirstRowIndexOfLastPage, getHeaderGrid, getLastRowIndexOfCurrentPage, getPages, getRenderedChildrenOf, getSelectedState, getSheetState, getState, getStateChangeListeners, hasRowCount, init, isAtBeginning, isAtEnd, isAutoLayout, isPagingVisible, isRendersRowContainer, needMoreThanOnePage, performPaging, processEvent, processUpdates, queueEvent, removeStateChangeListener, saveState, setHeaderGrid, setState, sortMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIDatacreateTreeDataModel, findComponent, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, invokeOnComponent, isFolder, isRowsUnlimited, isRowVisible, isTreeModel, stripRowIndex, visitTreeMethods inherited from class javax.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, setValueBinding, setValueExpression, setVarMethods inherited from class javax.faces.component.UIComponentBaseaddClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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.UIComponentgetClientId, 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javax.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviorsMethods inherited from interface org.apache.myfaces.tobago.component.VisualgetRendererType, isPlain
- 
Field Details- 
COMPONENT_TYPE
- 
COMPONENT_FAMILY- See Also:
 
 
- 
- 
Constructor Details- 
UISheetpublic UISheet()
 
- 
- 
Method Details- 
getEventNames- Specified by:
- getEventNamesin interface- javax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getEventNamesin class- javax.faces.component.UIComponentBase
 
- 
getDefaultEventName- Specified by:
- getDefaultEventNamein interface- javax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getDefaultEventNamein class- javax.faces.component.UIComponentBase
 
- 
getFamily- Overrides:
- getFamilyin class- javax.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- Specified by:
- getShowPageRangein class- 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- Specified by:
- isShowPagingAlwaysin class- 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- Overrides:
- isShowRootJunctionin class- 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. - Specified by:
- getColumnsin class- AbstractUISheet
 
- 
setColumns
- 
isShowHeaderpublic boolean isShowHeader()Flag indicating the header should be rendered.
 Default:true- Specified by:
- isShowHeaderin class- AbstractUISheet
 
- 
setShowHeaderpublic void setShowHeader(boolean showHeader) 
- 
isLazypublic boolean isLazy()Lazy loading by scroll event.
 Default:false- Specified by:
- isLazyin class- AbstractUISheet
 
- 
setLazypublic void setLazy(boolean lazy) 
- 
isShowPageRangeArrowspublic boolean isShowPageRangeArrows()Flag indicating if paging arrows are shown near page range
 Default:true- Specified by:
- isShowPageRangeArrowsin class- AbstractUISheet
 
- 
setShowPageRangeArrowspublic void setShowPageRangeArrows(boolean showPageRangeArrows) 
- 
getSelectableIndicating the selection mode of the sheet.
 Default:multi
 Allowed Values:none,single,singleOrNone,multi- Specified by:
- getSelectablein class- AbstractUIData
 
- 
setSelectable
- 
getSortActionListenerExpressionpublic javax.el.MethodExpression getSortActionListenerExpression()
- 
setSortActionListenerExpressionpublic void setSortActionListenerExpression(javax.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- Specified by:
- getShowDirectLinksin class- AbstractUISheet
 
- 
setShowDirectLinks
- 
isShowDirectLinksArrowspublic boolean isShowDirectLinksArrows()Flag indicating if paging arrows are shown near direct links
 Default:false- Specified by:
- isShowDirectLinksArrowsin class- 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- Specified by:
- isShowRootin class- 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- Specified by:
- getShowRowRangein class- AbstractUISheet
 
- 
setShowRowRange
- 
getMaxSortColumnsThe maximum count of multi-sorted columns to indicate.
 Default:0- Specified by:
- getMaxSortColumnsin class- AbstractUISheet
 
- 
setMaxSortColumns
- 
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 javax.el.MethodExpression getStateChangeListenerExpression()
- 
setStateChangeListenerExpressionpublic void setStateChangeListenerExpression(javax.el.MethodExpression stateChangeListener) 
- 
restoreState- Specified by:
- restoreStatein interface- javax.faces.component.StateHolder
- Overrides:
- restoreStatein class- AbstractUISheet
 
 
-