Project Documentation
Foundation

Description

A component to run over the pages of an UIData (eg. <h:dataTable>).

Renders a DataScroller, which should work with any UIData. The facets are getting rendered in the following order: first, fastrewind, previous, next, fastforward, last

Screen Shot

DataScroller

API

component-family javax.faces.Panel
renderer-type org.apache.myfaces.DataScroller
component-class org.apache.myfaces.custom.datascroller.HtmlDataScroller
renderer-class org.apache.myfaces.custom.datascroller.HtmlDataScrollerRenderer
tag-class org.apache.myfaces.custom.datascroller.HtmlDataScrollerTag

Usage

<t:dataScroller [ user-role-support-attributes ]
                   [for="reference to UIData"]
                   [fastStep="values {ThemeIE, ThemeMiniBlack, ThemeOffice, ThemePanel}"]
                   [pageIndexVar="A parameter name, under which the actual page index is set in request scope
                                  similar to the var parameter."]
                   [pageCountVar="A parameter name, under which the actual page count is set in request scope
                                  similar to the var parameter."]>
    Nested Facets: first, previous, next, last, fastforward, fastrewind
</t:dataScroller>
            

Syntax

<t:dataScroller>

user-role-support-attributes
for="reference to UIData"
fastStep="values {ThemeIE, ThemeMiniBlack, ThemeOffice, ThemePanel}"
pageIndexVar="A parameter name, under which the actual page index is set in request scope similar to the var parameter."
pageCountVar="A parameter name, under which the actual page count is set in request scope similar to the var parameter."

Additional Information

DataScroller must be nested inside of an UIData component, or attribute "for" must be given so that corresponding uiData can be found.
The "row" attribute must be specified on the corresponding uiData.
The scope of pageIndexVar and pageCountVar is limited, and only direct children of DataScroller may see them.