PHP Class Prado\Web\UI\WebControls\TCheckBoxColumn

TCheckBoxColumn represents a checkbox column that is bound to a field in a data source. The checked state of the checkboxes are determiend by the bound data at {@link setDataField DataField}. If {@link setReadOnly ReadOnly} is false, TCheckBoxColumn will display an enabled checkbox provided the cells are in edit mode. Otherwise, the checkboxes will be disabled to prevent from editting. The checkbox control in the TCheckBoxColumn can be accessed by one of the following two methods:


$datagridItem->CheckBoxColumnID->CheckBox
$datagridItem->CheckBoxColumnID->Controls[0]

The second method is possible because the checkbox control created within the datagrid cell is the first child.

Since: 3.0

Author: Qiang Xue ([email protected])

Inheritance: extends TDataGridColumn

Exibir arquivo Open project: pradosoft/prado Class Usage Examples

Public Methods

Method	Description
dataBindColumn ( $sender, $param )	Databinds a cell in the column.
getDataField ( ) : string
getReadOnly ( ) : boolean
initializeCell ( $cell, $columnIndex, $itemType )	Initializes the specified cell to its initial values.
setDataField ( $value )
setReadOnly ( $value )

Method Details

dataBindColumn() public method

This method is invoked when datagrid performs databinding. It populates the content of the cell with the relevant data from data source.

public dataBindColumn ( $sender, $param )

getDataField() public method

public getDataField ( ) : string
return	string	the field name from the data source to bind to the column

getReadOnly() public method

public getReadOnly ( ) : boolean
return	boolean	whether the items in the column can be edited. Defaults to false.

initializeCell() public method

This method overrides the parent implementation. It creates a checkbox inside the cell. If the column is read-only or if the item is not in edit mode, the checkbox will be set disabled.

public initializeCell ( $cell, $columnIndex, $itemType )

setDataField() public method

public setDataField ( $value )

setReadOnly() public method

public setReadOnly ( $value )