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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
<?php
/**
* TLiteralColumn class file
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link https://github.com/pradosoft/prado
* @copyright Copyright © 2005-2016 The PRADO Group
* @license https://github.com/pradosoft/prado/blob/master/COPYRIGHT
* @package System.Web.UI.WebControls
*/
/**
* TDataGridColumn class file
*/
Prado::using('System.Web.UI.WebControls.TDataGridColumn');
/**
* TLiteralColumn class
*
* TLiteralColumn represents a static text column that is bound to a field in a data source.
* The cells in the column will be displayed with static texts using the data indexed by
* {@link setDataField DataField}. You can customize the display by
* setting {@link setDataFormatString DataFormatString}.
*
* If {@link setDataField DataField} is not specified, the cells will be filled
* with {@link setText Text}.
*
* If {@link setEncode Encode} is true, the static texts will be HTML-encoded.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package System.Web.UI.WebControls
* @since 3.0.5
*/
class TLiteralColumn 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 string the formatting string used to control how the bound data will be displayed.
*/
public function getDataFormatString()
{
return $this->getViewState('DataFormatString','');
}
/**
* @param string the formatting string used to control how the bound data will be displayed.
*/
public function setDataFormatString($value)
{
$this->setViewState('DataFormatString',$value,'');
}
/**
* @return string static text to be displayed in the column. Defaults to empty.
*/
public function getText()
{
return $this->getViewState('Text','');
}
/**
* @param string static text to be displayed in the column.
*/
public function setText($value)
{
$this->setViewState('Text',$value,'');
}
/**
* @return boolean whether the rendered text should be HTML-encoded. Defaults to false.
*/
public function getEncode()
{
return $this->getViewState('Encode',false);
}
/**
* @param boolean whether the rendered text should be HTML-encoded.
*/
public function setEncode($value)
{
$this->setViewState('Encode',TPropertyValue::ensureBoolean($value),false);
}
/**
* Initializes the specified cell to its initial values.
* This method overrides the parent implementation.
* @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::EditItem || $itemType===TListItemType::SelectedItem)
{
if($this->getDataField()!=='')
{
$cell->attachEventHandler('OnDataBinding',array($this,'dataBindColumn'));
} else {
$text=$this->getText();
if($this->getEncode())
$text=THttpUtility::htmlEncode($text);
$cell->setText($text);
}
}
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();
$formatString=$this->getDataFormatString();
if(($field=$this->getDataField())!=='')
$value=$this->formatDataValue($formatString,$this->getDataFieldValue($data,$field));
else
$value=$this->formatDataValue($formatString,$data);
if($sender instanceof TTableCell)
{
if($this->getEncode())
$value=THttpUtility::htmlEncode($value);
$sender->setText($value);
}
}
}
|
