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.
Field Summary
Field Attributes Field Name and Description
<private>  
The current page number.
 
How many links are shown around the current page.
 
The next page link label.
 
How many links are around the first and the last page.
 
The previous page link label.
 
Separator between pagination links.
<private>  
The total number of pages.
Fields borrowed from class AjaxSolr.AbstractWidget:
id, manager, target
Method Summary
Method Attributes Method Name and Description
 
 
 
 
 
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, init
Class Detail
AjaxSolr.PagerWidget()
A pager widget for jQuery.

Heavily inspired by the Ruby on Rails will_paginate gem.

Field Detail
<private> {Number} currentPage
The current page number.

{Number} innerWindow
How many links are shown around the current page.
Default Value:
4

{String} nextLabel
The next page link label.
Default Value:
"next »"

{Number} outerWindow
How many links are around the first and the last page.
Default Value:
1

{String} prevLabel
The previous page link label.
Default Value:
"« previous"

{String} separator
Separator between pagination links.
Default Value:
""

<private> {Number} totalPages
The total number of pages.
Method Detail
afterRequest()

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

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

{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} 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 Wed Sep 07 2011 22:31:36 GMT-0400 (EDT)