1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
<?php
/**
* TCheckBoxColumn class file
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Web\UI\WebControls
*/
namespace Prado\Web\UI\WebControls;
use Prado\TPropertyValue;
/**
* TCheckBoxColumn class
*
* 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:
* <code>
* $datagridItem->CheckBoxColumnID->CheckBox
* $datagridItem->CheckBoxColumnID->Controls[0]
* </code>
* The second method is possible because the checkbox control created within the
* datagrid cell is the first child.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package Prado\Web\UI\WebControls
* @since 3.0
*/
class TCheckBoxColumn extends TDataGridColumn
{
/**
* @return string the field name from the data source to bind to the column
*/
public function getDataField()
{
return $this->getViewState('DataField','');
}
/**
* @param string the field name from the data source to bind to the column
*/
public function setDataField($value)
{
$this->setViewState('DataField',$value,'');
}
/**
* @return boolean whether the items in the column can be edited. Defaults to false.
*/
public function getReadOnly()
{
return $this->getViewState('ReadOnly',false);
}
/**
* @param boolean whether the items in the column can be edited
*/
public function setReadOnly($value)
{
$this->setViewState('ReadOnly',TPropertyValue::ensureBoolean($value),false);
}
/**
* Initializes the specified cell to its initial values.
* 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.
* @param TTableCell the cell to be initialized.
* @param integer the index to the Columns property that the cell resides in.
* @param string the type of cell (Header,Footer,Item,AlternatingItem,EditItem,SelectedItem)
*/
public function initializeCell($cell,$columnIndex,$itemType)
{
if($itemType===TListItemType::Item || $itemType===TListItemType::AlternatingItem || $itemType===TListItemType::SelectedItem || $itemType===TListItemType::EditItem)
{
$checkBox=new TCheckBox;
if($this->getReadOnly() || $itemType!==TListItemType::EditItem)
$checkBox->setEnabled(false);
$cell->setHorizontalAlign('Center');
$cell->getControls()->add($checkBox);
$cell->registerObject('CheckBox',$checkBox);
if($this->getDataField()!=='')
$checkBox->attachEventHandler('OnDataBinding',array($this,'dataBindColumn'));
}
else
parent::initializeCell($cell,$columnIndex,$itemType);
}
/**
* Databinds a cell in the column.
* This method is invoked when datagrid performs databinding.
* It populates the content of the cell with the relevant data from data source.
*/
public function dataBindColumn($sender,$param)
{
$item=$sender->getNamingContainer();
$data=$item->getData();
if(($field=$this->getDataField())!=='')
$value=TPropertyValue::ensureBoolean($this->getDataFieldValue($data,$field));
else
$value=TPropertyValue::ensureBoolean($data);
if($sender instanceof TCheckBox)
$sender->setChecked($value);
}
}
|
