Class Index | File Index

Classes


Class AjaxSolr.PagerWidget


Extends AjaxSolr.AbstractWidget.
PagerWidget
Defined in: PagerWidget.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
A pager widget for jQuery.
Method Summary
Method Attributes Method Name and Description
 
 
 
constructor(attributes)
 
 
 
 
pageLinkOrSpan(page, classnames, text)
 
 
 
relValue(page)
 
renderHeader(perPage, offset, total)
An abstract hook for child implementations.
 
renderLinks(links)
Render the pagination links.
 
 
Methods borrowed from class AjaxSolr.AbstractWidget:
beforeRequest, doRequest, init
Class Detail
AjaxSolr.PagerWidget()
A pager widget for jQuery.

Heavily inspired by the Ruby on Rails will_paginate gem.

Method Detail
afterRequest()

{Function} clickHandler(page)
Parameters:
{Number} page
A page number.
Returns:
{Function} The click handler for the page link.

constructor(attributes)
Parameters:
{Object} attributes Optional
{Number} attributes.innerWindow Optional
How many links are shown around the current page. Defaults to 4.
{Number} attributes.outerWindow Optional
How many links are around the first and the last page. Defaults to 1.
{String} attributes.prevLabel Optional
The previous page link label. Defaults to "« Previous".
{String} attributes.nextLabel Optional
The next page link label. Defaults to "Next »".
{String} attributes.separator Optional
Separator between pagination links. Defaults to " ".

{String} gapMarker()
Returns:
{String} The gap in page links, which is represented by:

{Number} getOffset()
Returns:
{Number} The Solr offset parameter's value.

{Number} nextPage()
Returns:
{Number} The page number of the next page or null if no next page.

pageLinkOrSpan(page, classnames, text)
Parameters:
{Number} page
A page number.
{String} classnames
CSS classes to add to the page link.
{String} text
The inner HTML of the page link (optional).
Returns:
The link or span for the given page.

{Number} perPage()
Returns:
{Number} The number of results to display per page.

{Number} previousPage()
Returns:
{Number} The page number of the previous page or null if no previous page.

{String} relValue(page)
Parameters:
{Number} page
A page number.
Returns:
{String} The rel attribute for the page link.

renderHeader(perPage, offset, total)
An abstract hook for child implementations.
Parameters:
{Number} perPage
The number of items shown per results page.
{Number} offset
The index in the result set of the first document to render.
{Number} total
The total number of documents in the result set.

renderLinks(links)
Render the pagination links.
Parameters:
{Array} links
The links for the visible page numbers.

{Array} visiblePageNumbers()
Returns:
{Array} The visible page numbers according to the window options.

{Array} windowedLinks()
Returns:
{Array} The links for the visible page numbers.

Documentation generated by JsDoc Toolkit 2.3.0 on Mon Apr 29 2013 14:55:21 GMT-0400 (EDT)