blob: 6d18dc29b2d2d5fee1206110ec70996e1513bed8 (
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
|
<?php
/**
* TActiveListControlAdapter class file.
*
* @author Wei Zhuo <weizhuo[at]gamil[dot]com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Web\UI\ActiveControls
*/
namespace Prado\Web\UI\ActiveControls;
use Prado\Collections\TListItemCollection;
/**
* TActiveListItemCollection class.
*
* Allows TActiveDropDownList and TActiveListBox to add new options
* during callback response. New options can only be added <b>after</b> the
* {@link TControl::onLoad OnLoad} event.
*
* The {@link getListHasChanged ListHasChanged} property is true when the
* list items has changed. The control responsible for the list needs to
* repopulate the client-side options.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @package Prado\Web\UI\ActiveControls
* @since 3.1
*/
class TActiveListItemCollection extends TListItemCollection
{
/**
* @var IActiveControl control instance.
*/
private $_control;
/**
* @var boolean true if list items were changed.
*/
private $_hasChanged=false;
/**
* @return boolean true if active controls can update client-side and
* the onLoad event has already been raised.
*/
protected function canUpdateClientSide()
{
return $this->getControl()->getActiveControl()->canUpdateClientSide()
&& $this->getControl()->getHasLoaded();
}
/**
* @param IActiveControl a active list control.
*/
public function setControl(IActiveControl $control)
{
$this->_control = $control;
}
/**
* @return IActiveControl active control using the collection.
*/
public function getControl()
{
return $this->_control;
}
/**
* @return boolean true if the list has changed after onLoad event.
*/
public function getListHasChanged()
{
return $this->_hasChanged;
}
/**
* Update client-side list items.
*/
public function updateClientSide()
{
$client = $this->getControl()->getPage()->getCallbackClient();
$client->setListItems($this->getControl(), $this);
$this->_hasChanged=false;
}
/**
* Inserts an item into the collection.
* The new option is added on the client-side during callback.
* @param integer the location where the item will be inserted.
* The current item at the place and the following ones will be moved backward.
* @param TListItem the item to be inserted.
* @throws TInvalidDataTypeException if the item being inserted is neither a string nor TListItem
*/
public function insertAt($index, $value)
{
parent::insertAt($index, $value);
if($this->canUpdateClientSide())
$this->_hasChanged = true;
}
/**
* Removes an item from at specified index.
* @param int zero based index.
*/
public function removeAt($index)
{
parent::removeAt($index);
if($this->canUpdateClientSide())
$this->_hasChanged = true;
}
}
|