Pager API

fluid.pager(container, options);

Parameters

container

The container parameter is is a selector, a single-element jQuery, or a DOM element specifying the root DOM node of the Pager markup.

options

The options parameter is an optional collection of name-value pairs that configure the Pager and its subcomponents, as described below in the Options section.

Supported Events

The Pager component fires the following event:

In addition, in this release, the Pager also supports the following events, which are however implementation-specific, and part of a transitional implementation strategy before the adoption of the Data Binder and BeanInvalidationModel:

For more information about events, see Events for Component Users.

Options

The following options to the creator function can be used to customize the behaviour of the Pager component:

  pagerBar
  pagerBarSecondary
  summary
  pageSize
  headerSortStylisticOffset

selectors: {
    pagerBar: ".flc-pager-top",
    pagerBarSecondary: ".flc-pager-bottom",
    summary: ".flc-pager-summary",
    pageSize: ".flc-pager-page-size",
    headerSortStylisticOffset: ".flc-pager-sort-header"
}

  tooltip
  ascendingHeader
  descendingHeader

styles: {
    tooltip: "fl-pager-tooltip",
    ascendingHeader: "fl-pager-asc",
    descendingHeader: "fl-pager-desc"
}

strings: {
  last: " (last)"
}

function(overallThat, model)

events: {
  initiatePageChange: null,
  initiatePageSizeChange: null,
  onModelChange: null,
  onRenderPageLinks: null
}

There are also options available to select and configure each of the subcomponents used by the Pager. These options are listed here, and their contents are described in detail in the relevant sections below.

   {type: functionName,
    options: pagerBarOptions}

pagerBar: {
  type: "fluid.pager.pagerBar",
  options: null
} 

   {type: functionName,
    options: summaryOptions}

summary: {
  type: "fluid.pager.summary", 
  options: {
    message: "%first-%last of %total items"
  }
}

   {type: functionName,
    options: pageSizeOptions}

pageSize: {
  type: "fluid.pager.directPageSize"
}

   {type: functionName}

rangeAnnotator: {
    type: "fluid.pager.rangeAnnotator"
}

   {type: functionName,
    options: bodyRendererOptions}

bodyRenderer: {
    type: "fluid.emptySubcomponent"
}

Options for the Data-driven Pager

While the Pager can be used in a 100% markup-driven mode, it is recommended to use the Pager's built-in integration with Fluid's Renderer, which supports rendering of dynamic multi-page data-driven tables. If the Renderer is used, various configuration information must be provided for it.

To configure the Pager in data-driven mode, you must request the fluid.pager.selfRender for the bodyRenderer option, as follows:

bodyRenderer: {
    type: "fluid.pager.selfRender",
    options: selfRenderOptions
}

The selfRenderOptions are described below, in the BodyRenderer subcomponent section.

When Pager is configured for data-driven paging by setting the bodyRenderer option to fluid.pager.selfRender, several other top-level Pager options become available. NOTE that when the self-rendering is not used, these options are ignored.

The ColumnDef structure

The configuration option columnDefs takes the form of an array of ColumnDef objects, one configuring each required column of the rendered table (a renderer must be in use).

The following table explains the layout and function of the fields in the ColumnDef structure:

Component expansion

As this component is cloned, once for each cell in its column, it will undergo various forms of expansion - the most important of these is with respect to the special placeholder value fluid.VALUE. This may be placed where any string or UIBound component is expected, and will be expanded to hold either the value or binding of the correct column cell, with respect to the wildcard path specified in valuebinding. A further form of expansion also allows interpolation of read-only values in the middle of literal string, by use of a Smarty-like variable syntax. The string ${VALUE} will expand to the same value as fluid.VALUE, whereas general EL expressions of the form which are supported for valuebinding are also supported.

Here is a sample of a ColumnDef object with a UILink type cell showing both forms of substitution:

{key: "user-link",
   valuebinding: "*.userDisplayName",  
   components: {
     target: "/dev/sn/profile.html?user=${*.userId}",
     linktext: fluid.VALUE},
   sortable:true
 }

Here, the linktext field will be bound to *.userDisplayName, whereas the URL target will be formed by interpolation with a value from *.userId. In this case both of these EL paths will be prefixed by any value in dataOffset before fetching.

PagerBar subcomponent

The PagerBar is the most substantial subcomponent of the pager, and contains controls operating links for page navigation - these may include previous/next, first/last as well as an array of numbered page links. The dropdown control for selecting page size, PageSize may be physically nested within the same container as the markup managed by the PagerBar, but is not logically part of the same control.

Two PagerBars may be configured for a Pager control, under the names pagerBar and pagerBarSecondary which were mentioned in the top-level options structure above. These may appear at arbitrary positions in the overall markup (top/bottom, etc.), however, the pagerBar is primary in that if one of these bars is omitted, it must be the pagerBarSecondary.

options

  pageLinks
  previous
  next

selectors: {
    pageLinks: ".flc-pager-pageLink",
    pageLinkSkip: ".flc-pager-pageLink-skip",
    pageLinkDisabled: ".flc-pager-pageLink-disabled",
    previous: ".flc-pager-previous",
    next: ".flc-pager-next"
}

  currentPage
  disabled

styles: {
    currentPage: "fl-pager-currentPage",
    disabled: "fl-pager-disabled"
}

PageList subcomponent

The PageList subcomponent is actually a second-level subcomponent of the overall Pager - it is nested within the PagerBar component configured at top level. PageList is responsible for managing, and optionally rendering, a list of page link controls which allow quick random access to different page views.

