Add Triggered Callbacks

8 files changed, 377 insertions, 27 deletions

diff --git a/framework/Exceptions/messages.txt b/framework/Exceptions/messages.txt
index 39d304be..89dcb799 100644
--- a/framework/Exceptions/messages.txt
+++ b/framework/Exceptions/messages.txt
@@ -341,3 +341,5 @@ xmltransform_xslextension_required		= TXmlTransform requires the PHP's XSL exten
 xmltransform_transformpath_invalid		= TXmlTransform.TransformPath '{0}' is invalid.

 xmltransform_documentpath_invalid		= TXmlTransform.DocumentPath '{0}' is invalid.

 xmltransform_transform_required			= Either TransformContent or TransformPath property must be set for TXmlTransform.

+

+ttriggeredcallback_invalid_controlid	= ControlID property for '{0}' must not be empty.
\ No newline at end of file
diff --git a/framework/Web/Javascripts/js/ajax.js b/framework/Web/Javascripts/js/ajax.js
index 0836f094..95869ade 100644
--- a/framework/Web/Javascripts/js/ajax.js
+++ b/framework/Web/Javascripts/js/ajax.js
@@ -212,9 +212,9 @@ this.onInit(options);},doCallback:function(event,options)
 {var element=Event.findElement(event,'LI');this.index=element.autocompleteIndex;this.selectEntry();this.hide();Event.fireEvent(this.element,"change");},getUpdatedChoices:function()
 {options=new Array(this.getToken(),"__TAutoComplete_onSuggest__");Prado.Callback(this.options.EventTarget,options,null,this.options);},onComplete:function(request,boundary)
 {result=Prado.Element.extractContent(request.responseText,boundary);if(typeof(result)=="string"&&result.length>0)
-this.updateChoices(result);}});Prado.WebUI.TCallbackTimer=Base.extend({count:0,timeout:0,constructor:function(options)
+this.updateChoices(result);}});Prado.WebUI.TPeriodicCallback=Base.extend({count:0,timeout:0,constructor:function(options)
 {this.options=Object.extend({Interval:1,DecayRate:0},options||{})
-this.onComplete=this.options.onComplete;Prado.WebUI.TCallbackTimer.register(this);},startTimer:function()
+this.onComplete=this.options.onComplete;Prado.WebUI.TPeriodicCallback.register(this);},startTimer:function()
 {this.options.onComplete=this.onRequestComplete.bind(this);setTimeout(this.onTimerEvent.bind(this),200);},stopTimer:function()
 {(this.onComplete||Prototype.emptyFunction).apply(this,arguments);this.options.onComplete=undefined;clearTimeout(this.timer);this.timer=undefined;this.count=0;},onTimerEvent:function()
 {this.options.params=this.timeout/1000;request=new Prado.CallbackRequest(this.options.ID,this.options);request.dispatch();},onRequestComplete:function()
@@ -228,4 +228,25 @@ this.timers[id].startTimer();},stop:function(id)
 {if(this.timers[id])
 this.timers[id].stopTimer();}});Prado.WebUI.ActiveListControl=Base.extend({constructor:function(options)
 {this.element=$(options.ID);this.options=options;Event.observe(this.element,"change",this.doCallback.bind(this));},doCallback:function(event)
-{request=new Prado.CallbackRequest(this.options.EventTarget,this.options);request.dispatch();Event.stop(event);}});Prado.WebUI.TActiveDropDownList=Prado.WebUI.ActiveListControl;Prado.WebUI.TActiveListBox=Prado.WebUI.ActiveListControl;
\ No newline at end of file
+{request=new Prado.CallbackRequest(this.options.EventTarget,this.options);request.dispatch();Event.stop(event);}});Prado.WebUI.TActiveDropDownList=Prado.WebUI.ActiveListControl;Prado.WebUI.TActiveListBox=Prado.WebUI.ActiveListControl;Prado.WebUI.TEventTriggeredCallback=Base.extend({constructor:function(options)
+{this.options=options;element=$(options['ControlID']);if(element)
+Event.observe(element,this.getEventName(element),this.doCallback.bind(this));},getEventName:function(element)
+{name=this.options.EventName;if(typeof(name)=="undefined"&&element.type)
+{switch(element.type.toLowerCase())
+{case'password':case'text':case'textarea':case'select-one':case'select-multiple':return'change';}}
+return typeof(name)=="undefined"||name=="undefined"?'click':name;},doCallback:function(event)
+{request=new Prado.CallbackRequest(this.options.ID,this.options);request.dispatch();if(this.options.StopEvent==true)
+Event.stop(event);}});Prado.WebUI.TValueTriggeredCallback=Base.extend({count:1,observing:true,constructor:function(options)
+{this.options=options;this.options.PropertyName=this.options.PropertyName||'value';element=$(options['ControlID']);this.value=element?element[this.options.PropertyName]:undefined;Prado.WebUI.TValueTriggeredCallback.register(this);this.startObserving();},stopObserving:function()
+{clearTimeout(this.timer);this.observing=false;},startObserving:function()
+{this.timer=setTimeout(this.checkChanges.bind(this),this.options.Interval*1000);},checkChanges:function()
+{element=$(this.options.ControlID);if(element)
+{value=element[this.options.PropertyName];if(this.value!=value)
+{this.doCallback(this.value,value);this.value=value;this.count=1;}
+else
+this.count=this.count+this.options.Decay;if(this.observing)
+this.time=setTimeout(this.checkChanges.bind(this),parseInt(this.options.Interval*1000*this.count));}},doCallback:function(oldValue,newValue)
+{request=new Prado.CallbackRequest(this.options.ID,this.options);param={'OldValue':oldValue,'NewValue':newValue};request.setParameter(param);request.dispatch();}},{timers:{},register:function(timer)
+{this.timers[timer.options.ID]=timer;},stop:function(id)
+{if(this.timers[id])
+this.timers[id].stopObserving();}});
\ No newline at end of file
diff --git a/framework/Web/Javascripts/prado/activecontrols3.js b/framework/Web/Javascripts/prado/activecontrols3.js
index f75d3684..ca1d5b37 100644
--- a/framework/Web/Javascripts/prado/activecontrols3.js
+++ b/framework/Web/Javascripts/prado/activecontrols3.js
@@ -112,9 +112,9 @@ Prado.WebUI.TAutoComplete = Class.extend(Prado.WebUI.TAutoComplete,
 });

 

 /**

- * Callback Timer class.

+ * Period Callback class.

  */

