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( boolean $defaultstyle = true, string $action = "" )` Constructor to create an instance of this class. Constructor to create an instance of this class. Parameters `$defaultstyle` `boolean` $defaultstyle [optional] use the default style for object initializing? `$action` `string` $action [optional]
`public`	# `setSortable( integer $key, boolean $sortable )` Sets the sortable flag for a specific row. Sets the sortable flag for a specific row. $obj->setSortable(true); Parameters `$key` `integer` $key `$sortable` `boolean` $sortable true or false
`public`	# `setCustom( string $key, string $custom )` Sets the custom parameters for sortable links. Sets the custom parameters for sortable links. $obj->setCustom($key, $custom); Parameters `$key` `string` $key Custom entry key `$custom` `string` $custom Custom entry value
`public`	# `onRenderRow( integer $row )` Is called when a new row is rendered. Is called when a new row is rendered. Parameters `$row` `integer` $row The current row which is being rendered
`public`	# `onRenderColumn( integer $column )` Is called when a new column is rendered. Is called when a new column is rendered. Parameters `$column` `integer` $column 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. SuppressWarnings docBlocks
`public`	# `setData( integer $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` `integer` $index Numeric index SuppressWarnings docBlocks
`public`	# `setHiddenData( integer $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` `integer` $index Numeric index SuppressWarnings docBlocks
`public`	# `setResultsPerPage( integer $numresults )` Sets the number of records per page. Sets the number of records per page. Parameters `$numresults` `integer` $numresults Amount of records per page
`public`	# `setListStart( integer $startpage )` Sets the starting page number. Sets the starting page number. Parameters `$startpage` `integer` $startpage Page number on which the list display starts
`public integer`	# `getCurrentPage( )` Returns the current page. Returns the current page. Returns `integer` Current page number
`public float`	# `getNumPages( )` Returns the amount of pages. Returns the amount of pages. Returns `float` Amount of pages
`public`	# `sort( integer $field, string\|integer $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` `integer` $field Field index `$order` `string\|integer` $order Sort order (see php's sort documentation)
`public string`	# `convert( integer $field, string $value, array $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` `integer` $field Field index `$value` `string` $value Field value `$hiddendata` `array` $hiddendata Returns `string`
`public string\|`	# `render( boolean $return = true )` Outputs or optionally returns. Outputs or optionally returns. Parameters `$return` `boolean` $return [optional] If true, returns the list Returns `string\|`

Properties summary
`public array`	`$data`	`array()`	# Data container. Data container.
`public array`	`$header`	`array()`	# Header container. Header container.
`public string`	`$resultsPerPage`		# Number of records displayed per page. Number of records displayed per page.
`public string`	`$listStart`		# Start page. Start page.
`public string`	`$sortable`		# sortable flag sortable flag
`public cHTMLLink`	`$sortlink`		# sortlink sortlink
`public cHTMLTable`	`$objTable`		# Table item Table item
`public cHTMLTableRow`	`$objHeaderRow`		# Header row Header row
`public cHTMLTableHead`	`$objHeaderItem`		# Header item Header item
`public cHTMLTableRow`	`$objRow`		# Header item Header item
`public cHTMLTableData`	`$objItem`		# Header item Header item
`public string`	`$sortkey`		#
`public integer`	`$sortmode`		# SORT_ASC or SORT_DESC SORT_ASC or SORT_DESC