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
|
<?php
/**
* TActiveCheckBox class file.
*
* @author Wei Zhuo <weizhuo[at]gamil[dot]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.ActiveControls
*/
/**
* Load active control adapter.
*/
Prado::using('System.Web.UI.ActiveControls.TActiveControlAdapter');
/**
* TActiveCheckBox class.
*
* The active control counter part to checkbox. The {@link setAutoPostBack AutoPostBack}
* property is set to true by default. Thus, when the checkbox is clicked a
* {@link onCallback OnCallback} event is raise after {@link OnCheckedChanged} event.
*
* The {@link setText Text} and {@link setChecked Checked} properties can be
* changed during a callback.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @package System.Web.UI.ActiveControls
* @since 3.1
*/
class TActiveCheckBox extends TCheckBox implements ICallbackEventHandler, IActiveControl
{
/**
* Creates a new callback control, sets the adapter to
* TActiveControlAdapter. If you override this class, be sure to set the
* adapter appropriately by, for example, by calling this constructor.
*/
public function __construct()
{
parent::__construct();
$this->setAdapter(new TActiveControlAdapter($this));
$this->setAutoPostBack(true);
}
/**
* @return TBaseActiveCallbackControl standard callback control options.
*/
public function getActiveControl()
{
return $this->getAdapter()->getBaseActiveControl();
}
/**
* @return TCallbackClientSide client side request options.
*/
public function getClientSide()
{
return $this->getAdapter()->getBaseActiveControl()->getClientSide();
}
/**
* Raises the callback event. This method is required by {@link
* ICallbackEventHandler} interface.
* This method is mainly used by framework and control developers.
* @param TCallbackEventParameter the event parameter
*/
public function raiseCallbackEvent($param)
{
$this->onCallback($param);
}
/**
* This method is invoked when a callback is requested. The method raises
* 'OnCallback' event to fire up the event handlers. If you override this
* method, be sure to call the parent implementation so that the event
* handler can be invoked.
* @param TCallbackEventParameter event parameter to be passed to the event handlers
*/
public function onCallback($param)
{
$this->raiseEvent('OnCallback', $this, $param);
}
/**
* Updates the button text on the client-side if the
* {@link setEnableUpdate EnableUpdate} property is set to true.
* @param string caption of the button
*/
public function setText($value)
{
if(parent::getText() === $value)
return;
parent::setText($value);
if($this->getActiveControl()->canUpdateClientSide())
$this->getPage()->getCallbackClient()->update(
$this->getDefaultLabelID(), $value);
}
/**
* Sets a value indicating whether the checkbox is to be checked or not.
* Updates checkbox checked state on the client-side if the
* {@link setEnableUpdate EnableUpdate} property is set to true.
* @param boolean whether the checkbox is to be checked or not.
*/
public function setChecked($value)
{
$value = TPropertyValue::ensureBoolean($value);
if(parent::getChecked() === $value)
return;
parent::setChecked($value);
if($this->getActiveControl()->canUpdateClientSide())
$this->getPage()->getCallbackClient()->check($this, $value);
}
/**
* Override parent implementation, no javascript is rendered here instead
* the javascript required for active control is registered in {@link addAttributesToRender}.
*/
protected function renderClientControlScript($writer)
{
}
/**
* Ensure that the ID attribute is rendered and registers the javascript code
* for initializing the active control.
*
* Since 3.1.4, the javascript code is not rendered if {@link setAutoPostBack AutoPostBack} is false
*
* @param THtmlWriter the writer for the rendering purpose
* @param string checkbox id
* @param string onclick js
*/
protected function renderInputTag($writer,$clientID,$onclick)
{
parent::renderInputTag($writer,$clientID,$onclick);
if ($this->getAutoPostBack())
$this->getActiveControl()->registerCallbackClientScript(
$this->getClientClassName(), $this->getPostBackOptions());
}
/**
* @return string corresponding javascript class name for this TActiveCheckBox.
*/
protected function getClientClassName()
{
return 'Prado.WebUI.TActiveCheckBox';
}
/**
* Overrides parent implementation to ensure label has ID.
* @return TMap list of attributes to be rendered for label beside the checkbox
*/
public function getLabelAttributes()
{
$attributes = parent::getLabelAttributes();
$attributes['id'] = $this->getDefaultLabelID();
return $attributes;
}
/**
* Renders a label beside the checkbox.
* @param THtmlWriter the writer for the rendering purpose
* @param string checkbox id
* @param string label text
*/
protected function renderLabel($writer,$clientID,$text)
{
$writer->addAttribute('id', $this->getDefaultLabelID());
parent::renderLabel($writer, $clientID, $text);
}
/**
* @return string checkbox label ID;
*/
protected function getDefaultLabelID()
{
if($attributes=$this->getViewState('LabelAttributes',null))
return TCheckBox::getLabelAttributes()->itemAt('id');
else
return $this->getClientID().'_label';
}
}
|
