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 Summary
FieldsFields 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
Fields inherited from class javax.faces.component.UIComponent
ATTRS_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_KEY
Fields 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.Deprecated.Indicate how many rows are loaded at once when lazy loading is enabled.The maximum count of multi-sorted columns to indicate.Create paginator components automatically or do it manually.Indicating the selection mode of the sheet.Deprecated.Deprecated.Deprecated.javax.el.MethodExpression
javax.el.MethodExpression
boolean
isLazy()
Lazy loading by scroll event.boolean
Flag indicating that the rows of the sheet are readonly.boolean
Deprecated.boolean
Flag indicating the header should be rendered.boolean
Deprecated.boolean
Deprecated.boolean
Only applicable in the case that the data model is a tree.boolean
Only applicable in the case that the data model is a tree.void
restoreState
(javax.faces.context.FacesContext context, Object state) void
setColumns
(String columns) void
setCustomClass
(CustomClass customClass) void
setDirectLinkCount
(Integer directLinkCount) Deprecated.void
setLazy
(boolean lazy) void
setLazyRows
(Integer lazyRows) void
void
setMaxSortColumns
(Integer maxSortColumns) void
setPaginator
(PaginatorMode paginator) void
setReadonlyRows
(boolean readonlyRows) void
setSelectable
(Selectable selectable) void
setShowDirectLinks
(ShowPosition showDirectLinks) Deprecated.void
setShowDirectLinksArrows
(boolean showDirectLinksArrows) Deprecated.void
setShowHeader
(boolean showHeader) void
setShowPageRange
(ShowPosition showPageRange) Deprecated.void
setShowPageRangeArrows
(boolean showPageRangeArrows) Deprecated.void
setShowPagingAlways
(boolean showPagingAlways) Deprecated.void
setShowRoot
(boolean showRoot) void
setShowRootJunction
(boolean showRootJunction) void
setShowRowRange
(ShowPosition showRowRange) Deprecated.void
setSortActionListenerExpression
(javax.el.MethodExpression sortActionListener) void
setStateChangeListenerExpression
(javax.el.MethodExpression stateChangeListener) Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISheet
addStateChangeListener, broadcast, createReloadBehavior, encodeAll, encodeBegin, getAllColumns, getColumnLayout, getCurrentPage, getExpandedState, getFirstRowIndexOfLastPage, getHeaderGrid, getLastRowIndexOfCurrentPage, getLazyFirstRow, getLazyUpdate, getPages, getRenderedChildrenOf, getSelectedState, getSheetState, getState, getStateChangeListeners, hasRowCount, init, isAtBeginning, isAtEnd, isAutoLayout, isLazyUpdate, isPagingVisible, isRendersRowContainer, needMoreThanOnePage, performPaging, processDecodes, processEvent, processUpdates, processValidators, queueEvent, removeStateChangeListener, saveState, setHeaderGrid, setLazyFirstRow, setLazyUpdate, setState, sort, visitTree
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
Methods inherited from class javax.faces.component.UIData
createUniqueId, encodeEnd, getContainerClientId, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, isRowStatePreserved, markInitialState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueBinding, setValueExpression, setVar
Methods 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, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
Methods inherited from class javax.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 javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
Methods 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:
getEventNames
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getEventNames
in classjavax.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventName
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getDefaultEventName
in classjavax.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamily
in classjavax.faces.component.UIData
-
getShowPageRange
Deprecated.Flag indicating whether and where the range pages should be 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:
getShowPageRange
in classAbstractUISheet
-
setShowPageRange
Deprecated. -
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:
getColumns
in classAbstractUISheet
-
setColumns
-
isLazy
public boolean isLazy()Lazy loading by scroll event.
Default:false
- Specified by:
isLazy
in classAbstractUISheet
-
setLazy
public void setLazy(boolean lazy) -
getSelectable
Indicating the selection mode of the sheet.
Default:multi
Allowed Values:none,single,singleOrNone,multi
- Specified by:
getSelectable
in classAbstractUIData
-
setSelectable
-
getShowDirectLinks
Deprecated.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:
getShowDirectLinks
in classAbstractUISheet
-
setShowDirectLinks
Deprecated. -
getLazyRows
Indicate how many rows are loaded at once when lazy loading is enabled. Default is 50.
Default:50
- Specified by:
getLazyRows
in classAbstractUISheet
-
setLazyRows
-
getStateChangeListenerExpression
public javax.el.MethodExpression getStateChangeListenerExpression() -
setStateChangeListenerExpression
public void setStateChangeListenerExpression(javax.el.MethodExpression stateChangeListener) -
getPaginator
Create paginator components automatically or do it manually.-
custom: no paginator is created automatically, you have to do it manually.
This can be done
using a
<tc:paginatorPanel>
with e.g. a<tc:paginatorList>
and/or some other paginator components. - auto: a appropriate paginator is used.
-
list: a
<tc:paginatorList>
is used. -
page: a
<tc:paginatorPage>
is used. -
row: a
<tc:paginatorRow>
is used. -
useShowAttributes (default):
is deprecated, use for compatibility.
The used paginators are defined by the show-attributes:
showDirectLinks
,showPageRange
,showRowRange
,directLinkCount
,showDirectLinksArrows
,showPageRangeArrows
,showPagingAlways
.
Default:useShowAttributes
Allowed Values:auto,custom,list,page,row,useShowAttributes
- Specified by:
getPaginator
in classAbstractUISheet
-
custom: no paginator is created automatically, you have to do it manually.
This can be done
using a
-
setPaginator
-
getMarkup
-
setMarkup
-
isShowPagingAlways
Deprecated.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:
isShowPagingAlways
in classAbstractUISheet
- showPagingAlways="false" which is the default means, that the paging footer should be displayed,
only when it is needed.
-
setShowPagingAlways
Deprecated. -
getDirectLinkCount
Deprecated.The count of rendered direct paging links in the sheet's footer.
Default:9
- Specified by:
getDirectLinkCount
in classAbstractUISheet
-
setDirectLinkCount
Deprecated. -
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:
isShowRootJunction
in classAbstractUIData
-
setShowRootJunction
public void setShowRootJunction(boolean showRootJunction) -
isShowHeader
public boolean isShowHeader()Flag indicating the header should be rendered.
Default:true
- Specified by:
isShowHeader
in classAbstractUISheet
-
setShowHeader
public void setShowHeader(boolean showHeader) -
isShowPageRangeArrows
Deprecated.Flag indicating if paging arrows are shown near page range
Default:true
- Specified by:
isShowPageRangeArrows
in classAbstractUISheet
-
setShowPageRangeArrows
Deprecated. -
getSortActionListenerExpression
public javax.el.MethodExpression getSortActionListenerExpression() -
setSortActionListenerExpression
public void setSortActionListenerExpression(javax.el.MethodExpression sortActionListener) -
isShowDirectLinksArrows
Deprecated.Flag indicating if paging arrows are shown near direct links
Default:false
- Specified by:
isShowDirectLinksArrows
in classAbstractUISheet
-
setShowDirectLinksArrows
Deprecated. -
isReadonlyRows
public boolean isReadonlyRows()Flag indicating that the rows of the sheet are readonly. The readonly attribute is a performance optimization hint used during {
Default:false
- Specified by:
isReadonlyRows
in classAbstractUISheet
-
setReadonlyRows
public void setReadonlyRows(boolean readonlyRows) -
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:
isShowRoot
in classAbstractUIData
-
setShowRoot
public void setShowRoot(boolean showRoot) -
getShowRowRange
Deprecated.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:
getShowRowRange
in classAbstractUISheet
-
setShowRowRange
Deprecated. -
getMaxSortColumns
The maximum count of multi-sorted columns to indicate.
Default:0
- Specified by:
getMaxSortColumns
in classAbstractUISheet
-
setMaxSortColumns
-
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
-
restoreState
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classAbstractUISheet
-