root / snf-cyclades-app / synnefo / ui / static / snf / js / jquery.pagination.js @ 9ccb70fd
History | View | Annotate | Download (7.8 kB)
1 | 48c07635 | Kostas Papadimitriou | /**
|
---|---|---|---|
2 | 48c07635 | Kostas Papadimitriou | * This jQuery plugin displays pagination links inside the selected elements.
|
3 | 48c07635 | Kostas Papadimitriou | *
|
4 | 48c07635 | Kostas Papadimitriou | * This plugin needs at least jQuery 1.4.2
|
5 | 48c07635 | Kostas Papadimitriou | *
|
6 | 48c07635 | Kostas Papadimitriou | * @author Gabriel Birke (birke *at* d-scribe *dot* de)
|
7 | 48c07635 | Kostas Papadimitriou | * @version 2.2
|
8 | 48c07635 | Kostas Papadimitriou | * @param {int} maxentries Number of entries to paginate
|
9 | 48c07635 | Kostas Papadimitriou | * @param {Object} opts Several options (see README for documentation)
|
10 | 48c07635 | Kostas Papadimitriou | * @return {Object} jQuery Object
|
11 | 48c07635 | Kostas Papadimitriou | */
|
12 | 48c07635 | Kostas Papadimitriou | (function($){ |
13 | 48c07635 | Kostas Papadimitriou | /**
|
14 | 48c07635 | Kostas Papadimitriou | * @class Class for calculating pagination values
|
15 | 48c07635 | Kostas Papadimitriou | */
|
16 | 48c07635 | Kostas Papadimitriou | $.PaginationCalculator = function(maxentries, opts) { |
17 | 48c07635 | Kostas Papadimitriou | this.maxentries = maxentries;
|
18 | 48c07635 | Kostas Papadimitriou | this.opts = opts;
|
19 | 48c07635 | Kostas Papadimitriou | } |
20 | 48c07635 | Kostas Papadimitriou | |
21 | 48c07635 | Kostas Papadimitriou | $.extend($.PaginationCalculator.prototype, { |
22 | 48c07635 | Kostas Papadimitriou | /**
|
23 | 48c07635 | Kostas Papadimitriou | * Calculate the maximum number of pages
|
24 | 48c07635 | Kostas Papadimitriou | * @method
|
25 | 48c07635 | Kostas Papadimitriou | * @returns {Number}
|
26 | 48c07635 | Kostas Papadimitriou | */
|
27 | 48c07635 | Kostas Papadimitriou | numPages:function() { |
28 | 48c07635 | Kostas Papadimitriou | return Math.ceil(this.maxentries/this.opts.items_per_page); |
29 | 48c07635 | Kostas Papadimitriou | }, |
30 | 48c07635 | Kostas Papadimitriou | /**
|
31 | 48c07635 | Kostas Papadimitriou | * Calculate start and end point of pagination links depending on
|
32 | 48c07635 | Kostas Papadimitriou | * current_page and num_display_entries.
|
33 | 48c07635 | Kostas Papadimitriou | * @returns {Array}
|
34 | 48c07635 | Kostas Papadimitriou | */
|
35 | 48c07635 | Kostas Papadimitriou | getInterval:function(current_page) { |
36 | 48c07635 | Kostas Papadimitriou | var ne_half = Math.floor(this.opts.num_display_entries/2); |
37 | 48c07635 | Kostas Papadimitriou | var np = this.numPages(); |
38 | 48c07635 | Kostas Papadimitriou | var upper_limit = np - this.opts.num_display_entries; |
39 | 48c07635 | Kostas Papadimitriou | var start = current_page > ne_half ? Math.max( Math.min(current_page - ne_half, upper_limit), 0 ) : 0; |
40 | 48c07635 | Kostas Papadimitriou | var end = current_page > ne_half?Math.min(current_page+ne_half + (this.opts.num_display_entries % 2), np):Math.min(this.opts.num_display_entries, np); |
41 | 48c07635 | Kostas Papadimitriou | return {start:start, end:end}; |
42 | 48c07635 | Kostas Papadimitriou | } |
43 | 48c07635 | Kostas Papadimitriou | }); |
44 | 48c07635 | Kostas Papadimitriou | |
45 | 48c07635 | Kostas Papadimitriou | // Initialize jQuery object container for pagination renderers
|
46 | 48c07635 | Kostas Papadimitriou | $.PaginationRenderers = {}
|
47 | 48c07635 | Kostas Papadimitriou | |
48 | 48c07635 | Kostas Papadimitriou | /**
|
49 | 48c07635 | Kostas Papadimitriou | * @class Default renderer for rendering pagination links
|
50 | 48c07635 | Kostas Papadimitriou | */
|
51 | 48c07635 | Kostas Papadimitriou | $.PaginationRenderers.defaultRenderer = function(maxentries, opts) { |
52 | 48c07635 | Kostas Papadimitriou | this.maxentries = maxentries;
|
53 | 48c07635 | Kostas Papadimitriou | this.opts = opts;
|
54 | 48c07635 | Kostas Papadimitriou | this.pc = new $.PaginationCalculator(maxentries, opts); |
55 | 48c07635 | Kostas Papadimitriou | } |
56 | 48c07635 | Kostas Papadimitriou | $.extend($.PaginationRenderers.defaultRenderer.prototype, { |
57 | 48c07635 | Kostas Papadimitriou | /**
|
58 | 48c07635 | Kostas Papadimitriou | * Helper function for generating a single link (or a span tag if it's the current page)
|
59 | 48c07635 | Kostas Papadimitriou | * @param {Number} page_id The page id for the new item
|
60 | 48c07635 | Kostas Papadimitriou | * @param {Number} current_page
|
61 | 48c07635 | Kostas Papadimitriou | * @param {Object} appendopts Options for the new item: text and classes
|
62 | 48c07635 | Kostas Papadimitriou | * @returns {jQuery} jQuery object containing the link
|
63 | 48c07635 | Kostas Papadimitriou | */
|
64 | 48c07635 | Kostas Papadimitriou | createLink:function(page_id, current_page, appendopts){ |
65 | 48c07635 | Kostas Papadimitriou | var lnk, np = this.pc.numPages(); |
66 | 48c07635 | Kostas Papadimitriou | page_id = page_id<0?0:(page_id<np?page_id:np-1); // Normalize page id to sane value |
67 | 48c07635 | Kostas Papadimitriou | appendopts = $.extend({text:page_id+1, classes:""}, appendopts||{}); |
68 | 48c07635 | Kostas Papadimitriou | if(page_id == current_page){
|
69 | 48c07635 | Kostas Papadimitriou | lnk = $("<span class='current'>" + appendopts.text + "</span>"); |
70 | 48c07635 | Kostas Papadimitriou | } |
71 | 48c07635 | Kostas Papadimitriou | else
|
72 | 48c07635 | Kostas Papadimitriou | { |
73 | 48c07635 | Kostas Papadimitriou | lnk = $("<a>" + appendopts.text + "</a>") |
74 | 48c07635 | Kostas Papadimitriou | .attr('href', this.opts.link_to.replace(/__id__/,page_id)); |
75 | 48c07635 | Kostas Papadimitriou | } |
76 | 48c07635 | Kostas Papadimitriou | if(appendopts.classes){ lnk.addClass(appendopts.classes); }
|
77 | 48c07635 | Kostas Papadimitriou | lnk.data('page_id', page_id);
|
78 | 48c07635 | Kostas Papadimitriou | return lnk;
|
79 | 48c07635 | Kostas Papadimitriou | }, |
80 | 48c07635 | Kostas Papadimitriou | // Generate a range of numeric links
|
81 | 48c07635 | Kostas Papadimitriou | appendRange:function(container, current_page, start, end, opts) { |
82 | 48c07635 | Kostas Papadimitriou | var i;
|
83 | 48c07635 | Kostas Papadimitriou | for(i=start; i<end; i++) {
|
84 | 48c07635 | Kostas Papadimitriou | this.createLink(i, current_page, opts).appendTo(container);
|
85 | 48c07635 | Kostas Papadimitriou | } |
86 | 48c07635 | Kostas Papadimitriou | }, |
87 | 48c07635 | Kostas Papadimitriou | getLinks:function(current_page, eventHandler) { |
88 | 48c07635 | Kostas Papadimitriou | var begin, end,
|
89 | 48c07635 | Kostas Papadimitriou | interval = this.pc.getInterval(current_page),
|
90 | 48c07635 | Kostas Papadimitriou | np = this.pc.numPages(),
|
91 | 48c07635 | Kostas Papadimitriou | fragment = $("<div class='pagination'></div>"); |
92 | 48c07635 | Kostas Papadimitriou | |
93 | 48c07635 | Kostas Papadimitriou | // Generate "Previous"-Link
|
94 | 48c07635 | Kostas Papadimitriou | if(this.opts.prev_text && (current_page > 0 || this.opts.prev_show_always)){ |
95 | 48c07635 | Kostas Papadimitriou | fragment.append(this.createLink(current_page-1, current_page, {text:this.opts.prev_text, classes:"prev"})); |
96 | 48c07635 | Kostas Papadimitriou | } |
97 | 48c07635 | Kostas Papadimitriou | // Generate starting points
|
98 | 48c07635 | Kostas Papadimitriou | if (interval.start > 0 && this.opts.num_edge_entries > 0) |
99 | 48c07635 | Kostas Papadimitriou | { |
100 | 48c07635 | Kostas Papadimitriou | end = Math.min(this.opts.num_edge_entries, interval.start);
|
101 | 48c07635 | Kostas Papadimitriou | this.appendRange(fragment, current_page, 0, end, {classes:'sp'}); |
102 | 48c07635 | Kostas Papadimitriou | if(this.opts.num_edge_entries < interval.start && this.opts.ellipse_text) |
103 | 48c07635 | Kostas Papadimitriou | { |
104 | 48c07635 | Kostas Papadimitriou | jQuery("<span>"+this.opts.ellipse_text+"</span>").appendTo(fragment); |
105 | 48c07635 | Kostas Papadimitriou | } |
106 | 48c07635 | Kostas Papadimitriou | } |
107 | 48c07635 | Kostas Papadimitriou | // Generate interval links
|
108 | 48c07635 | Kostas Papadimitriou | this.appendRange(fragment, current_page, interval.start, interval.end);
|
109 | 48c07635 | Kostas Papadimitriou | // Generate ending points
|
110 | 48c07635 | Kostas Papadimitriou | if (interval.end < np && this.opts.num_edge_entries > 0) |
111 | 48c07635 | Kostas Papadimitriou | { |
112 | 48c07635 | Kostas Papadimitriou | if(np-this.opts.num_edge_entries > interval.end && this.opts.ellipse_text) |
113 | 48c07635 | Kostas Papadimitriou | { |
114 | 48c07635 | Kostas Papadimitriou | jQuery("<span>"+this.opts.ellipse_text+"</span>").appendTo(fragment); |
115 | 48c07635 | Kostas Papadimitriou | } |
116 | 48c07635 | Kostas Papadimitriou | begin = Math.max(np-this.opts.num_edge_entries, interval.end);
|
117 | 48c07635 | Kostas Papadimitriou | this.appendRange(fragment, current_page, begin, np, {classes:'ep'}); |
118 | 48c07635 | Kostas Papadimitriou | |
119 | 48c07635 | Kostas Papadimitriou | } |
120 | 48c07635 | Kostas Papadimitriou | // Generate "Next"-Link
|
121 | 48c07635 | Kostas Papadimitriou | if(this.opts.next_text && (current_page < np-1 || this.opts.next_show_always)){ |
122 | 48c07635 | Kostas Papadimitriou | fragment.append(this.createLink(current_page+1, current_page, {text:this.opts.next_text, classes:"next"})); |
123 | 48c07635 | Kostas Papadimitriou | } |
124 | 48c07635 | Kostas Papadimitriou | $('a', fragment).click(eventHandler); |
125 | 48c07635 | Kostas Papadimitriou | return fragment;
|
126 | 48c07635 | Kostas Papadimitriou | } |
127 | 48c07635 | Kostas Papadimitriou | }); |
128 | 48c07635 | Kostas Papadimitriou | |
129 | 48c07635 | Kostas Papadimitriou | // Extend jQuery
|
130 | 48c07635 | Kostas Papadimitriou | $.fn.pagination = function(maxentries, opts){ |
131 | 48c07635 | Kostas Papadimitriou | |
132 | 48c07635 | Kostas Papadimitriou | // Initialize options with default values
|
133 | 48c07635 | Kostas Papadimitriou | opts = jQuery.extend({ |
134 | 48c07635 | Kostas Papadimitriou | items_per_page:10, |
135 | 48c07635 | Kostas Papadimitriou | num_display_entries:11, |
136 | 48c07635 | Kostas Papadimitriou | current_page:0, |
137 | 48c07635 | Kostas Papadimitriou | num_edge_entries:0, |
138 | 48c07635 | Kostas Papadimitriou | link_to:"#", |
139 | 48c07635 | Kostas Papadimitriou | prev_text:"Prev", |
140 | 48c07635 | Kostas Papadimitriou | next_text:"Next", |
141 | 48c07635 | Kostas Papadimitriou | ellipse_text:"...", |
142 | 48c07635 | Kostas Papadimitriou | prev_show_always:true, |
143 | 48c07635 | Kostas Papadimitriou | next_show_always:true, |
144 | 48c07635 | Kostas Papadimitriou | renderer:"defaultRenderer", |
145 | 48c07635 | Kostas Papadimitriou | load_first_page:false, |
146 | 48c07635 | Kostas Papadimitriou | callback:function(){return false;} |
147 | 48c07635 | Kostas Papadimitriou | },opts||{}); |
148 | 48c07635 | Kostas Papadimitriou | |
149 | 48c07635 | Kostas Papadimitriou | var containers = this, |
150 | 48c07635 | Kostas Papadimitriou | renderer, links, current_page; |
151 | 48c07635 | Kostas Papadimitriou | |
152 | 48c07635 | Kostas Papadimitriou | /**
|
153 | 48c07635 | Kostas Papadimitriou | * This is the event handling function for the pagination links.
|
154 | 48c07635 | Kostas Papadimitriou | * @param {int} page_id The new page number
|
155 | 48c07635 | Kostas Papadimitriou | */
|
156 | 48c07635 | Kostas Papadimitriou | function paginationClickHandler(evt){ |
157 | 48c07635 | Kostas Papadimitriou | var links,
|
158 | 48c07635 | Kostas Papadimitriou | new_current_page = $(evt.target).data('page_id'), |
159 | 48c07635 | Kostas Papadimitriou | continuePropagation = selectPage(new_current_page); |
160 | 48c07635 | Kostas Papadimitriou | if (!continuePropagation) {
|
161 | 48c07635 | Kostas Papadimitriou | evt.stopPropagation(); |
162 | 48c07635 | Kostas Papadimitriou | } |
163 | 48c07635 | Kostas Papadimitriou | return continuePropagation;
|
164 | 48c07635 | Kostas Papadimitriou | } |
165 | 48c07635 | Kostas Papadimitriou | |
166 | 48c07635 | Kostas Papadimitriou | /**
|
167 | 48c07635 | Kostas Papadimitriou | * This is a utility function for the internal event handlers.
|
168 | 48c07635 | Kostas Papadimitriou | * It sets the new current page on the pagination container objects,
|
169 | 48c07635 | Kostas Papadimitriou | * generates a new HTMl fragment for the pagination links and calls
|
170 | 48c07635 | Kostas Papadimitriou | * the callback function.
|
171 | 48c07635 | Kostas Papadimitriou | */
|
172 | 48c07635 | Kostas Papadimitriou | function selectPage(new_current_page) { |
173 | 48c07635 | Kostas Papadimitriou | // update the link display of a all containers
|
174 | 48c07635 | Kostas Papadimitriou | containers.data('current_page', new_current_page);
|
175 | 48c07635 | Kostas Papadimitriou | links = renderer.getLinks(new_current_page, paginationClickHandler); |
176 | 48c07635 | Kostas Papadimitriou | containers.empty(); |
177 | 48c07635 | Kostas Papadimitriou | links.appendTo(containers); |
178 | 48c07635 | Kostas Papadimitriou | // call the callback and propagate the event if it does not return false
|
179 | 48c07635 | Kostas Papadimitriou | var continuePropagation = opts.callback(new_current_page, containers);
|
180 | 48c07635 | Kostas Papadimitriou | return continuePropagation;
|
181 | 48c07635 | Kostas Papadimitriou | } |
182 | 48c07635 | Kostas Papadimitriou | |
183 | 48c07635 | Kostas Papadimitriou | // -----------------------------------
|
184 | 48c07635 | Kostas Papadimitriou | // Initialize containers
|
185 | 48c07635 | Kostas Papadimitriou | // -----------------------------------
|
186 | 48c07635 | Kostas Papadimitriou | current_page = opts.current_page; |
187 | 48c07635 | Kostas Papadimitriou | containers.data('current_page', current_page);
|
188 | 48c07635 | Kostas Papadimitriou | // Create a sane value for maxentries and items_per_page
|
189 | 48c07635 | Kostas Papadimitriou | maxentries = (!maxentries || maxentries < 0)?1:maxentries; |
190 | 48c07635 | Kostas Papadimitriou | opts.items_per_page = (!opts.items_per_page || opts.items_per_page < 0)?1:opts.items_per_page; |
191 | 48c07635 | Kostas Papadimitriou | |
192 | 48c07635 | Kostas Papadimitriou | if(!$.PaginationRenderers[opts.renderer]) |
193 | 48c07635 | Kostas Papadimitriou | { |
194 | 48c07635 | Kostas Papadimitriou | throw new ReferenceError("Pagination renderer '" + opts.renderer + "' was not found in jQuery.PaginationRenderers object."); |
195 | 48c07635 | Kostas Papadimitriou | } |
196 | 48c07635 | Kostas Papadimitriou | renderer = new $.PaginationRenderers[opts.renderer](maxentries, opts); |
197 | 48c07635 | Kostas Papadimitriou | |
198 | 48c07635 | Kostas Papadimitriou | // Attach control events to the DOM elements
|
199 | 48c07635 | Kostas Papadimitriou | var pc = new $.PaginationCalculator(maxentries, opts); |
200 | 48c07635 | Kostas Papadimitriou | var np = pc.numPages();
|
201 | 48c07635 | Kostas Papadimitriou | containers.bind('setPage', {numPages:np}, function(evt, page_id) { |
202 | 48c07635 | Kostas Papadimitriou | if(page_id >= 0 && page_id < evt.data.numPages) { |
203 | 48c07635 | Kostas Papadimitriou | selectPage(page_id); return false; |
204 | 48c07635 | Kostas Papadimitriou | } |
205 | 48c07635 | Kostas Papadimitriou | }); |
206 | 48c07635 | Kostas Papadimitriou | containers.bind('prevPage', function(evt){ |
207 | 48c07635 | Kostas Papadimitriou | var current_page = $(this).data('current_page'); |
208 | 48c07635 | Kostas Papadimitriou | if (current_page > 0) { |
209 | 48c07635 | Kostas Papadimitriou | selectPage(current_page - 1);
|
210 | 48c07635 | Kostas Papadimitriou | } |
211 | 48c07635 | Kostas Papadimitriou | return false; |
212 | 48c07635 | Kostas Papadimitriou | }); |
213 | 48c07635 | Kostas Papadimitriou | containers.bind('nextPage', {numPages:np}, function(evt){ |
214 | 48c07635 | Kostas Papadimitriou | var current_page = $(this).data('current_page'); |
215 | 48c07635 | Kostas Papadimitriou | if(current_page < evt.data.numPages - 1) { |
216 | 48c07635 | Kostas Papadimitriou | selectPage(current_page + 1);
|
217 | 48c07635 | Kostas Papadimitriou | } |
218 | 48c07635 | Kostas Papadimitriou | return false; |
219 | 48c07635 | Kostas Papadimitriou | }); |
220 | 48c07635 | Kostas Papadimitriou | |
221 | 48c07635 | Kostas Papadimitriou | // When all initialisation is done, draw the links
|
222 | 48c07635 | Kostas Papadimitriou | links = renderer.getLinks(current_page, paginationClickHandler); |
223 | 48c07635 | Kostas Papadimitriou | containers.empty(); |
224 | 48c07635 | Kostas Papadimitriou | links.appendTo(containers); |
225 | 48c07635 | Kostas Papadimitriou | // call callback function
|
226 | 48c07635 | Kostas Papadimitriou | if(opts.load_first_page) {
|
227 | 48c07635 | Kostas Papadimitriou | opts.callback(current_page, containers); |
228 | 48c07635 | Kostas Papadimitriou | } |
229 | 48c07635 | Kostas Papadimitriou | } // End of $.fn.pagination block
|
230 | 48c07635 | Kostas Papadimitriou | |
231 | 48c07635 | Kostas Papadimitriou | })(jQuery); |