blob: ec6be86624cb535456ec6b449f32e98eebd41f80 (
plain)
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
<?php
/**
* TListItem 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\Collections\TAttributeCollection;
use Prado\Collections\TMap;
use Prado\TPropertyValue;
/**
* TListItem class.
*
* TListItem represents an item in a list control. Each item has a {@link setText Text}
* property and a {@link setValue Value} property. If either one of them is not set,
* it will take the value of the other property.
* An item can be {@link setSelected Selected} or {@link setEnabled Enabled},
* and it can have additional {@link getAttributes Attributes} which may be rendered
* if the list control supports so.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package Prado\Web\UI\WebControls
* @since 3.0
*/
class TListItem extends \Prado\TComponent
{
/**
* @var TMap list of custom attributes
*/
private $_attributes=null;
/**
* @var string text of the item
*/
private $_text;
/**
* @var string value of the item
*/
private $_value;
/**
* @var boolean whether the item is enabled
*/
private $_enabled;
/**
* @var boolean whether the item is selected
*/
private $_selected;
/**
* Constructor.
* @param string text of the item
* @param string value of the item
* @param boolean whether the item is enabled
* @param boolean whether the item is selected
*/
public function __construct($text='',$value='',$enabled=true,$selected=false)
{
$this->setText($text);
$this->setValue($value);
$this->setEnabled($enabled);
$this->setSelected($selected);
}
/**
* @return boolean whether the item is enabled
*/
public function getEnabled()
{
return $this->_enabled;
}
/**
* @param boolean whether the item is enabled
*/
public function setEnabled($value)
{
$this->_enabled=TPropertyValue::ensureBoolean($value);
}
/**
* @return boolean whether the item is selected
*/
public function getSelected()
{
return $this->_selected;
}
/**
* @param boolean whether the item is selected
*/
public function setSelected($value)
{
$this->_selected=TPropertyValue::ensureBoolean($value);
}
/**
* @return string text of the item
*/
public function getText()
{
return $this->_text===''?$this->_value:$this->_text;
}
/**
* @param string text of the item
*/
public function setText($value)
{
$this->_text=TPropertyValue::ensureString($value);
}
/**
* @return string value of the item
*/
public function getValue()
{
return $this->_value===''?$this->_text:$this->_value;
}
/**
* @param string value of the item
*/
public function setValue($value)
{
$this->_value=TPropertyValue::ensureString($value);
}
/**
* @return TAttributeCollection custom attributes
*/
public function getAttributes()
{
if(!$this->_attributes)
$this->_attributes=new TAttributeCollection;
return $this->_attributes;
}
/**
* @return boolean whether the item has any custom attribute
*/
public function getHasAttributes()
{
return $this->_attributes && $this->_attributes->getCount()>0;
}
/**
* @param string name of the attribute
* @return boolean whether the named attribute exists
*/
public function hasAttribute($name)
{
return $this->_attributes?$this->_attributes->contains($name):false;
}
/**
* @return string the named attribute value, null if attribute does not exist
*/
public function getAttribute($name)
{
return $this->_attributes?$this->_attributes->itemAt($name):null;
}
/**
* @param string attribute name
* @param string value of the attribute
*/
public function setAttribute($name,$value)
{
$this->getAttributes()->add($name,$value);
}
/**
* Removes the named attribute.
* @param string the name of the attribute to be removed.
* @return string attribute value removed, empty string if attribute does not exist.
*/
public function removeAttribute($name)
{
return $this->_attributes?$this->_attributes->remove($name):null;
}
}
|
