Class ScrollableList Class for scrollable backend lists
TODOBackendList()
cScrollList($defaultstyle, $action)
inherited_from | \cScrollList::cScrollList() |
---|
boolean use the default style for object initializing?
convert($key, $value, $hidden)
Needs to be overridden in the child class to work properbly.
Field value
getCurrentPage()
returns | Current page number |
---|---|
inherited_from | \cScrollList::getCurrentPage() |
getNumPages()
returns | Amount of pages |
---|---|
inherited_from | \cScrollList::getNumPages() |
onRenderColumn($column)
onRenderRow($row)
inherited_from | \cScrollList::onRenderRow() |
---|
The current row which is being rendered
render($return)
inherited_from | \cScrollList::render() |
---|
If true, returns the list
setCustom($key, $custom)
$obj->setCustom($key, $custom);
inherited_from | \cScrollList::setCustom() |
---|
Custom entry key
Custom entry value
setData($index)
Note: This function eats as many parameters as you specify.
Example: $obj->setData(0, "foo", "bar");
Make sure that the amount of parameters stays the same for all setData calls in a single object. Also make sure that your index starts from 0 and ends with the actual number - 1.
inherited_from | \cScrollList::setData() |
---|
Numeric index
setHeader()
Note: This function eats as many parameters as you specify.
Example: $obj->setHeader("foo", "bar");
Make sure that the amount of parameters stays the same for all setData calls in a single object.
inherited_from | \cScrollList::setHeader() |
---|
setHiddenData($index)
Note: This function eats as many parameters as you specify.
Example: $obj->setHiddenData(0, "foo", "bar");
Make sure that the amount of parameters stays the same for all setData calls in a single object. Also make sure that your index starts from 0 and ends with the actual number - 1.
inherited_from | \cScrollList::setHiddenData() |
---|
Numeric index
setListStart($startpage)
inherited_from | \cScrollList::setListStart() |
---|
Page number on which the list display starts
setResultsPerPage($numresults)
inherited_from | \cScrollList::setResultsPerPage() |
---|
Amount of records per page
setSortable($key, $sortable)
$obj->setSortable(true);
inherited_from | \cScrollList::setSortable() |
---|
boolean true or false
sort($field, $order)
inherited_from | \cScrollList::sort() |
---|
Field index
Sort order (see php's sort documentation)
$data : array
inherited_from | \cScrollList::$$data |
---|
$header : array
inherited_from | \cScrollList::$$header |
---|
$listStart : string
inherited_from | \cScrollList::$$listStart |
---|
$objHeaderItem
inherited_from | \cScrollList::$$objHeaderItem |
---|
$objHeaderRow
inherited_from | \cScrollList::$$objHeaderRow |
---|
$objItem
inherited_from | \cScrollList::$$objItem |
---|
$objRow
inherited_from | \cScrollList::$$objRow |
---|
$objTable
inherited_from | \cScrollList::$$objTable |
---|
$resultsPerPage : string
inherited_from | \cScrollList::$$resultsPerPage |
---|
$sortable : string
inherited_from | \cScrollList::$$sortable |
---|
$sortlink : string
inherited_from | \cScrollList::$$sortlink |
---|
$statustypes