Difference between revisions of "JPagination"
From Joomla! Documentation
Line 18: | Line 18: | ||
!Description | !Description | ||
|- | |- | ||
− | |[[API15:JPagination/__construct| | + | |[[API15:JPagination/__construct|__construct]] |
− | |||
− | __construct]] | ||
|Constructor | |Constructor | ||
|- | |- | ||
− | |[[API15:JPagination/getRowOffset| | + | |[[API15:JPagination/getRowOffset|getRowOffset]] |
− | + | |Return the rationalised offset for a row with a given index. | |
− | getRowOffset]] | ||
− | |Return the rationalised offset for | ||
− | |||
− | a row with a given index. | ||
|- | |- | ||
− | |[[API15:JPagination/getData| | + | |[[API15:JPagination/getData|getData]] |
− | + | |Return the pagination data object, only creating it if it doesn't already exist | |
− | getData]] | ||
− | |Return the pagination data object, | ||
− | |||
− | only creating it if it doesn't | ||
− | |||
− | already exist | ||
|- | |- | ||
− | | | + | |[[API15:JPagination/getPagesCounter|getPagesCounter]] |
− | + | |Create and return the pagination pages counter string, ie. Page 2 of 4 | |
− | [[API15:JPagination/getPagesCounter| | ||
− | |||
− | getPagesCounter]] | ||
− | |Create and return the pagination | ||
− | |||
− | pages counter string, ie. Page 2 of | ||
− | |||
− | 4 | ||
|- | |- | ||
− | | | + | |[[API15:JPagination/getResultsCounter|getResultsCounter]] |
− | + | |Create and return the pagination result set counter string, ie. Results 1-10 of 42 | |
− | [[API15:JPagination/ | ||
− | |||
− | |||
− | |Create and return the pagination | ||
− | |||
− | result set counter string, ie. | ||
− | |||
− | Results 1-10 of 42 | ||
|- | |- | ||
− | |[[API15:JPagination/getPagesLinks| | + | |[[API15:JPagination/getPagesLinks|getPagesLinks]] |
− | + | |Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x | |
− | getPagesLinks]] | ||
− | |Create and return the pagination | ||
− | |||
− | page list string, ie. Previous, | ||
− | |||
− | Next, 1 2 3 ... x | ||
|- | |- | ||
− | |[[API15:JPagination/getListFooter| | + | |[[API15:JPagination/getListFooter|getListFooter]] |
− | |||
− | getListFooter]] | ||
|Return the pagination footer | |Return the pagination footer | ||
|- | |- | ||
− | |[[API15:JPagination/getLimitBox| | + | |[[API15:JPagination/getLimitBox|getLimitBox]] |
− | + | |Creates a dropdown box for selecting how many records to show per page | |
− | getLimitBox]] | ||
− | |Creates a dropdown box for | ||
− | |||
− | selecting how many records to show | ||
− | |||
− | per page | ||
|- | |- | ||
− | |[[API15:JPagination/orderUpIcon| | + | |[[API15:JPagination/orderUpIcon|orderUpIcon]] |
− | |||
− | orderUpIcon]] | ||
|Return the icon to move an item UP | |Return the icon to move an item UP | ||
|- | |- | ||
− | |[[API15:JPagination/orderDownIcon| | + | |[[API15:JPagination/orderDownIcon|orderDownIcon]] |
− | + | |Return the icon to move an item DOWN | |
− | orderDownIcon]] | ||
− | |Return the icon to move an item | ||
− | |||
− | DOWN | ||
|} | |} | ||
===Importing=== | ===Importing=== | ||
− | <source lang="php">jimport( | + | <source lang="php">jimport( 'joomla.html.pagination' );</source> |
− | |||
− | 'joomla.html.pagination' );</source> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | Also]]<nowiki>]</nowiki> | + | <span class="editsection" style="font-size:76%;"><nowiki>[</nowiki>[[SeeAlso:JPagination|Edit See Also]]<nowiki>]</nowiki>>/span> |
− | |||
{{SeeAlso:JPagination}} | {{SeeAlso:JPagination}} | ||
Revision as of 03:20, 24 October 2010
The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
[
Edit Descripton] Template:Description:JPagination
Defined in[edit]
libraries/joomla/html/pagination.php
Methods[edit]
Method name | Description |
---|---|
__construct | Constructor |
getRowOffset | Return the rationalised offset for a row with a given index. |
getData | Return the pagination data object, only creating it if it doesn't already exist |
getPagesCounter | Create and return the pagination pages counter string, ie. Page 2 of 4 |
getResultsCounter | Create and return the pagination result set counter string, ie. Results 1-10 of 42 |
getPagesLinks | Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x |
getListFooter | Return the pagination footer |
getLimitBox | Creates a dropdown box for selecting how many records to show per page |
orderUpIcon | Return the icon to move an item UP |
orderDownIcon | Return the icon to move an item DOWN |
Importing[edit]
jimport( 'joomla.html.pagination' );
[Edit See Also]>/span> Template:SeeAlso:JPagination
Examples[edit]
<CodeExamplesForm />