Class cGuiScrollList

Scrollable lists GUI class

Direct known subclasses

cGuiScrollListAlltranslations, TODOBackendList

Package: Core\GUI
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Mischa Holz
Located at classes/gui/class.scrolllist.php

Methods summary
`public`	# `__construct( mixed $defaultstyle = true, mixed $action = "" )` Creates a new FrontendList object. Creates a new FrontendList object. Parameters `$defaultstyle` `mixed` $defaultstyle boolean use the default style for object initializing? `$action`
`public`	# `setSortable( mixed $key, mixed $sortable )` Sets the sortable flag for a specific row. Sets the sortable flag for a specific row. $obj->setSortable(true); Parameters `$key` `mixed` $sortable boolean true or false `$sortable`
`public`	# `setCustom( mixed $key, mixed $custom )` Sets the custom parameters for sortable links Sets the custom parameters for sortable links $obj->setCustom($key, $custom); Parameters `$key` `mixed` $key Custom entry key `$custom` `mixed` $custom Custom entry value
`public`	# `onRenderRow( mixed $row )` Is called when a new row is rendered Is called when a new row is rendered Parameters `$row` `mixed` $row The current row which is being rendered
`public`	# `onRenderColumn( mixed $column )` Is called when a new column is rendered Is called when a new column is rendered Parameters `$column` `mixed` $row The current column which is being rendered
`public`	# `setHeader( )` Sets header data. Sets header data. Note: This public 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.
`public`	# `setData( mixed $index )` Sets data. Sets data. Note: This public 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. Parameters `$index` `mixed` $index int Numeric index
`public`	# `setHiddenData( mixed $index )` Sets hidden data. Sets hidden data. Note: This public 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. Parameters `$index` `mixed` $index int Numeric index
`public`	# `setResultsPerPage( mixed $numresults )` Sets the number of records per page. Sets the number of records per page. Parameters `$numresults` `mixed` $numresults int Amount of records per page
`public`	# `setListStart( mixed $startpage )` Sets the starting page number. Sets the starting page number. Parameters `$startpage` `mixed` $startpage int Page number on which the list display starts
`public s`	# `getCurrentPage( )` Returns the current page. Returns the current page. Returns `s` Current page number
`public s`	# `getNumPages( )` Returns the amount of pages. Returns the amount of pages. Returns `s` Amount of pages
`public`	# `sort( mixed $field, mixed $order )` Sorts the list by a given field and a given order. Sorts the list by a given field and a given order. Parameters `$field` `mixed` $field int Field index `$order` `mixed` $order string\|int Sort order (see php's sort documentation)
`public`	# `convert( mixed $field, mixed $value, mixed $hiddendata )` Field converting facility. Needs to be overridden in the child class to work properbly. Field converting facility. Needs to be overridden in the child class to work properbly. Parameters `$field` `mixed` $field Field index `$value` `mixed` $value Field value `$hiddendata`
`public`	# `render( mixed $return = true )` Outputs or optionally returns Outputs or optionally returns Parameters `$return` `mixed` $return If true, returns the list

Properties summary
`public array`	`$data`	`Array()`	# Data container Data container Public array
`public array`	`$header`	`Array()`	# Header container Header container Public array
`public mixed`	`$resultsPerPage`		# Number of records displayed per page Number of records displayed per page Public string
`public mixed`	`$listStart`		# Start page Start page Public string
`public mixed`	`$sortable`		# sortable flag sortable flag Public string
`public mixed`	`$sortlink`		# sortlink sortlink Public string
`public mixed`	`$objTable`		# Table item Table item
`public mixed`	`$objHeaderRow`		# Header row Header row
`public mixed`	`$objHeaderItem`		# Header item Header item
`public mixed`	`$objRow`		# Header item Header item
`public mixed`	`$objItem`		# Header item Header item