-Prado.WebUI.TCallbackTimer = Base.extend(

+Prado.WebUI.TPeriodicCallback = Base.extend(

 {

 	count : 0,

 	timeout : 0,

@@ -128,7 +128,7 @@ Prado.WebUI.TCallbackTimer = Base.extend(
 		}, options || {})

 

 		this.onComplete = this.options.onComplete;

-		Prado.WebUI.TCallbackTimer.register(this);

+		Prado.WebUI.TPeriodicCallback.register(this);

 	},

 

 	startTimer : function()

@@ -223,3 +223,117 @@ Prado.WebUI.ActiveListControl = Base.extend(
 

 Prado.WebUI.TActiveDropDownList = Prado.WebUI.ActiveListControl;

 Prado.WebUI.TActiveListBox = Prado.WebUI.ActiveListControl;

+

+/**

+ * Observe event of a particular control to trigger a callback request.

+ */

+Prado.WebUI.TEventTriggeredCallback = Base.extend(

+{

+	constructor : function(options)

+	{

+		this.options = options;

+		element = $(options['ControlID']);

+		if(element)

+			Event.observe(element, this.getEventName(element), this.doCallback.bind(this));

+	},

+

+	getEventName : function(element)

+	{

+		name = this.options.EventName;

+   		if(typeof(name) == "undefined" && element.type)

+		{

+      		switch (element.type.toLowerCase())

+			{

+          		case 'password':

+		        case 'text':

+		        case 'textarea':

+		        case 'select-one':

+		        case 'select-multiple':

+          			return 'change';

+      		}

+		}

+		return typeof(name) == "undefined"  || name == "undefined" ? 'click' : name;

+    },

+

+	doCallback : function(event)

+	{

+		request = new Prado.CallbackRequest(this.options.ID, this.options);

+		request.dispatch();

+		if(this.options.StopEvent == true)

+			Event.stop(event);

+	}

+});

+

+/**

+ * Observe changes to a property of a particular control to trigger a callback.

+ */

+Prado.WebUI.TValueTriggeredCallback = Base.extend(

+{

+	count : 1,

+

+	observing : true,

+

+	constructor : function(options)

+	{

+		this.options = options;

+		this.options.PropertyName = this.options.PropertyName || 'value';

+		element = $(options['ControlID']);

+		this.value = element ? element[this.options.PropertyName] : undefined;

+		Prado.WebUI.TValueTriggeredCallback.register(this);

+		this.startObserving();

+	},

+

+	stopObserving : function()

+	{

+		clearTimeout(this.timer);

+		this.observing = false;

+	},

+

+	startObserving : function()

+	{

+		this.timer = setTimeout(this.checkChanges.bind(this), this.options.Interval*1000);

+	},

+

+	checkChanges : function()

+	{

+		element = $(this.options.ControlID);

+		if(element)

+		{

+			value = element[this.options.PropertyName];

+			if(this.value != value)

+			{

+				this.doCallback(this.value, value);

+				this.value = value;

+				this.count=1;

+			}

+			else

+				this.count = this.count + this.options.Decay;

+			if(this.observing)

+				this.time = setTimeout(this.checkChanges.bind(this),

+					parseInt(this.options.Interval*1000*this.count));

+		}

+	},

+

+	doCallback : function(oldValue, newValue)

+	{

+		request = new Prado.CallbackRequest(this.options.ID, this.options);

+		param = {'OldValue' : oldValue, 'NewValue' : newValue};

+		request.setParameter(param);

+		request.dispatch();

+	}

+},

+//class methods

+{

+	timers : {},

+

+	register : function(timer)

+	{

+		this.timers[timer.options.ID] = timer;

+	},

+

+	stop : function(id)

+	{

+		if(this.timers[id])

+			this.timers[id].stopObserving();

+	}

+});

diff --git a/framework/Web/UI/ActiveControls/TBaseActiveControl.php b/framework/Web/UI/ActiveControls/TBaseActiveControl.php
index cb944253..c368cb68 100644
--- a/framework/Web/UI/ActiveControls/TBaseActiveControl.php
+++ b/framework/Web/UI/ActiveControls/TBaseActiveControl.php
@@ -328,8 +328,10 @@ class TBaseActiveCallbackControl extends TBaseActiveControl
 			$options = array_merge($this->getClientSideOptions(),$options);

 		else

 			$options = $this->getClientSideOptions();

+

 		//remove true as default to save bytes

-		$options['CausesValidation']= $options['CausesValidation'] ? '' : false;

+		if($options['CausesValidation']===true)

+			$options['CausesValidation']='';

 		$cs->registerCallbackControl($class, $options);

 	}

 

diff --git a/framework/Web/UI/ActiveControls/TEventTriggeredCallback.php b/framework/Web/UI/ActiveControls/TEventTriggeredCallback.php
new file mode 100644
index 00000000..42f49976
--- /dev/null
+++ b/framework/Web/UI/ActiveControls/TEventTriggeredCallback.php
@@ -0,0 +1,70 @@
+<?php

+

+class TEventTriggeredCallback extends TTriggeredCallback

+{

+	/**

+	 * @return string The client-side event name the trigger listens to.

+	 */

+	public function getEventName()

+	{

+		return $this->getViewState('EventName', '');

+	}

+

+	/**

+	 * Sets the client-side event name that fires the callback request.

+	 * @param string The client-side event name the trigger listens to.

+	 */

+	public function setEventName($value)

+	{

+		$this->setViewState('EventName', $value, '');

+	}

+

+	/**

+	 * @param boolean true to prevent/stop default event action.

+	 */

+	public function setPreventDefaultAction($value)

+	{

+		$this->setViewState('StopEvent', TPropertyValue::ensureBoolean($value), false);

+	}

+

+	/**

+	 * @return boolean true to prevent/stop default event action.

+	 */

+	public function getPreventDefaultAction()

+	{

+		return $this->getViewState('StopEvent', false);

+	}

+

+	/**

+	 * @return array list of timer options for client-side.

+	 */

+	protected function getTriggerOptions()

+	{

+		$options = parent::getTriggerOptions();

+		$name = preg_replace('/^on/', '', $this->getEventName());

+		$options['EventName'] = strtolower($name);

+		$options['StopEvent'] = $this->getPreventDefaultAction();

+		return $options;

+	}

+

+	/**

+	 * Registers the javascript code for initializing the active control.

+	 * @param THtmlWriter the renderer.

+	 */

+	public function render($writer)

+	{

+		parent::render($writer);

+		$this->getActiveControl()->registerCallbackClientScript(

+			$this->getClientClassName(), $this->getTriggerOptions());

+	}

+

+	/**

+	 * @return string corresponding javascript class name for TEventTriggeredCallback.

+	 */

+	protected function getClientClassName()

+	{

+		return 'Prado.WebUI.TEventTriggeredCallback';

+	}

+}

+

+?>
\ No newline at end of file
diff --git a/framework/Web/UI/ActiveControls/TCallbackTimer.php b/framework/Web/UI/ActiveControls/TPeriodicCallback.php
index bae41e1f..e620ac46 100644
--- a/framework/Web/UI/ActiveControls/TCallbackTimer.php
+++ b/framework/Web/UI/ActiveControls/TPeriodicCallback.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * TCallbackTimer class file.
+ * TPeriodicCallback class file.
  *
  * @author Wei Zhuo <weizhuo[at]gamil[dot]com>
  * @link http://www.pradosoft.com/
@@ -16,13 +16,13 @@
 Prado::using('System.Web.UI.ActiveControls.TCallback');
 
 /**
- * TCallbackTimer class.
- * 
- * TCallbackTimer sends callback request every {@link setInterval Interval} seconds.
+ * TPeriodicCallback class.
+ *
+ * TPeriodicCallback sends callback request every {@link setInterval Interval} seconds.
  * Upon each callback request, the {@link onCallback OnCallback} event is raised.
- * 
+ *
  * The intervals between each request can be increased when the browser is inactive
- * by changing the {@link setDecayRate DecayRate} to a positive number. The 
+ * by changing the {@link setDecayRate DecayRate} to a positive number. The
  * default decay rate, {@link setDecayType DecayType}, is linear and can be changed to
  * 'Exponential', 'Linear', 'Quadratic' or 'Cubic'.
  *
@@ -31,7 +31,7 @@ Prado::using('System.Web.UI.ActiveControls.TCallback');
  * @package System.Web.UI.ActiveControls
  * @since 3.0
  */
-class TCallbackTimer extends TCallback
+class TPeriodicCallback extends TCallback
 {
 	/**
 	 * @return float seconds between callback requests. Default is 1 second.
@@ -40,7 +40,7 @@ class TCallbackTimer extends TCallback
 	{
 		return $this->getViewState('Interval', 1);
 	}
-	
+
 	/**
 	 * @param float seconds between callback requests, must be a positive number, default is 1 second.
 	 */
@@ -51,7 +51,7 @@ class TCallbackTimer extends TCallback
 			throw new TConfigurationException('callback_interval_be_positive', $this->getID());
 		$this->setViewState('Interval', $interval, 1);
 	}
-	
+
 	/**
 	 * Gets the decay rate between callbacks. Default is 0;
 	 * @return float decay rate between callbacks.
@@ -60,7 +60,7 @@ class TCallbackTimer extends TCallback
 	{
 		return $this->getViewState('Decay', 0);
 	}
-	
+
 	/**
 	 * Sets the decay rate between callback. Default is 0;
 	 * @param float decay rate between callbacks.
@@ -72,13 +72,13 @@ class TCallbackTimer extends TCallback
 			throw new TConfigurationException('callback_decay_be_not_negative', $this->getID());
 		$this->setViewState('Decay', $decay);
 	}
-	
+
 	/**
 	 * @param string Decay type, allows 'Exponential', 'Linear', 'Quadratic' and 'Cubic'. Default is 'Linear'.
 	 */
 	public function setDecayType($value)
 	{
-		$this->setViewState('DecayType', TPropertyValue::ensureEnum($value, 
+		$this->setViewState('DecayType', TPropertyValue::ensureEnum($value,
 			'Exponential', 'Linear', 'Quadratic', 'Cubic'), 'Linear');
 	}
 
@@ -89,27 +89,27 @@ class TCallbackTimer extends TCallback
 	{
 		return $this->getViewState('DecayType', 'Linear');
 	}
-	
+
 	/**
 	 * Registers the javascript code to start the timer.
 	 */
 	public function startTimer()
 	{
 		$id = $this->getClientID();
-		$code = "Prado.WebUI.TCallbackTimer.start('{$id}');";
+		$code = "Prado.WebUI.TPeriodicCallback.start('{$id}');";
 		$cs = $this->getPage()->getClientScript();
 		$cs->registerEndScript("{$id}:start", $code);
 	}
-	
+
 	/**
 	 * Registers the javascript code to stop the timer.
 	 */
 	public function stopTimer()
 	{
 		$id = $this->getClientID();
-		$code = "Prado.WebUI.TCallbackTimer.stop('{$id}');";
+		$code = "Prado.WebUI.TPeriodicCallback.stop('{$id}');";
 		$cs = $this->getPage()->getClientScript();
-		$cs->registerEndScript("{$id}:stop", $code);		
+		$cs->registerEndScript("{$id}:stop", $code);
 	}
 
 	/**
@@ -132,15 +132,15 @@ class TCallbackTimer extends TCallback
 	{
 		parent::render($writer);
 		$this->getActiveControl()->registerCallbackClientScript(
-			$this->getClientClassName(), $this->getTimerOptions());		
+			$this->getClientClassName(), $this->getTimerOptions());
 	}
 
 	/**
-	 * @return string corresponding javascript class name for this TActiveButton.
+	 * @return string corresponding javascript class name for TPeriodicCallback.
 	 */
 	protected function getClientClassName()
 	{
-		return 'Prado.WebUI.TCallbackTimer';
+		return 'Prado.WebUI.TPeriodicCallback';
 	}
 }
 
diff --git a/framework/Web/UI/ActiveControls/TTriggeredCallback.php b/framework/Web/UI/ActiveControls/TTriggeredCallback.php
new file mode 100644
index 00000000..076166c9
--- /dev/null
+++ b/framework/Web/UI/ActiveControls/TTriggeredCallback.php
@@ -0,0 +1,49 @@
+<?php

+

+abstract class TTriggeredCallback extends TCallback

+{

+	/**

+	 * @return string The ID of the server control the trigger is bounded to.

+	 */

+	public function getControlID()

+	{

+		return $this->getViewState('ControlID', '');

+	}

+

+	/**

+	 * @param string The ID of the server control the trigger is bounded to.

+	 */

+	public function setControlID($value)

+	{

+		$this->setViewState('ControlID', $value, '');

+	}

+

+	/**

+	 * @return string target control client ID or html element ID if

+	 * control is not found in hierarchy.

+	 */

+	protected function getTargetControl()

+	{

+		$id = $this->getControlID();

+		if(($control=$this->findControl($id)) instanceof TControl)

+			return $control->getClientID();

+		if($id==='')

+		{

+			throw new TConfigurationException(

+				'ttriggeredcallback_invalid_controlid', get_class($this));

+		}

+		return $id;

+	}

+

+	/**

+	 * @return array list of trigger callback options.

+	 */

+	protected function getTriggerOptions()

+	{

+		$options['ID'] = $this->getClientID();

+		$options['ControlID'] = $this->getTargetControl();

+		return $options;

+	}

+}

+

+?>
\ No newline at end of file
diff --git a/framework/Web/UI/ActiveControls/TValueTriggeredCallback.php b/framework/Web/UI/ActiveControls/TValueTriggeredCallback.php
new file mode 100644
index 00000000..bb50e4f1
--- /dev/null
+++ b/framework/Web/UI/ActiveControls/TValueTriggeredCallback.php
@@ -0,0 +1,92 @@
+<?php

+

+class TValueTriggeredCallback extends TTriggeredCallback

+{

+	/**

+	 * @return string The control property name to observe value changes.

+	 */

+	public function getPropertyName()

+	{

+		return $this->getViewState('PropertyName', '');

+	}

+

+	/**

+	 * Sets the control property name to observe value changes that fires the callback request.

+	 * @param string The control property name to observe value changes.

+	 */

+	public function setPropertyName($value)

+	{

+		$this->setViewState('PropertyName', $value, '');

+	}

+

+	/**

+	 * Sets the polling interval in seconds to observe property changes.

+	 * Default is 1 second.

+	 * @param float polling interval in seconds.

+	 */

+	public function setPollingInterval($value)

+	{

+		$this->setViewState('Interval', TPropertyValue::ensureFloat($value), 1);

+	}

+

+	/**

+	 * Gets the decay rate between callbacks. Default is 0;

+	 * @return float decay rate between callbacks.

+	 */

+	public function getDecayRate()

+	{

+		return $this->getViewState('Decay', 0);

+	}

+

+	/**

+	 * Sets the decay rate between callback. Default is 0;

+	 * @param float decay rate between callbacks.

+	 */

+	public function setDecayRate($value)

+	{

+		$decay = TPropertyValue::ensureFloat($value);

+		if($decay < 0)

+			throw new TConfigurationException('callback_decay_be_not_negative', $this->getID());

+		$this->setViewState('Decay', $decay);

+	}

+

+	/**

+	 * @return float polling interval, 1 second default.

+	 */

+	public function getPollingInterval()

+	{

+		return $this->getViewState('Interval', 1);

+	}

+

+	/**

+	 * @return array list of timer options for client-side.

+	 */

+	protected function getTriggerOptions()

+	{

+		$options = parent::getTriggerOptions();

+		$options['PropertyName'] = $this->getPropertyName();

+		$options['Interval'] = $this->getPollingInterval();

+		$options['Decay'] = $this->getDecayRate();

+		return $options;

+	}

+

+	/**

+	 * Registers the javascript code for initializing the active control.

+	 * @param THtmlWriter the renderer.

+	 */

+	public function render($writer)

+	{

+		parent::render($writer);

+		$this->getActiveControl()->registerCallbackClientScript(

+			$this->getClientClassName(), $this->getTriggerOptions());

+	}

+

+	/**

+	 * @return string corresponding javascript class name for TEventTriggeredCallback.

+	 */

+	protected function getClientClassName()

+	{

+		return 'Prado.WebUI.TValueTriggeredCallback';

+	}

+}

+?>
\ No newline at end of file