Wiki source code of Pagination
Version 25.1 by Manuel Smeria on 2013/02/19
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | 1 Pagination | ||
| 2 | |||
| 3 | #info("This was committed in 1.9RC1. See http://jira.xwiki.org/jira/browse/XWIKI-3880 for details.") | ||
| 4 | #toc('2' '2' '') | ||
| 5 | |||
| 6 | 1.1 Example | ||
| 7 | |||
| 8 | See [http://incubator.myxwiki.org/xwiki/bin/view/Main/ListWebSearch] | ||
| 9 | |||
| 10 | 1.1 Upper navigation | ||
| 11 | |||
| 12 | {image:Example-UpperNavigation.png|width=950} | ||
| 13 | |||
| 14 | 1.1.1 CSS | ||
| 15 | |||
| 16 | Filters CSS: | ||
| 17 | {code} | ||
| 18 | .searchFilters{ | ||
| 19 | clear: both; | ||
| 20 | font-size: 90%; | ||
| 21 | } | ||
| 22 | #sortFilter{ | ||
| 23 | color: #888; | ||
| 24 | padding: 5px; | ||
| 25 | line-height: 16px; | ||
| 26 | } | ||
| 27 | #sortFilter a.sortType{ | ||
| 28 | color: #888; | ||
| 29 | } | ||
| 30 | #sortFilter a.sortType:hover{ | ||
| 31 | color: #4D4D4D; | ||
| 32 | } | ||
| 33 | #sortFilter a#currentSort{ | ||
| 34 | color: #4D4D4D; | ||
| 35 | font-weight: bold; | ||
| 36 | } | ||
| 37 | #sortFilter a.sortType:focus, | ||
| 38 | #sortFilter a#currentSort:focus { | ||
| 39 | outline: dotted 1px #000; | ||
| 40 | } | ||
| 41 | {code} | ||
| 42 | |||
| 43 | Pagination with number of result pages displayed: | ||
| 44 | {code} | ||
| 45 | .paginationFilter { | ||
| 46 | color: #888; | ||
| 47 | height: 100%; | ||
| 48 | border-top: 1px solid #CCCCCC; | ||
| 49 | padding: 2px 0px 5px 5px; | ||
| 50 | display: block; | ||
| 51 | line-height: 22px; | ||
| 52 | } | ||
| 53 | .resultsNo{ | ||
| 54 | float: left; | ||
| 55 | } | ||
| 56 | .resultsNo .currentResultsNo, .resultsNo .totalResultsNo{ | ||
| 57 | color: #888; | ||
| 58 | } | ||
| 59 | .pagination{ | ||
| 60 | float: right; | ||
| 61 | margin-right: 10px; | ||
| 62 | } | ||
| 63 | .pagination a{ | ||
| 64 | color: #888; | ||
| 65 | } | ||
| 66 | .pagination a:hover{ | ||
| 67 | color: #4D4D4D; | ||
| 68 | } | ||
| 69 | .pagination a.currentPagination{ | ||
| 70 | color: #4D4D4D; | ||
| 71 | font-weight: bold; | ||
| 72 | } | ||
| 73 | .pagination a:focus { | ||
| 74 | outline: dotted 1px #000; | ||
| 75 | } | ||
| 76 | .controlPagination{ | ||
| 77 | position:relative; | ||
| 78 | width:42px; | ||
| 79 | height:22px; | ||
| 80 | overflow:hidden; | ||
| 81 | margin:0!important; | ||
| 82 | padding:0!important; | ||
| 83 | float: right; | ||
| 84 | } | ||
| 85 | .controlPagination a{ | ||
| 86 | position:absolute; | ||
| 87 | top:0; | ||
| 88 | left:0; | ||
| 89 | line-height:25px; | ||
| 90 | outline:none; | ||
| 91 | overflow:hidden; | ||
| 92 | border:none; | ||
| 93 | } | ||
| 94 | .controlPagination a.prevPagination , | ||
| 95 | .controlPagination a.noPrevPagination, | ||
| 96 | .controlPagination a.nextPagination, | ||
| 97 | .controlPagination a.noNextPagination { | ||
| 98 | background-image:url($xwiki.getSkinFile("navigation.png")); | ||
| 99 | width: 21px; | ||
| 100 | height: 22px; | ||
| 101 | } | ||
| 102 | .controlPagination a.prevPagination { | ||
| 103 | background-position:left top; | ||
| 104 | } | ||
| 105 | .controlPagination a.noPrevPagination{ | ||
| 106 | background-position:left bottom; | ||
| 107 | } | ||
| 108 | .controlPagination a.nextPagination { | ||
| 109 | background-position:right top; | ||
| 110 | left: 21px; | ||
| 111 | } | ||
| 112 | .controlPagination a.noNextPagination { | ||
| 113 | background-position:right bottom; | ||
| 114 | left: 21px; | ||
| 115 | } | ||
| 116 | {code} | ||
| 117 | |||
| 118 | 1.1.1 HTML Code | ||
| 119 | |||
| 120 | {code} | ||
| 121 | <div class="searchFilters"> | ||
| 122 | |||
| 123 | <div id="sortFilter"> | ||
| 124 | $msg.get("xe.search.filters.sort") | ||
| 125 | <a href="" id="currentSort" title="$msg.get('xe.search.filters.relevance.title')">$msg.get("xe.search.filters.relevance")</a> | ||
| 126 | <a href="" class="sortType" title="$msg.get('xe.search.filters.date.title')">$msg.get("xe.search.filters.date")</a> | ||
| 127 | <a href="" class="sortType" title="$msg.get('xe.search.filters.rating.title')">$msg.get("xe.search.filters.rating")</a> | ||
| 128 | <a href="" class="sortType" title="$msg.get('xe.search.filters.popularity.title')">$msg.get("xe.search.filters.popularity")</a> | ||
| 129 | </div> | ||
| 130 | |||
| 131 | <div class="paginationFilter"> | ||
| 132 | |||
| 133 | <span class="resultsNo">$msg.get("xe.pagination.results") <span class="currentResultsNo">6-30</span> $msg.get("xe.pagination.results.of") <span class="totalResultsNo">50</span></span> | ||
| 134 | |||
| 135 | <span class="controlPagination"> | ||
| 136 | <a href="#" title="$msg.get('xe.pagination.page.prev.title')" class="prevPagination"></a> | ||
| 137 | <a href="#" title="$msg.get('xe.pagination.page.next.title')" class="nextPagination"></a> | ||
| 138 | </span> | ||
| 139 | <span class="pagination">$msg.get("xe.pagination.page") | ||
| 140 | <a href="" title="$msg.get('xe.pagination.page.title',['1'])">1</a> | ||
| 141 | <a href="" class="currentPagination" title="$msg.get('xe.pagination.page.title',['2'])">2</a> | ||
| 142 | <a href="" title="$msg.get('xe.pagination.page.title',['3'])">3</a> | ||
| 143 | <a href="" title="$msg.get('xe.pagination.page.title',['4'])">4</a> | ||
| 144 | <a href="" title="$msg.get('xe.pagination.page.title',['5'])">5</a> | ||
| 145 | <a href="" title="$msg.get('xe.pagination.page.title',['6'])">6</a> | ||
| 146 | <a href="" title="$msg.get('xe.pagination.page.title',['7'])">7</a> | ||
| 147 | <a href="" title="$msg.get('xe.pagination.page.title',['8'])">8</a> | ||
| 148 | <a href="" title="$msg.get('xe.pagination.page.title',['9'])">9</a> | ||
| 149 | </span> | ||
| 150 | </div> | ||
| 151 | </div> | ||
| 152 | {code} | ||
| 153 | |||
| 154 | 1.1 <span id="bottomNav"> Bottom Navigation</span> | ||
| 155 | |||
| 156 | {image:Example-BottomNavigation.png|width=950} | ||
| 157 | |||
| 158 | This is a lighter version of the Upper Navigation, keeping only the pagination controls. | ||
| 159 | |||
| 160 | 1.1.1 CSS | ||
| 161 | |||
| 162 | Container: | ||
| 163 | {code} | ||
| 164 | .paginationFooter{ | ||
| 165 | display: block; | ||
| 166 | clear: both; | ||
| 167 | text-align: right; | ||
| 168 | font-size: 90%; | ||
| 169 | } | ||
| 170 | {code} | ||
| 171 | |||
| 172 | Same as in Upper navigation (don't apply if both navigations are present): | ||
| 173 | {code} | ||
| 174 | .paginationFilter { | ||
| 175 | color: #888; | ||
| 176 | height: 100%; | ||
| 177 | border-top: 1px solid #CCCCCC; | ||
| 178 | padding: 2px 0px 5px 5px; | ||
| 179 | display: block; | ||
| 180 | line-height: 22px; | ||
| 181 | } | ||
| 182 | .pagination{ | ||
| 183 | float: right; | ||
| 184 | margin-right: 10px; | ||
| 185 | } | ||
| 186 | .pagination a{ | ||
| 187 | color: #888; | ||
| 188 | } | ||
| 189 | .pagination a:hover{ | ||
| 190 | color: #4D4D4D; | ||
| 191 | } | ||
| 192 | .pagination a.currentPagination{ | ||
| 193 | color: #4D4D4D; | ||
| 194 | font-weight: bold; | ||
| 195 | } | ||
| 196 | .pagination a:focus { | ||
| 197 | outline: dotted 1px #000; | ||
| 198 | } | ||
| 199 | .controlPagination{ | ||
| 200 | position:relative; | ||
| 201 | width:42px; | ||
| 202 | height:22px; | ||
| 203 | overflow:hidden; | ||
| 204 | margin:0!important; | ||
| 205 | padding:0!important; | ||
| 206 | float: right; | ||
| 207 | } | ||
| 208 | .controlPagination a{ | ||
| 209 | position:absolute; | ||
| 210 | top:0; | ||
| 211 | left:0; | ||
| 212 | line-height:25px; | ||
| 213 | outline:none; | ||
| 214 | overflow:hidden; | ||
| 215 | border:none; | ||
| 216 | } | ||
| 217 | .controlPagination a.prevPagination , | ||
| 218 | .controlPagination a.noPrevPagination, | ||
| 219 | .controlPagination a.nextPagination, | ||
| 220 | .controlPagination a.noNextPagination { | ||
| 221 | background-image:url($xwiki.getSkinFile("navigation.png")); | ||
| 222 | width: 21px; | ||
| 223 | height: 22px; | ||
| 224 | } | ||
| 225 | .controlPagination a.prevPagination { | ||
| 226 | background-position:left top; | ||
| 227 | } | ||
| 228 | .controlPagination a.noPrevPagination{ | ||
| 229 | background-position:left bottom; | ||
| 230 | } | ||
| 231 | .controlPagination a.nextPagination { | ||
| 232 | background-position:right top; | ||
| 233 | left: 21px; | ||
| 234 | } | ||
| 235 | .controlPagination a.noNextPagination { | ||
| 236 | background-position:right bottom; | ||
| 237 | left: 21px; | ||
| 238 | } | ||
| 239 | {code} | ||
| 240 | |||
| 241 | 1.1.1 HTML Code | ||
| 242 | |||
| 243 | {code} | ||
| 244 | <div class="paginationFooter"> | ||
| 245 | <div class="paginationFilter"> | ||
| 246 | <span class="controlPagination"> | ||
| 247 | <a href="#" title="$msg.get('xe.pagination.page.prev.title')" class="noPrevPagination"></a> | ||
| 248 | <a href="#" title="$msg.get('xe.pagination.page.next.title')" class="noNextPagination"></a> | ||
| 249 | </span> | ||
| 250 | <span class="pagination"> | ||
| 251 | $msg.get("xe.pagination.page") | ||
| 252 | <a href="" title="$msg.get('xe.pagination.page.title',['1'])">1</a> | ||
| 253 | <a href="" class="currentPagination" title="$msg.get('xe.pagination.page.title',['2'])">2</a> | ||
| 254 | <a href="" title="$msg.get('xe.pagination.page.title',['3'])">3</a> | ||
| 255 | <a href="" title="$msg.get('xe.pagination.page.title',['4'])">4</a> | ||
| 256 | <a href="" title="$msg.get('xe.pagination.page.title',['5'])">5</a> | ||
| 257 | <a href="" title="$msg.get('xe.pagination.page.title',['6'])">6</a> | ||
| 258 | <a href="" title="$msg.get('xe.pagination.page.title',['7'])">7</a> | ||
| 259 | <a href="" title="$msg.get('xe.pagination.page.title',['8'])">8</a> | ||
| 260 | <a href="" title="$msg.get('xe.pagination.page.title',['9'])">9</a> | ||
| 261 | </span> | ||
| 262 | </div> | ||
| 263 | </div> | ||
| 264 | {code} | ||
| 265 | |||
| 266 | 1.1 <span id="dependencies"> Dependencies</span> | ||
| 267 | |||
| 268 | 1.1.1 Icons | ||
| 269 | |||
| 270 | navigation.png | ||
| 271 | |||
| 272 | {image:navigation.png} | ||
| 273 | |||
| 274 | 1.1.1 Translations | ||
| 275 | |||
| 276 | 1.1.1.1 Sort Translations | ||
| 277 | |||
| 278 | xe.search.filters.sort=Sort: | ||
| 279 | |||
| 280 | xe.search.filters.relevance=Relevance | ||
| 281 | |||
| 282 | xe.search.filters.relevance.title=Sort by Relevance | ||
| 283 | |||
| 284 | xe.search.filters.date=Date | ||
| 285 | |||
| 286 | xe.search.filters.date.title=Sort by Date | ||
| 287 | |||
| 288 | xe.search.filters.rating=Rating | ||
| 289 | |||
| 290 | xe.search.filters.rating.title=Sort by Rating | ||
| 291 | |||
| 292 | xe.search.filters.popularity=Popularity | ||
| 293 | |||
| 294 | xe.search.filters.popularity.title=Sort by Popularity | ||
| 295 | |||
| 296 | 1.1.1.1 Navigation Translations | ||
| 297 | |||
| 298 | xe.pagination.results=Results | ||
| 299 | |||
| 300 | xe.pagination.results.of=out of | ||
| 301 | |||
| 302 | xe.pagination.page=Page | ||
| 303 | |||
| 304 | xe.pagination.page.title=Page {0} | ||
| 305 | |||
| 306 | xe.pagination.page.prev.title=Previous Page | ||
| 307 | |||
| 308 | xe.pagination.page.next.title=Next Page | ||
| 309 | |||
| 310 | 1.1 Velocity Macro | ||
| 311 | |||
| 312 | {code:none} | ||
| 313 | #pagination($parameters) | ||
| 314 | {code} | ||
| 315 | |||
| 316 | The macro is responsible for displaying browsing links, and does not involve the actual display of the browsed items. | ||
| 317 | |||
| 318 | It accepts a single argument, which in turn is a map of parameters: | ||
| 319 | <dl> | ||
| 320 | <dt>url</dt> | ||
| 321 | <dd>The base url of the document displaying the collection.</dd> | ||
| 322 | <dd>Default: \$doc.getURL('view')</dd> | ||
| 323 | <dt>totalItems</dt> | ||
| 324 | <dd>The total number number of items in the collection.</dd> | ||
| 325 | <dd>Default: none, this parameter is mandatory.</dd> | ||
| 326 | <dt>defaultItemsPerPage</dt> | ||
| 327 | <dd>The number of items per page. This value is overwritten by the request parameter "perPage", if it exists and | ||
| 328 | has a valid positive integer value.</dd> | ||
| 329 | <dd>Default: 20</dd> | ||
| 330 | <dt>position</dt> | ||
| 331 | <dd>The placement of the pagination widget. Supported values: "top", "bottom". The bottom widget only displays | ||
| 332 | pages, while the top widget also provides a information about the item range on the current page.</dd> | ||
| 333 | <dd>Default: top</dd> | ||
| 334 | <dt>itemParamName</dt> | ||
| 335 | <dd>The name of the request parameter for the index of the first displayed item.</dd> | ||
| 336 | <dd>Default: firstIndex</dd> | ||
| 337 | <dt>itemsPerPageParamName</dt> | ||
| 338 | <dd>The name of the request parameter for the number of items displayed on a page.</dd> | ||
| 339 | <dd>Default: perPage</dd> | ||
| 340 | </dl> | ||
| 341 | |||
| 342 | Usage example: | ||
| 343 | {code:none} | ||
| 344 | #set($paginationParameters = { | ||
| 345 | 'url' : $doc.getURL('view', "text=${query}"), | ||
| 346 | 'totalItems' : $searchresults.getHitcount(), | ||
| 347 | 'defaultItemsPerPage' : $defaultItemsPerPage, | ||
| 348 | 'position': 'top' | ||
| 349 | }) | ||
| 350 | #pagination($paginationParameters) | ||
| 351 | {code} | ||
| 352 | |||
| 353 | 1.1.1 Example | ||
| 354 | |||
| 355 | The pagination macro can be used for example to display the latest modifications of the current user: | ||
| 356 | |||
| 357 | {code:none} | ||
| 358 | #set($ok = $xwiki.jsfx.use("uicomponents/search/search.js", true)) | ||
| 359 | #set($ok = $xwiki.ssfx.use("uicomponents/search/search.css", true)) | ||
| 360 | ## | ||
| 361 | ## set display parameters for the list | ||
| 362 | ## | ||
| 363 | #set($defaultItemsPerPage = 10) | ||
| 364 | #set($orderClause = "order by doc.date desc") | ||
| 365 | #set($whereClause = "where 1=1 and doc.author='$context.user'") | ||
| 366 | #set($results_url = $doc.getURL('view')) | ||
| 367 | #set($totalItems = $xwiki.countDocuments($whereClause)) | ||
| 368 | #if($totalItems > 0) | ||
| 369 | ## ----------------- | ||
| 370 | ## Pagination (top) | ||
| 371 | ## ----------------- | ||
| 372 | #set($paginationParameters = {'url' : $results_url, 'totalItems' : $totalItems, 'defaultItemsPerPage' : $defaultItemsPerPage, 'position': 'top'}) | ||
| 373 | #pagination($paginationParameters) | ||
| 374 | ## ----------------- | ||
| 375 | ## Display results | ||
| 376 | ## ----------------- | ||
| 377 | #set($firstIndex = "$!{paginationParameters.firstItem}") | ||
| 378 | #if($firstIndex == '') | ||
| 379 | #set($firstIndex = "$!request.getParameter('firstIndex')") | ||
| 380 | #if($firstIndex == '') | ||
| 381 | #set($firstIndex = '0') | ||
| 382 | #end | ||
| 383 | #end | ||
| 384 | #set($firstIndex = $util.parseInt($firstIndex)) | ||
| 385 | #set($results = $xwiki.searchDocuments("$whereClause $orderClause", $defaultItemsPerPage, $firstIndex)) | ||
| 386 | #set ($list = $results) | ||
| 387 | #set ($isScored = false) | ||
| 388 | #includeInContext("XWiki.Results") | ||
| 389 | ## ----------------- | ||
| 390 | ## Pagination (bottom) | ||
| 391 | ## ----------------- | ||
| 392 | #set($paginationParameters.position = 'bottom') | ||
| 393 | #pagination($paginationParameters) | ||
| 394 | #end | ||
| 395 | {code} | ||
| 396 | |||
| 397 | #if(!$isGuest) | ||
| 398 | #set($ok = $xwiki.jsfx.use("uicomponents/search/search.js", true)) | ||
| 399 | #set($ok = $xwiki.ssfx.use("uicomponents/search/search.css", true)) | ||
| 400 | ## | ||
| 401 | ## set display parameters for the list | ||
| 402 | ## | ||
| 403 | #set($defaultItemsPerPage = 10) | ||
| 404 | #set($orderClause = "order by doc.date desc") | ||
| 405 | #set($whereClause = "where 1=1 and doc.author='$context.user'") | ||
| 406 | #set($results_url = $doc.getURL('view')) | ||
| 407 | #set($totalItems = $xwiki.countDocuments($whereClause)) | ||
| 408 | #if($totalItems > 0) | ||
| 409 | ## ----------------- | ||
| 410 | ## Pagination (top) | ||
| 411 | ## ----------------- | ||
| 412 | #set($paginationParameters = {'url' : $results_url, 'totalItems' : $totalItems, 'defaultItemsPerPage' : $defaultItemsPerPage, 'position': 'top'}) | ||
| 413 | #pagination($paginationParameters) | ||
| 414 | ## ----------------- | ||
| 415 | ## Display results | ||
| 416 | ## ----------------- | ||
| 417 | #set($firstIndex = "$!{paginationParameters.firstItem}") | ||
| 418 | #if($firstIndex == '') | ||
| 419 | #set($firstIndex = "$!request.getParameter('firstIndex')") | ||
| 420 | #if($firstIndex == '') | ||
| 421 | #set($firstIndex = '0') | ||
| 422 | #end | ||
| 423 | #end | ||
| 424 | #set($firstIndex = $util.parseInt($firstIndex)) | ||
| 425 | #set($results = $xwiki.searchDocuments("$whereClause $orderClause", $defaultItemsPerPage, $firstIndex)) | ||
| 426 | #set ($list = $results) | ||
| 427 | #set ($isScored = false) | ||
| 428 | #includeInContext("XWiki.Results") | ||
| 429 | ## ----------------- | ||
| 430 | ## Pagination (bottom) | ||
| 431 | ## ----------------- | ||
| 432 | #set($paginationParameters.position = 'bottom') | ||
| 433 | #pagination($paginationParameters) | ||
| 434 | #end | ||
| 435 | #end |
