Documentation for a historical release of Infusion: 1.3
Please view the Infusion Documentation site for the latest documentation.
If you're looking for Fluid Project coordination, design, communication, etc, try the Fluid Project Wiki.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

This documentation refers to version 0.5 of the Pager code. For information related to trunk, please see Pager API.

Pager Overview

The Pager component allows users to break up long lists of items into separate pages. Currently, the Pager is entirely mark-up driven, and has limited functionality. Future releases will incorporate additional features.

Markup assumptions

Unlike many other Fluid Components, the Pager makes certain assumptions about the mark-up:

  1. The entire pager must be contained within a container element.
  2. Within that container, there are one or two 'pager bar' elements, each containing:
    • any number of page links
    • optionally, a 'next' element and a 'previous' element

The Pager uses CSS selectors to access these various components. Default selectors are assumed, which can be overriden (see #options below).

On This Page
See Also
Still need help?

Join the fluid-talk mailing list and ask your questions there.

Constructor

fluid.Pager(componentContainerId, options);

Parameters

componentContainerId

The componentContainerId parameter is the ID of the root DOM node of the Pager markup.

options

The options parameter is an optional collection of name-value pairs that configure the Pager:

Name

Description

Values

Default

selectors

Javascript object containing selectors for various fragments of the Pager component.

The object may contain any subset of the following keys:
  pagerTop
  pagerBottom
  pageLinks
  previous
  next
Any values not provided will revert to the default. 

selectors: {
    pagerTop: ".pager-top",
    pagerBottom: ".pager-bottom",
    pageLinks: ".page-link",
    previous: ".previous",
    next: ".next"
}

styles

Javascript object containing CSS style names that will be applied to the Pager component.

The object may contain any subset of the following keys:
  currentPage
  disabled
Any values not provided will revert to the default.

 
styles: {
    currentPage: "current-page",
    disabled: "disabled"
}

pageWillChange

A function that will be called each time a new page has been selected. This function will most likely retrieve data for the selected page, or otherwise update the data.

a function 

pageWillChange: function (link) {
}

Functions

fluid.Pager.next();

Selects the next page in the list of pages. If the current page is the last one, no action is taken.

fluid.Pager.previous();

Selects the previous page in the list of pages. If the current page is the first one, no action is taken.

fluid.Pager.selectPage(pageNum);

Selects a particular page in the list of pages. If the given page number (pageNum) is invalid, or is the same as the current page, no action is taken.

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="jquery/jquery-1.2.6.js"></script>
<script type="text/javascript" src="fluid/Fluid.js"></script>
<script type="text/javascript" src="fluid/Pager.js"></script>
  • No labels