From 1180e6486139a9c9662984367c4f624394e06f35 Mon Sep 17 00:00:00 2001 From: wei <> Date: Sat, 12 Aug 2006 12:54:27 +0000 Subject: Add Triggered Callbacks --- .../Web/UI/ActiveControls/TBaseActiveControl.php | 4 +- framework/Web/UI/ActiveControls/TCallbackTimer.php | 147 --------------------- .../UI/ActiveControls/TEventTriggeredCallback.php | 70 ++++++++++ .../Web/UI/ActiveControls/TPeriodicCallback.php | 147 +++++++++++++++++++++ .../Web/UI/ActiveControls/TTriggeredCallback.php | 49 +++++++ .../UI/ActiveControls/TValueTriggeredCallback.php | 92 +++++++++++++ 6 files changed, 361 insertions(+), 148 deletions(-) delete mode 100644 framework/Web/UI/ActiveControls/TCallbackTimer.php create mode 100644 framework/Web/UI/ActiveControls/TEventTriggeredCallback.php create mode 100644 framework/Web/UI/ActiveControls/TPeriodicCallback.php create mode 100644 framework/Web/UI/ActiveControls/TTriggeredCallback.php create mode 100644 framework/Web/UI/ActiveControls/TValueTriggeredCallback.php (limited to 'framework/Web/UI/ActiveControls') 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/TCallbackTimer.php b/framework/Web/UI/ActiveControls/TCallbackTimer.php deleted file mode 100644 index bae41e1f..00000000 --- a/framework/Web/UI/ActiveControls/TCallbackTimer.php +++ /dev/null @@ -1,147 +0,0 @@ - - * @link http://www.pradosoft.com/ - * @copyright Copyright © 2006 PradoSoft - * @license http://www.pradosoft.com/license/ - * @version $Revision: $ : $ - * @package System.Web.UI.ActiveControls - */ - -/** - * Load active callback control. - */ -Prado::using('System.Web.UI.ActiveControls.TCallback'); - -/** - * TCallbackTimer class. - * - * TCallbackTimer 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 - * default decay rate, {@link setDecayType DecayType}, is linear and can be changed to - * 'Exponential', 'Linear', 'Quadratic' or 'Cubic'. - * - * @author Wei Zhuo - * @version : $ Mon Jun 19 21:29:42 EST 2006 $ - * @package System.Web.UI.ActiveControls - * @since 3.0 - */ -class TCallbackTimer extends TCallback -{ - /** - * @return float seconds between callback requests. Default is 1 second. - */ - public function getInterval() - { - return $this->getViewState('Interval', 1); - } - - /** - * @param float seconds between callback requests, must be a positive number, default is 1 second. - */ - public function setInterval($value) - { - $interval = TPropertyValue::ensureFloat($value); - if($interval <= 0) - 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. - */ - 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); - } - - /** - * @param string Decay type, allows 'Exponential', 'Linear', 'Quadratic' and 'Cubic'. Default is 'Linear'. - */ - public function setDecayType($value) - { - $this->setViewState('DecayType', TPropertyValue::ensureEnum($value, - 'Exponential', 'Linear', 'Quadratic', 'Cubic'), 'Linear'); - } - - /** - * @return string decay type, default is 'Linear', valid types are 'Exponential', 'Linear', 'Quadratic' and 'Cubic'. - */ - public function getDecayType() - { - 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}');"; - $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}');"; - $cs = $this->getPage()->getClientScript(); - $cs->registerEndScript("{$id}:stop", $code); - } - - /** - * @return array list of timer options for client-side. - */ - protected function getTimerOptions() - { - $options['ID'] = $this->getClientID(); - $options['Interval'] = $this->getInterval(); - $options['DecayRate'] = $this->getDecayRate(); - $options['DecayType'] = $this->getDecayType(); - 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->getTimerOptions()); - } - - /** - * @return string corresponding javascript class name for this TActiveButton. - */ - protected function getClientClassName() - { - return 'Prado.WebUI.TCallbackTimer'; - } -} - -?> \ No newline at end of file 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 @@ +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/TPeriodicCallback.php b/framework/Web/UI/ActiveControls/TPeriodicCallback.php new file mode 100644 index 00000000..e620ac46 --- /dev/null +++ b/framework/Web/UI/ActiveControls/TPeriodicCallback.php @@ -0,0 +1,147 @@ + + * @link http://www.pradosoft.com/ + * @copyright Copyright © 2006 PradoSoft + * @license http://www.pradosoft.com/license/ + * @version $Revision: $ : $ + * @package System.Web.UI.ActiveControls + */ + +/** + * Load active callback control. + */ +Prado::using('System.Web.UI.ActiveControls.TCallback'); + +/** + * 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 + * default decay rate, {@link setDecayType DecayType}, is linear and can be changed to + * 'Exponential', 'Linear', 'Quadratic' or 'Cubic'. + * + * @author Wei Zhuo + * @version : $ Mon Jun 19 21:29:42 EST 2006 $ + * @package System.Web.UI.ActiveControls + * @since 3.0 + */ +class TPeriodicCallback extends TCallback +{ + /** + * @return float seconds between callback requests. Default is 1 second. + */ + public function getInterval() + { + return $this->getViewState('Interval', 1); + } + + /** + * @param float seconds between callback requests, must be a positive number, default is 1 second. + */ + public function setInterval($value) + { + $interval = TPropertyValue::ensureFloat($value); + if($interval <= 0) + 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. + */ + 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); + } + + /** + * @param string Decay type, allows 'Exponential', 'Linear', 'Quadratic' and 'Cubic'. Default is 'Linear'. + */ + public function setDecayType($value) + { + $this->setViewState('DecayType', TPropertyValue::ensureEnum($value, + 'Exponential', 'Linear', 'Quadratic', 'Cubic'), 'Linear'); + } + + /** + * @return string decay type, default is 'Linear', valid types are 'Exponential', 'Linear', 'Quadratic' and 'Cubic'. + */ + public function getDecayType() + { + return $this->getViewState('DecayType', 'Linear'); + } + + /** + * Registers the javascript code to start the timer. + */ + public function startTimer() + { + $id = $this->getClientID(); + $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.TPeriodicCallback.stop('{$id}');"; + $cs = $this->getPage()->getClientScript(); + $cs->registerEndScript("{$id}:stop", $code); + } + + /** + * @return array list of timer options for client-side. + */ + protected function getTimerOptions() + { + $options['ID'] = $this->getClientID(); + $options['Interval'] = $this->getInterval(); + $options['DecayRate'] = $this->getDecayRate(); + $options['DecayType'] = $this->getDecayType(); + 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->getTimerOptions()); + } + + /** + * @return string corresponding javascript class name for TPeriodicCallback. + */ + protected function getClientClassName() + { + return 'Prado.WebUI.TPeriodicCallback'; + } +} + +?> \ No newline at end of file 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 @@ +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 @@ +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 -- cgit v1.2.3