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.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 Summary
FieldsFields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISheet
NOT_SORTABLE_MESSAGE_ID, SORTER_IDFields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData
SUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTEDFields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEYFields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR -
Constructor Summary
Constructors -
Method Summary
Modifier 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:9Indicating 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()Preliminary feature: lazy loading by scrolling.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) voidvoidsetSelectable(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.AbstractUISheet
addStateChangeListener, broadcast, encodeAll, encodeBegin, findComponent, getAllColumns, getColumnLayout, getCurrentPage, getExpandedState, getFirstRowIndexOfLastPage, getHeaderGrid, getLast, getLastRowIndexOfCurrentPage, getPage, getPages, getRenderedChildrenOf, getSelectedState, getSheetState, getState, getStateChangeListeners, hasRowCount, init, isAtBeginning, isAtEnd, isAutoLayout, isPagingVisible, isRendersRowContainer, needMoreThanOnePage, performPaging, processEvent, processUpdates, queueEvent, removeStateChangeListener, saveState, setHeaderGrid, setState, sort, stripRowIndexMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData
createTreeDataModel, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, invokeOnComponent, isFolder, isRowsUnlimited, isRowVisible, isTreeModel, visitTreeMethods inherited from class javax.faces.component.UIData
createUniqueId, encodeEnd, getContainerClientId, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, processDecodes, processValidators, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setValue, setValueExpression, setVarMethods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBindingMethods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, 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, getClientBehaviorsMethods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UISheet
public UISheet()
-
-
Method Details
-
getEventNames
- Specified by:
getEventNamesin interfacejavax.faces.component.behavior.ClientBehaviorHolder- Overrides:
getEventNamesin classjavax.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventNamein interfacejavax.faces.component.behavior.ClientBehaviorHolder- Overrides:
getDefaultEventNamein classjavax.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamilyin classjavax.faces.component.UIData
-
getMarkup
-
setMarkup
-
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
-
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
The count of rendered direct paging links in the sheet's footer.
Default:9 -
setDirectLinkCount
-
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
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.
The layout token '<n>*' is deprecated, please use '<n>fr'!
Semicolons as separators are deprecated, please use spaces.
- Specified by:
getColumnsin classAbstractUISheet
-
setColumns
-
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()Preliminary feature: lazy loading by scrolling.
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
Indicating the selection mode of the sheet.
Default:multi
Allowed Values:none,single,singleOrNone,multi- Specified by:
getSelectablein classAbstractUIData
-
setSelectable
-
getSortActionListenerExpression
public javax.el.MethodExpression getSortActionListenerExpression() -
setSortActionListenerExpression
public void setSortActionListenerExpression(javax.el.MethodExpression sortActionListener) -
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
-
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
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
-
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
-
getStateChangeListenerExpression
public javax.el.MethodExpression getStateChangeListenerExpression() -
setStateChangeListenerExpression
public void setStateChangeListenerExpression(javax.el.MethodExpression stateChangeListener) -
restoreState
- Specified by:
restoreStatein interfacejavax.faces.component.StateHolder- Overrides:
restoreStatein classAbstractUISheet
-