PHP Class Prado\Web\UI\WebControls\TBaseDataList

TBaseDataList is the base class for data listing controls, including {@link TDataList} and {@link TDataGrid}. The key field in the data source is specified by {@link setKeyField KeyField}, while {@link getKeyValues KeyValues} stores the key values of each record in a data listing control. You may use the list item index to obtain the corresponding database key value. TBaseDataList also implements a few properties used for presentation based on tabular layout. The {@link setCaption Caption}, whose alignment is specified via {@link setCaptionAlign CaptionAlign}, is rendered as the table caption. The table cellpadding and cellspacing are specified by {@link setCellPadding CellPadding} and {@link setCellSpacing CellSpacing} properties, respectively. The {@link setGridLines GridLines} specifies how the table should display its borders, and the horizontal alignment of the table content can be specified via {@link setHorizontalAlign HorizontalAlign}.

Since: 3.0

Author: Qiang Xue ([email protected])

Inheritance: extends TDataBoundControl

Show file Open project: pradosoft/prado Class Usage Examples

Public Methods

Method	Description
getCellPadding ( ) : integer
getCellSpacing ( ) : integer
getDataKeyField ( ) : string
getDataKeys ( ) : Prado\Collections\TList
getGridLines ( ) : TTableGridLines
getHorizontalAlign ( ) : THorizontalAlign
onSelectedIndexChanged ( $param )	Raises OnSelectedIndexChanged event.
setCellPadding ( $value )
setCellSpacing ( $value )
setDataKeyField ( $value )
setGridLines ( $value )	Sets the grid line style of the table layout.
setHorizontalAlign ( $value )

Protected Methods

Method	Description
createStyle ( ) : TTableStyle	Creates a style object for the control.
getDataFieldValue ( $data, $field ) : mixed	Returns the value of the data at the specified field.

Method Details

createStyle() protected method

This method creates a {@link TTableStyle} to be used by the data list control.

protected createStyle ( ) : TTableStyle
return	TTableStyle	control style to be used

getCellPadding() public method

public getCellPadding ( ) : integer
return	integer	the cellpadding for the table layout. Defaults to -1, meaning not set.

getCellSpacing() public method

public getCellSpacing ( ) : integer
return	integer	the cellspacing for the table layout. Defaults to -1, meaning not set.

getDataFieldValue() protected method

If data is an array, TMap or TList, the value will be returned at the index of the specified field. If the data is a component with a property named as the field name, the property value will be returned. Otherwise, an exception will be raised.

protected getDataFieldValue ( $data, $field ) : mixed
return	mixed	data value at the specified field

getDataKeyField() public method

public getDataKeyField ( ) : string
return	string	the field of the data source that provides the keys of the list items.

getDataKeys() public method

public getDataKeys ( ) : Prado\Collections\TList
return	Prado\Collections\TList	the keys used in the data listing control.

getGridLines() public method

public getGridLines ( ) : TTableGridLines
return	TTableGridLines	the grid line setting of the table layout. Defaults to TTableGridLines::None.

getHorizontalAlign() public method

public getHorizontalAlign ( ) : THorizontalAlign
return	THorizontalAlign	the horizontal alignment of the table content. Defaults to THorizontalAlign::NotSet.

onSelectedIndexChanged() public method

This method is invoked when a different item is selected in a data listing control between posts to the server.

public onSelectedIndexChanged ( $param )

setCellPadding() public method

public setCellPadding ( $value )

setCellSpacing() public method

public setCellSpacing ( $value )

setDataKeyField() public method

public setDataKeyField ( $value )

setGridLines() public method

Sets the grid line style of the table layout.

public setGridLines ( $value )

setHorizontalAlign() public method

public setHorizontalAlign ( $value )