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( $defaultstyle = true, $action = "" )` Creates a new FrontendList object. Creates a new FrontendList object. Parameters `$defaultstyle` use the default style for object initializing? `$action`
`public`	# `setSortable( $key, $sortable )` Sets the sortable flag for a specific row. Sets the sortable flag for a specific row. $obj->setSortable(true); Parameters `$key` true or false `$sortable`
`public`	# `setCustom( $key, $custom )` Sets the custom parameters for sortable links Sets the custom parameters for sortable links $obj->setCustom($key, $custom); Parameters `$key` entry key `$custom` entry value
`public`	# `onRenderRow( $row )` Is called when a new row is rendered Is called when a new row is rendered Parameters `$row` current row which is being rendered
`public`	# `onRenderColumn( $column )` Is called when a new column is rendered Is called when a new column is rendered Parameters `$column` current column which is being rendered
`public`	# `setHeader( $index,… )` 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. Parameters `$index`,… index
`public`	# `setData( $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` Numeric index
`public`	# `setHiddenData( $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` Numeric index
`public`	# `setResultsPerPage( $numresults )` Sets the number of records per page. Sets the number of records per page. Parameters `$numresults` Amount of records per page
`public`	# `setListStart( $startpage )` Sets the starting page number. Sets the starting page number. Parameters `$startpage` Page number on which the list display starts
`public s`	# `getCurrentPage( $none,… )` Returns the current page. Returns the current page. Parameters `$none`,… Returns s Current page number
`public s`	# `getNumPages( $none,… )` Returns the amount of pages. Returns the amount of pages. Parameters `$none`,… Returns s Amount of pages
`public`	# `sort( $field, $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` Field index `$order` Sort order (see php's sort documentation)
`public`	# `convert( $field, $value, $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` index `$value` value `$hiddendata`
`public`	# `render( $return = true )` Outputs or optionally returns Outputs or optionally returns Parameters `$return` true, returns the list

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