Two implementations are provided - fluid.pager.directPageList (the default) which simply accepts a pre-rendered and unchanging list of page links present in the DOM at startup, and fluid.pager.rendered.PageList which treats the links in the DOM as a template, and accepts further configuration in order to generate a link list dynamically as the number of view pages alters.

The configuration for fluid.pager.directPageList is taken entirely from the pageLinks selector configured into the top-level components.

Options for fluid.pager.renderedPageList

selectors: {
  root: ".flc-pager-links"
  }

pageStrategy implementors

The signature of a pageStrategy function is function(pageCount, first, mid) -> Array[Number], where pageCount is the total page count, first is the first required page number, and mid represents the currently visible page number. The returned array consists of a number representing a page number where one is required, or the value -1 to represent a range of pages that have been omitted.

The framework contains two implementations, fluid.pager.everyPageStrategy, which generates an entry for every page in the range, and fluid.pager.gappedPageStrategy, which is a factory function which generates implementations which will collapse pages which are not near either the ends of the range or the currently visible page. For example, fluid.pager.gappedPageStrategy(3, 1) will return a pageStrategy implementation which will return page numbers that are either within 3 pages of the end of the range, or within 1 of the current page position.

PreviousNext subcomponent

The PagerBar also has a PreviousNext subcomponent, which displays controls for navigating to the 'next' or 'previous' page. This subcomponent has no options of its own.

Summary subcomponent

The purpose of the summary component is to manage a small textual control representing an overall "summary" of the paging state. This typically holds a message reading similarly to "30-31 of 139 items"

options

PageSize subcomponent

The PageSize component operates a control which allows the user to select the number of items shown at one time on a visible page of the control.

The default implementation of the PageSize component has no options of its own. Its assumption is that the tag identified by the pageSize selector configured at the top-level component represents a standard HTML <select> control which has been populated with a list of the desired range of page sizes. By default as listed above, the type of the PageSize subcomponent is initialised to "fluid.pager.directPageSize".

RangeAnnotator subcomponent

The RangeAnnotator subcomponent decorates the displayed page links with a tooltip displaying the range of data values held on that page. To use the RangeAnnotator, you must specify the rangeAnnotator option, as follows:

rangeAnnotator: {
    type: "fluid.pager.rangeAnnotator"
}

Note that if the RangeAnnotator is used you must provide top-level the annotateColumnRange options. When the RangeAnnotator is used, several other top-level Pager options become available. NOTE that when the RangeAnnotator is not used, these options are ignored.

Top-level options for the RangeAnnotator

Please note that these options, while used to configure the RangeAnnotator subcomponent, must be provided as top-level options to the Pager itself. In future releases, they will become options of the RangeAnnotator itself.

BodyRenderer subcomponent

The component configured as bodyRenderer, to the knowledge of the overall Page component, simply has the role of a standard listener to onModelChanegd. However, the special function of this subcomponent, if configured, is to perform the work of locating an HTML template suitable for rendering the actual paged view contents, and responding to changes in the pager's model for the purpose of keeping the rendered view updated.

The work of rendering the paged body is split into two parts - firstly, the part of preparing the direct (JSON) representation of the data to be renderered. This is performed by the top-level component configured as modelFilter. A ModelFilter is simply a function, whose signature and purpose is documented as part of the top-level component options - it need not actually make use its argument model to filter the data view, but there is a standard implementation fluid.pager.directModelFilter that simply takes the model (configured as the top-level that.options.dataModel) and extracts just those rows identified by the pagerModel.

The standard implementation of the BodyRenderer in fluid.pager.selfRender locates and makes use of the configured top-level ModelFilter in its listener implementation. The ModelFilter is invoked to do its work of preparing the data suitable for this event cycle, which is then handed to the Fluid Renderer - Background for rendering. Other implementations of BodyRenderer might use other rendering schemes.

options

selectors: {
    root: ".flc-pager-body-template"
}

Options for fluid.pager.selfRender

selectors: {
  root: ".flc-pager-body-template"
}

The Pager Model

Where the component that is constructed by a line such as

var that = fluid.pager(component, options);

the returned object will have a data member called model:

that.model

This object is the "model" of the pager - note that this is not the same as the data model of the user:

• The Pager's model consists of the state of the paging component, which specifies the page index position, overall data range and page size.
• The user's data model consists of the actual data being paged, which is stored in that.options.dataModel.

This, the Pager's model, should be treated as read-only via this interface, and should only be manipulated by use of the component's event system.

The pager model is laid out as following:

Note that pageLimit is not actually stored within the model at any point, but is supplied a computation function computePageLimit to match computePageCount by which pageCount is derived from the primary fields.

Dependencies

The Pager dependencies can be met by including the minified Fluid-all.js file in the header of the HTML file:

<script type="text/javascript" src="Fluid-all.js"></script>

Alternatively, the individual file requirements are:

<script type="text/javascript" src="lib/jquery/core/js/jquery.js"></script>
<script type="text/javascript" src="lib/fastXmlPull/js/fastXmlPull.js"></script>
<script type="text/javascript" src="framework/renderer/js/fluidParser.js"></script>
<script type="text/javascript" src="framework/renderer/js/fluidRenderer.js"></script>
<script type="text/javascript" src="framework/core/js/Fluid.js"></script>
<script type="text/javascript" src="framework/core/js/DataBinding.js"></script>
<script type="text/javascript" src="components/pager/js/Pager.js"></script>

If you choose to use the Pager with your own mark-up, and to NOT use the Renderer, you only need:

<script type="text/javascript" src="lib/jquery/core/js/jquery.js"></script>
<script type="text/javascript" src="framework/core/js/Fluid.js"></script>
<script type="text/javascript" src="framework/core/js/DataBinding.js"></script>
<script type="text/javascript" src="components/pager/js/Pager.js"></script>