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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
<?php
/**
* TActiveTableCell class file
*
* @author LANDWEHR Computer und Software GmbH <programmierung@landwehr-software.de>
* @link http://www.landwehr-software.de/
* @copyright Copyright © 2009 LANDWEHR Computer und Software GmbH
* @license http://www.pradosoft.com/license/
* @package Prado\Web\UI\ActiveControls
* @version $Id$
*/
namespace Prado\Web\UI\ActiveControls;
/**
* Includes the following used classes
*/
Prado::using('System.Web.UI.WebControls.TTableRow');
Prado::using('System.Web.UI.ActiveControls.TActiveControlAdapter');
Prado::using('System.Web.UI.ActiveControls.TCallbackEventParameter');
/**
* TActiveTableCell class.
*
* TActiveTableCell is the active counterpart to the original {@link TTableCell} control
* and displays a table cell. The horizontal and vertical alignments of the cell
* are specified via {@link setHorizontalAlign HorizontalAlign} and
* {@link setVerticalAlign VerticalAlign} properties, respectively.
*
* TActiveTableCell allows the contents of the table cell to be changed during callback. When
* {@link onCellSelected CellSelected} property is set, selecting (clicking on) the cell will
* perform a callback request causing {@link onCellSelected OnCellSelected} event to be fired.
*
* It will also bubble the {@link onCellSelected OnCellSelected} event up to it's parent
* {@link TActiveTableRow} control which will fire up the event handlers if implemented.
*
* TActiveTableCell allows the client-side cell contents to be updated during a
* callback response by getting a new writer, invoking the render method and flushing the
* output, similar to a {@link TActivePanel} control.
* <code>
* function callback_request($sender, $param)
* {
* $this->active_cell->render($param->getNewWriter());
* }
* </code>
*
* Please refer to the original documentation of the regular counterpart for usage.
*
* @author LANDWEHR Computer und Software GmbH <programmierung@landwehr-software.de>
* @package Prado\Web\UI\ActiveControls
* @version $Id$
* @since 3.1.9
*/
class TActiveTableCell extends TTableCell implements ICallbackEventHandler, IActiveControl
{
/**
* @var TTable parent row control containing the cell
*/
private $_row;
/**
* Creates a new callback control, sets the adapter to TActiveControlAdapter.
*/
public function __construct()
{
parent::__construct();
$this->setAdapter(new TActiveControlAdapter($this));
}
/**
* @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();
}
/**
* @return string corresponding javascript class name for this TActiveTableCell.
*/
protected function getClientClassName()
{
return 'Prado.WebUI.TActiveTableCell';
}
/**
* Raises the callback event. This method is required by {@link ICallbackEventHandler}
* interface. It will raise {@link onCellSelected OnCellSelected} event with a
* {@link TActiveTableCellEventParameter} containing the zero-based index of the
* TActiveTableCell.
* This method is mainly used by framework and control developers.
* @param TCallbackEventParameter the event parameter
*/
public function raiseCallbackEvent($param)
{
$parameter = new TActiveTableCellEventParameter($this->getResponse(), $param->getCallbackParameter(), $this->getCellIndex());
$this->onCellSelected($parameter);
$this->raiseBubbleEvent($this, $parameter);
}
/**
* This method is invoked when a callback is requested. The method raises
* 'OnCellSelected' 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 TActiveTableCellEventParameter event parameter to be passed to the event handlers
*/
public function onCellSelected($param)
{
$this->raiseEvent('OnCellSelected', $this, $param);
}
/**
* Ensure that the ID attribute is rendered and registers the javascript code
* for initializing the active control if the event handler for the
* {@link onCellSelected OnCellSelected} event is set.
* @param THtmlWriter the writer responsible for rendering
*/
protected function addAttributesToRender($writer)
{
parent::addAttributesToRender($writer);
$writer->addAttribute('id', $this->getClientID());
if ($this->hasEventHandler('OnCellSelected'))
$this->getActiveControl()->registerCallbackClientScript($this->getClientClassName(), $this->getPostBackOptions());
}
/**
* Renders and replaces the cell's content on the client-side. When render() is
* called before the OnPreRender event, such as when render() is called during
* a callback event handler, the rendering is defered until OnPreRender event
* is raised.
* @param THtmlWriter html writer
*/
public function render($writer)
{
if ($this->getHasPreRendered())
{
parent::render($writer);
if ($this->getActiveControl()->canUpdateClientSide())
$this->getPage()->getCallbackClient()->replaceContent($this, $writer);
}
else {
$this->getPage()->getAdapter()->registerControlToRender($this, $writer);
// If we update a TActiveTableCell on callback, we shouldn't update all childs,
// because the whole content will be replaced by the parent.
if ($this->getHasControls())
{
foreach ($this->findControlsByType('IActiveControl', false) as $control)
$control->getActiveControl()->setEnableUpdate(false);
}
}
}
/**
* Returns postback specifications for the table cell.
* This method is used by framework and control developers.
* @return array parameters about how the row defines its postback behavior.
*/
protected function getPostBackOptions()
{
$options['ID'] = $this->getClientID();
$options['EventTarget'] = $this->getUniqueID();
return $options;
}
/**
* Returns the zero-based index of the TActiveTableCell within the {@link TTableCellCollection}
* of the parent {@link TTableRow} control. Raises a {@link TConfigurationException} if the cell
* is no member of the cell collection.
* @return integer the zero-based index of the cell
*/
public function getCellIndex()
{
foreach ($this->getRow()->getCells() as $key => $row)
if ($row == $this) return $key;
throw new TConfigurationException('tactivetablecell_control_notincollection', get_class($this), $this->getUniqueID());
}
/**
* Returns the parent {@link TTableRow} control by looping through all parents until a {@link TTableRow}
* is found. Raises a {@link TConfigurationException} if no row control is found.
* @return TTableRow the parent row control
*/
public function getRow()
{
if ($this->_row === null)
{
$row = $this->getParent();
while (!($row instanceof TTableRow) && $row !== null)
{
$row = $row->getParent();
}
if ($row instanceof TTableRow) $this->_row = $row;
else throw new TConfigurationException('tactivetablecell_control_outoftable', get_class($this), $this->getUniqueID());
}
return $this->_row;
}
}
|
