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,357 thoughts on “FreeMarker pagination macros”

  3. online which states do not allow gambling (Zelma) laws in uk,
    big red pokie wins united kingdom 2021 and online bingo usa, or poker sites canada

  10. pokies return rate canada, online poker in australia legal and same-day withdrawal online casinos
    united states, or best united statesn online winning a casino
    jackpot; Marti, no deposit bonus 2021

  11. rosie’s gambling (Justin) casino usa,
    grand dusae casino no deposit bonus and casino on net 888 usa, or australia gambling sites

  14. no deposit free chip [Willian] casino slots in united kingdom, 21 dusaes casino and traditional
    native united statesn gambling games, or top casino in united states
    for real money

  17. how to win slot machines canada, 21 dusaes casino and canadian gambling game, or united kingdom
    roulette betting strategy

    Here is my blog: can you gamble for someone else (Deneen)

  31. milwausaee wisconsin casino, betsoft no deposit bonus united kingdom and best free slots united states, or online
    gambling canada illegal

    Feel free to surf to my web blog – bingo software download for pc (Jerald)

  36. new zealandn online pokies au reviews, wild
    life slots australia and online casino uk free bonus no deposit, or free
    online poker machine games united kingdom

    Also visit my web site; are chinese gamblers, Keith,

  47. gaki no tsukai electric shock roulette, top
    100 uk online casinos craps table c and e [Perry] online bingo usa, or free united statesn slot machine games

  48. legal gambling sites canada, las vegas casino surveillance,
    Maryjo, online usa and best online pokies in new zealand with neosurf, or united statesn free slots
    no download

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>