API15

JPagination: Difference between revisions

From Joomla! Documentation

Batch1211 (talk | contribs)
No edit summary
Batch1211 (talk | contribs)
No edit summary
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
|-
|[[API15:JPagination/__construct|
__construct]]
|Constructor
|-
|[[API15:JPagination/getRowOffset|
getRowOffset]]
|Return the rationalised offset for
a row with a given index.
|-
|[[API15:JPagination/getData|
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/getResultsCounte
r|getResultsCounter]]
|Create and return the pagination
result set counter string, ie.
Results 1-10 of 42
|-
|[[API15:JPagination/getPagesLinks|
getPagesLinks]]
|Create and return the pagination
page list string, ie. Previous,
Next, 1 2 3 ... x
|-
|[[API15:JPagination/getListFooter|
getListFooter]]
|Return the pagination footer
|-
|[[API15:JPagination/getLimitBox|
getLimitBox]]
|Creates a dropdown box for
selecting how many records to show
per page
|-
|[[API15:JPagination/orderUpIcon|
orderUpIcon]]
|Return the icon to move an item UP
|-
|[[API15: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>
  category=JPagination
  category=JPagination

Revision as of 08:17, 24 October 2010

[

Edit Descripton] Template:Description:JPagination

Defined in

libraries/joomla/html/pagination.php

Methods

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

[[API15:JPagination/getResultsCounte

r|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

jimport( 

'joomla.html.pagination' );

[

Edit See Also] Template:SeeAlso:JPagination

Examples

<CodeExamplesForm />