Tomahawk tag library.
Tag dataScroller


Scroller for UIData components eg. dataTable Must be nested inside footer facet of dataTable OR for attribute must be given so that corresponding uiData can be found. Unless otherwise specified, all attributes accept static values or EL expressions. A component which works together with a UIData component to allow a user to view a large list of data one "page" at a time, and navigate between pages.


Tag Information
Tag Classorg.apache.myfaces.custom.datascroller.HtmlDataScrollerTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
layoutfalsefalsejava.lang.StringThe layout this scroller should render with. Default is 'table', 'list' is implemented as well. Additionally you can use 'singleList' - then the data-scroller will render a list, but not the paginator - same with the value 'singleTable'.
colspanfalsefalsejava.lang.Stringstandard html colspan attribute for table cell
onclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is clicked.
ondblclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is double-clicked.
actionListenerfalsefalsejava.lang.StringMethodBinding pointing at method acception an ActionEvent with return type void.
forfalsefalsejava.lang.StringThe JSF id of a UIData component that this scroller will affect. If this attribute is not present then the datascroller must be a child of a UIData component.
fastStepfalsefalsejava.lang.Stringstep (pages) used for fastforward and fastrewind
pageIndexVarfalsefalsejava.lang.StringA parameter name, under which the actual page index is set in request scope similar to the var parameter.
pageCountVarfalsefalsejava.lang.StringA parameter name, under which the actual page count is set in request scope similar to the var parameter.
rowsCountVarfalsefalsejava.lang.StringA parameter name, under which the actual rows count is set in request scope similar to the var parameter.
displayedRowsCountVarfalsefalsejava.lang.StringA parameter name, under which the actual displayed rows count is set in request scope similar to the var parameter.
firstRowIndexVarfalsefalsejava.lang.StringA parameter name, under which the actual first displayed row index is set in request scope similar to the var parameter.
lastRowIndexVarfalsefalsejava.lang.StringA parameter name, under which the actual last displayed row index is set in request scope similar to the var parameter.
paginatorfalsefalsejava.lang.StringIf set true, then the paginator gets rendered
paginatorMaxPagesfalsefalsejava.lang.StringThe maximum amount of pages to be displayed in the paginator.
paginatorTableClassfalsefalsejava.lang.Stringstyleclass for pagingator
paginatorTableStylefalsefalsejava.lang.Stringstyle for pagingator
paginatorColumnClassfalsefalsejava.lang.StringstyleClass for paginator's column
paginatorColumnStylefalsefalsejava.lang.Stringstyle for paginator's column
paginatorActiveColumnClassfalsefalsejava.lang.StringstyleClass for paginator's column with pageIndex = currentPageIndex
paginatorRenderLinkForActivefalsefalsejava.lang.String'true' - render a link for the paginator's column with pageIndex = currentPageIndex. Default-value is 'true'.
firstStyleClassfalsefalsejava.lang.Stringstyle-class for data-scroller first-element
lastStyleClassfalsefalsejava.lang.Stringstyle-class for data-scroller last-element
previousStyleClassfalsefalsejava.lang.Stringstyle-class for data-scroller previous-element
nextStyleClassfalsefalsejava.lang.Stringstyle-class for dataScroller next-element
fastfStyleClassfalsefalsejava.lang.Stringstyle-class for data-scroller fast-forward-element
fastrStyleClassfalsefalsejava.lang.Stringstyle-class for data-scroller fast-rewind-element
paginatorActiveColumnStylefalsefalsejava.lang.Stringstyle for paginator's column with pageIndex = currentPageIndex
renderFacetsIfSinglePagefalsefalsejava.lang.StringIf set to false, the facets aren't renderd if all the lines are contained on a single page. Default is true.
immediatefalsefalsejava.lang.StringTrue means that the default ActionListener should be executed immediately (i.e. during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase.
disableFacetLinksIfFirstPagefalsefalsejava.lang.StringIf the dataScroller is on the first page (index is at 1), links for first, prev and fastprev are disabled. Default is false.
disableFacetLinksIfLastPagefalsefalsejava.lang.StringIf the dataScroller is on the last page (index is at pagecount), links for last, next and fastnext are disabled. Default is false.
renderFacetLinksIfFirstPagefalsefalsejava.lang.StringIf the dataScroller is on the first page (index is at 1), links for first, prev and fastprev are rendered. Default is true.
renderFacetLinksIfLastPagefalsefalsejava.lang.StringIf the dataScroller is on the last page (index is at pagecount), links for last, next and fastnext are rendered. Default is true.
displayValueOnlyfalsefalsejava.lang.StringIf true, renders only the value of the component, but no input widget. Default is false.
displayValueOnlyStylefalsefalsejava.lang.StringStyle used when displayValueOnly is true.
displayValueOnlyStyleClassfalsefalsejava.lang.StringStyle class used when displayValueOnly is true.
enabledOnUserRolefalsefalsejava.lang.StringIf user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
visibleOnUserRolefalsefalsejava.lang.StringIf user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.
forceIdfalsefalsejava.lang.StringIf true, this component will force the use of the specified id when rendering.
forceIdIndexfalsefalsejava.lang.StringIf false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
dirfalsefalsejava.lang.StringHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
langfalsefalsejava.lang.StringHTML: The base language of this document.
titlefalsefalsejava.lang.StringHTML: An advisory title for this element. Often used by the user agent as a tooltip.
stylefalsefalsejava.lang.StringHTML: CSS styling instructions.
styleClassfalsefalsejava.lang.StringThe CSS class for this element. Corresponds to the HTML 'class' attribute.
idfalsefalsejava.lang.StringAn identifier for this particular component instance within a component view.

The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view

This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted.

renderedfalsefalsejava.lang.StringA boolean value that indicates whether this component should be rendered. Default value: true.
bindingfalsefalsejava.lang.StringIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.