TPageNavigation
in package
Page Navigation provides navigation for a datagrid
Tags
Table of Contents
Properties
- $action : mixed
- $count : mixed
- $direction : mixed
- $first_page : mixed
- $hidden : mixed
- $limit : mixed
- $order : mixed
- $page : mixed
- $resume : mixed
- $width : mixed
Methods
- __construct() : mixed
- Constructor method
- enableCounters() : mixed
- Enable counters
- getCount() : mixed
- Return the total count of records
- getLimit() : mixed
- Returns the limit of records
- getPage() : mixed
- Returns the current page
- hide() : mixed
- Hide
- setAction() : mixed
- Define the PageNavigation action
- setCount() : mixed
- Define the total count of records
- setDirection() : mixed
- Define the ordering
- setFirstPage() : mixed
- Define the first page
- setLimit() : mixed
- Set the Amount of displayed records
- setOrder() : mixed
- Define the ordering
- setPage() : mixed
- Define the current page
- setProperties() : mixed
- Set the page navigation properties
- setWidth() : mixed
- Define the PageNavigation's width
- show() : mixed
- Show the PageNavigation widget
- getResume() : mixed
- Get resume string
Properties
$action
private
mixed
$action
$count
private
mixed
$count
$direction
private
mixed
$direction
$first_page
private
mixed
$first_page
$hidden
private
mixed
$hidden
$limit
private
mixed
$limit
$order
private
mixed
$order
$page
private
mixed
$page
$resume
private
mixed
$resume
$width
private
mixed
$width
Methods
__construct()
Constructor method
public
__construct() : mixed
enableCounters()
Enable counters
public
enableCounters() : mixed
getCount()
Return the total count of records
public
getCount() : mixed
getLimit()
Returns the limit of records
public
getLimit() : mixed
getPage()
Returns the current page
public
getPage() : mixed
hide()
Hide
public
hide() : mixed
setAction()
Define the PageNavigation action
public
setAction(mixed $action) : mixed
Parameters
- $action : mixed
-
TAction object (fired when the user navigates)
setCount()
Define the total count of records
public
setCount(mixed $count) : mixed
Parameters
- $count : mixed
-
An integer (the total count of records)
setDirection()
Define the ordering
public
setDirection(mixed $direction) : mixed
Parameters
- $direction : mixed
-
asc, desc
setFirstPage()
Define the first page
public
setFirstPage(mixed $first_page) : mixed
Parameters
- $first_page : mixed
setLimit()
Set the Amount of displayed records
public
setLimit(mixed $limit) : mixed
Parameters
- $limit : mixed
-
An integer
setOrder()
Define the ordering
public
setOrder(mixed $order) : mixed
Parameters
- $order : mixed
-
A string containint the column name
setPage()
Define the current page
public
setPage(mixed $page) : mixed
Parameters
- $page : mixed
-
An integer (the current page)
setProperties()
Set the page navigation properties
public
setProperties(mixed $properties) : mixed
Parameters
- $properties : mixed
-
array of properties
setWidth()
Define the PageNavigation's width
public
setWidth(mixed $width) : mixed
Parameters
- $width : mixed
-
PageNavigation's width
show()
Show the PageNavigation widget
public
show() : mixed
getResume()
Get resume string
private
getResume() : mixed