Module org.apache.myfaces.tobago
Interface SheetTagDeclaration
- All Superinterfaces:
HasBinding,HasId,HasIdBindingAndRendered,HasVar,IsRendered,IsShowRoot,IsShowRootJunction,IsVisual
public interface SheetTagDeclaration
extends HasIdBindingAndRendered, IsVisual, IsShowRoot, IsShowRootJunction, HasVar
Render a sheet element.
-
Method Summary
Modifier and TypeMethodDescriptionvoidsetColumns(String columns) LayoutConstraints for column layout.voidsetDirectLinkCount(String directLinkCount) Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.voidZero-relative row number of the first row to be displayed.voidLazy loading by scroll event.voidsetLazyRows(String lazyRows) Indicate how many rows are loaded at once when lazy loading is enabled.voidsetMaxSortColumns(String maxSortColumns) The maximum count of multi-sorted columns to indicate.voidsetPaginator(String paginator) Create paginator components automatically or do it manually.voidsetReadonlyRows(String readonly) Flag indicating that the rows of the sheet are readonly.voidThe number of rows to display, starting with the one identified by the "first" property.voidsetSelectable(String selectable) Indicating the selection mode of the sheet.voidsetShowDirectLinks(String showDirectLinks) Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.voidsetShowDirectLinksArrows(String showDirectLinksArrows) Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.voidsetShowHeader(String showHeader) Flag indicating the header should be rendered.voidsetShowPageRange(String showPageRange) Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.voidsetShowPageRangeArrows(String showPageRangeArrows) Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.voidsetShowPagingAlways(String showPagingAlways) Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.voidsetShowRowRange(String showRowRange) Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.voidsetSortActionListener(String sortActionListener) Method binding representing an actionListener method that will be invoked when sorting was requested by the user.voidSheet state saving object.voidsetStateChangeListener(String stateChangeListener) Method binding representing a stateChangeListener method that will be notified when the state was changed by the user.voidThe sheet's data.Methods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.HasBinding
setBindingMethods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.HasVar
setVarMethods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.IsRendered
setRenderedMethods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.IsShowRoot
setShowRootMethods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.IsShowRootJunction
setShowRootJunctionMethods inherited from interface org.apache.myfaces.tobago.internal.taglib.declaration.IsVisual
setCustomClass, setMarkup
-
Method Details
-
setColumns
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.
-
setShowHeader
Flag indicating the header should be rendered. -
setRows
The number of rows to display, starting with the one identified by the "first" property.
The default has been changed from 100 to 0 because this is the default in the JSF standard (since Tobago 1.5). -
setFirst
Zero-relative row number of the first row to be displayed. -
setValue
The sheet's data. -
setShowPagingAlways
@Deprecated(since="5.15.0, 6.7.0", forRemoval=true) void setShowPagingAlways(String showPagingAlways) Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.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.
- showPagingAlways="false" which is the default means, that the paging footer should be displayed,
only when it is needed.
-
setDirectLinkCount
Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.The count of rendered direct paging links in the sheet's footer. -
setShowDirectLinks
Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer. -
setShowPageRange
Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.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. -
setShowRowRange
Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.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. -
setSelectable
Indicating the selection mode of the sheet. -
setState
Sheet state saving object. -
setStateChangeListener
Method binding representing a stateChangeListener method that will be notified when the state was changed by the user. The expression must evaluate to a public method that takes a SheetStateChangeEvent parameter, with a return type of void. -
setSortActionListener
Method binding representing an actionListener method that will be invoked when sorting was requested by the user. Use this if your application needs special handling for sorting columns. If this is not set and the sortable attribute column is set to true the sheet implementation will use a default sort method. The expression must evaluate to a public method which takes an ActionEvent as parameter and with a return type of void. The method will receive aSortActionEvent. The method should sort according to the sortColumnId and direction getting from the sheet'sSheetStateobject. -
setLazy
Lazy loading by scroll event. -
setLazyRows
Indicate how many rows are loaded at once when lazy loading is enabled. Default is 50. -
setShowDirectLinksArrows
@Deprecated(since="5.15.0, 6.7.0", forRemoval=true) void setShowDirectLinksArrows(String showDirectLinksArrows) Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.Flag indicating if paging arrows are shown near direct links- Since:
- 2.0.0
-
setShowPageRangeArrows
@Deprecated(since="5.15.0, 6.7.0", forRemoval=true) void setShowPageRangeArrows(String showPageRangeArrows) Deprecated, for removal: This API element is subject to removal in a future version.Use paginator attribute or paginator tags instead.Flag indicating if paging arrows are shown near page range- Since:
- 2.0.0
-
setMaxSortColumns
The maximum count of multi-sorted columns to indicate.- Since:
- 5.3.0
-
setPaginator
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.
- Since:
- 5.15.0, 6.7.0
-
custom: no paginator is created automatically, you have to do it manually.
This can be done
using a
-
setReadonlyRows
Flag indicating that the rows of the sheet are readonly. The readonly attribute is a performance optimization hint used duringPhaseId.APPLY_REQUEST_VALUESandPhaseId.PROCESS_VALIDATIONSandPhaseId.UPDATE_MODEL_VALUES. When set to true, it signals the rows of the sheet are read-only und doesn't require updates potentially saving processing time. This optimization should only be applied when there are no non-readonlyEditableValueHoldercomponents in the sheet rows.
-