API16

JPagination: Difference between revisions

From Joomla! Documentation

Batch1211 (talk | contribs)
No edit summary
Batch1211 (talk | contribs)
Replacing page with ' <dpl> category=JPagination category=CodeExample category=ClassExample </dpl>'
Line 1: Line 1:
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JPagination|Edit Descripton]]<nowiki>]</nowiki>
</span>
{{Description:JPagination}}


===Defined in===
libraries/joomla/html/pagination.php
===Methods===
{| class="wikitable sortable"
|-
!Method name
!Description
|-
|[[API16:JPagination/__construct|__construct]]
|Constructor.
|-
|[[API16:JPagination/setAdditionalUrlParam|setAdditionalUrlParam]]
|Method to set an additional URL parameter to be added to all pagination class generated links.
|-
|[[API16:JPagination/getAdditionalUrlParam|getAdditionalUrlParam]]
|Method to get an additional URL parameter to be added to all pagination class generated links if it exists.
|-
|[[API16:JPagination/getRowOffset|getRowOffset]]
|Return the rationalised offset for a row with a given index.
|-
|[[API16:JPagination/getData|getData]]
|Return the pagination data object, only creating it if it doesn't already exist.
|-
|[[API16:JPagination/getPagesCounter|getPagesCounter]]
|Create and return the pagination pages counter string, ie. Page 2 of 4.
|-
|[[API16:JPagination/getResultsCounter|getResultsCounter]]
|Create and return the pagination result set counter string, ie. Results 1-10 of 42
|-
|[[API16:JPagination/getPagesLinks|getPagesLinks]]
|Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x.
|-
|[[API16:JPagination/getListFooter|getListFooter]]
|Return the pagination footer.
|-
|[[API16:JPagination/getLimitBox|getLimitBox]]
|Creates a dropdown box for selecting how many records to show per page.
|-
|[[API16:JPagination/orderUpIcon|orderUpIcon]]
|Return the icon to move an item UP.
|-
|[[API16:JPagination/orderDownIcon|orderDownIcon]]
|Return the icon to move an item DOWN.
|}
===Importing===
<source lang="php">jimport( 'joomla.html.pagination' );</source>
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JPagination|Edit See Also]]<nowiki>]</nowiki>
</span>
{{SeeAlso:JPagination}}
===Examples===
<CodeExamplesForm />
<dpl>
<dpl>
noresultsheader=\n
  category=JPagination
  category=JPagination
  category=CodeExample
  category=CodeExample
  category=ClassExample
  category=ClassExample
include=*
format= ,,,
</dpl>
</dpl>

Revision as of 08:17, 24 October 2010