FreeMarker pagination macros

Posted on by

I couldn’t find a good set of macros to help navigate through paginated data so I wrote my own. The macro names echo the names of the CakePHP PaginationHelper functions because…well, they’re reasonably sensible.

The macros expect you to add a model attribute called “paginationData” which contains (at least) the following properties:

pageNumber -> The current page number
pageSize -> The number of items in each page
pagesAvailable -> The total number of pages
sortDirection -> The sorting direction (ascending or descending)
sortField -> The field currently sorted by

In my implementation, my paginationData also contains a property called “pageItems” – the actual items in this page.

The macros available to you are:

  • first
    Outputs a link to the first page
  • last
    Outputs a link to the last page
  • next
    Outputs a link to the next page
  • previous
    Outputs a link to the previous page
  • numbers
    Outputs links to other pages. The macro takes a parameter called “maxPages”, which is the maximum number of pages that should be output. There is also a second parameter “separator”, which is the text/html that should be output between each page link.
  • page
    Outputs a link to a particular page. It takes the page number and link text as parameters. If you omit the link text it’ll default to the page number
  • counter
    Outputs the current page number and the total pages e.g. “1 of 20″
  • sort
    Outputs a link to sort by a field. Takes the field to sort by as its first parameter. If field is different to the current sort field, the link will change the sort field but not the sort direction. If the field is the same as the current sort field, the link will change the sort direction. The second parameter is the link text, which defaults to the field name with an upper case first letter. It also takes a parameter called “directions”. This is an an array of two items: the words being used in paginationData.sortDirection to describe the sorting direction of ascending or descending. Default: ["Asc", "Desc"]. So it can compare the current sorting direction and switch to the converse.

Note, ordinarily you’ll probably not need to use the “page” macro.

How to use

In Java, add a model attribute “paginationData” containing the properties I’ve described above. Then, in your view, import the library:

    <#import "pagination.ftl" as pagination />

Call the macros:

    <nav style="float:right;">
        <@pagination.first />
        <@pagination.previous />
        <@pagination.numbers />
        <@pagination.next />
        <@pagination.last />
    </nav>
    <@pagination.counter />

Which’ll give you something like:

For table headings that allow sorting:

    <table>
        <tr>
            <th><@pagination.sort "forename" /></th>
            <th><@pagination.sort "surname" /></th>
            <th><@pagination.sort "email" /></th>
            <th><@pagination.sort "created" "Registration date" /></th>
        </tr>
        ...
    </table>

Download

You can download the pagination macros here.

6,889 thoughts on “FreeMarker pagination macros”

  2. wedden met bonus

    My web-site :: betrouwbaar casino site nederland zonder cruks – Jon,

  6. Thanks for your write-up. I also feel that laptop computers have gotten more and more popular currently, and now in many cases are the only type of computer used in a household. The reason being at the same time they are becoming more and more affordable, their processing power is growing to the point where they’re as highly effective as personal computers out of just a few years back.

  17. best payout online slots canada, skrill united states gambling and poker tour australia, or registration bonus madera casino (Sherrill)
    usa

  20. how do poker machines work in australia, no deposit
    online casino united states and top 100 usa casino sites, or united kingdom poker machine
    game download

    My web site: Nsw Gambling

  26. bet365 roulette strategy usa, real slot machines for sale canada and 500 poker chips united kingdom, or best australia pokies

    Check out my blog – gambling sites that accept american express, Vilma,

  27. continyously i usrd too read smasller artkcles tnat aloso clear their motive,
    andd thwt iss also happenig wigh thbis paragraph whic I amm readng now.
    xnxx

  30. online casinos in ontario australia, best slots online canada and directions real gambling games to win real money, Roma,
    potawatomi casino in milwaukee, or casino age limit
    canada

  37. free pokies canada aristocrat, free spins sign up casino australia and fishing frenzy slot free online, or
    play online pokies usa

    Feel free to surf to my page … casinos in ruidoso open – Van -

  41. the blackjacks homepage canada, is there a casino in taunton and new us gambling, Sima, sites australia, or
    $1 deposit casino usa 2021

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>