Class 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
-
- 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
@Generated("component.stg") public class UISheet extends AbstractUISheetRender a sheet element. UIComponent class, generated from templatecomponent.stgwith classSheetTagDeclaration.
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE-
Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISheet
NOT_SORTABLE_COL_MESSAGE_ID, NOT_SORTABLE_MESSAGE_ID, SORTER_ID
-
Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData
SUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTED
-
-
Constructor Summary
Constructors Constructor Description UISheet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetColumns()LayoutConstraints for column layout.CustomClassgetCustomClass()Sets a CSS class in its parent, if the parent supports it.StringgetDefaultEventName()IntegergetDirectLinkCount()The count of rendered direct paging links in the sheet's footer.
Default:9Collection<String>getEventNames()StringgetFamily()IntegergetLazyRows()Indicate how many rows are loaded at once when lazy loading is enabled.MarkupgetMarkup()IntegergetMaxSortColumns()The maximum count of multi-sorted columns to indicate.SelectablegetSelectable()Indicating the selection mode of the sheet.ShowPositiongetShowDirectLinks()Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.ShowPositiongetShowPageRange()Flag indicating whether and where the range pages should rendered in the sheet's footer.ShowPositiongetShowRowRange()Flag indicating whether or not the range of displayed rows should rendered in the sheet's footer.jakarta.el.MethodExpressiongetSortActionListenerExpression()jakarta.el.MethodExpressiongetStateChangeListenerExpression()booleanisLazy()Lazy loading by scroll event.booleanisShowDirectLinksArrows()Flag indicating if paging arrows are shown near direct links
Default:falsebooleanisShowHeader()Flag indicating the header should be rendered.booleanisShowPageRangeArrows()Flag indicating if paging arrows are shown near page range
Default:truebooleanisShowPagingAlways()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.booleanisShowRoot()Only applicable in the case that the data model is a tree.booleanisShowRootJunction()Only 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)voidsetMarkup(Markup markup)voidsetMaxSortColumns(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)-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISheet
addStateChangeListener, 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, sort
-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData
createTreeDataModel, findComponent, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, invokeOnComponent, isFolder, isRowsUnlimited, isRowVisible, isTreeModel, stripRowIndex, visitTree
-
Methods inherited from class jakarta.faces.component.UIData
createUniqueId, 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, setVar
-
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, 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, 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
-
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getEventNames
public Collection<String> getEventNames()
- Specified by:
getEventNamesin interfacejakarta.faces.component.behavior.ClientBehaviorHolder- Overrides:
getEventNamesin classjakarta.faces.component.UIComponentBase
-
getDefaultEventName
public String getDefaultEventName()
- Specified by:
getDefaultEventNamein interfacejakarta.faces.component.behavior.ClientBehaviorHolder- Overrides:
getDefaultEventNamein classjakarta.faces.component.UIComponentBase
-
getFamily
public String getFamily()
- Overrides:
getFamilyin classjakarta.faces.component.UIData
-
getMarkup
public Markup getMarkup()
-
setMarkup
public void setMarkup(Markup markup)
-
getShowPageRange
public ShowPosition getShowPageRange()
Flag 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 classAbstractUISheet
-
setShowPageRange
public void setShowPageRange(ShowPosition showPageRange)
-
isShowPagingAlways
public 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 classAbstractUISheet
- showPagingAlways="false" which is the default means, that the paging footer should be displayed,
only when it is needed.
-
setShowPagingAlways
public void setShowPagingAlways(boolean showPagingAlways)
-
getDirectLinkCount
public Integer getDirectLinkCount()
The count of rendered direct paging links in the sheet's footer.
Default:9
-
setDirectLinkCount
public void setDirectLinkCount(Integer directLinkCount)
-
isShowRootJunction
public 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 classAbstractUIData
-
setShowRootJunction
public void setShowRootJunction(boolean showRootJunction)
-
getColumns
public String getColumns()
LayoutConstraints 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 classAbstractUISheet
-
setColumns
public void setColumns(String columns)
-
isShowHeader
public boolean isShowHeader()
Flag indicating the header should be rendered.
Default:true- Specified by:
isShowHeaderin classAbstractUISheet
-
setShowHeader
public void setShowHeader(boolean showHeader)
-
isLazy
public boolean isLazy()
Lazy loading by scroll event.
Default:false- Specified by:
isLazyin classAbstractUISheet
-
setLazy
public void setLazy(boolean lazy)
-
isShowPageRangeArrows
public boolean isShowPageRangeArrows()
Flag indicating if paging arrows are shown near page range
Default:true- Specified by:
isShowPageRangeArrowsin classAbstractUISheet
-
setShowPageRangeArrows
public void setShowPageRangeArrows(boolean showPageRangeArrows)
-
getSelectable
public Selectable getSelectable()
Indicating the selection mode of the sheet.
Default:multi
Allowed Values:none,single,singleOrNone,multi- Specified by:
getSelectablein classAbstractUIData
-
setSelectable
public void setSelectable(Selectable selectable)
-
getSortActionListenerExpression
public jakarta.el.MethodExpression getSortActionListenerExpression()
-
setSortActionListenerExpression
public void setSortActionListenerExpression(jakarta.el.MethodExpression sortActionListener)
-
getShowDirectLinks
public ShowPosition getShowDirectLinks()
Flag 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 classAbstractUISheet
-
setShowDirectLinks
public void setShowDirectLinks(ShowPosition showDirectLinks)
-
isShowDirectLinksArrows
public boolean isShowDirectLinksArrows()
Flag indicating if paging arrows are shown near direct links
Default:false- Specified by:
isShowDirectLinksArrowsin classAbstractUISheet
-
setShowDirectLinksArrows
public void setShowDirectLinksArrows(boolean showDirectLinksArrows)
-
isShowRoot
public 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 classAbstractUIData
-
setShowRoot
public void setShowRoot(boolean showRoot)
-
getShowRowRange
public ShowPosition getShowRowRange()
Flag 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 classAbstractUISheet
-
setShowRowRange
public void setShowRowRange(ShowPosition showRowRange)
-
getMaxSortColumns
public Integer getMaxSortColumns()
The maximum count of multi-sorted columns to indicate.
Default:0- Specified by:
getMaxSortColumnsin classAbstractUISheet
-
setMaxSortColumns
public void setMaxSortColumns(Integer maxSortColumns)
-
getLazyRows
public Integer getLazyRows()
Indicate how many rows are loaded at once when lazy loading is enabled. Default is 50.
Default:50- Specified by:
getLazyRowsin classAbstractUISheet
-
setLazyRows
public void setLazyRows(Integer lazyRows)
-
getCustomClass
public CustomClass getCustomClass()
Sets 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
public void setCustomClass(CustomClass customClass)
-
getStateChangeListenerExpression
public jakarta.el.MethodExpression getStateChangeListenerExpression()
-
setStateChangeListenerExpression
public void setStateChangeListenerExpression(jakarta.el.MethodExpression stateChangeListener)
-
restoreState
public void restoreState(jakarta.faces.context.FacesContext context, Object state)- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classAbstractUISheet
-
-