From a7f6c6640ac9295eec3ae2edbb2250179eb85e33 Mon Sep 17 00:00:00 2001 From: wei <> Date: Sat, 6 May 2006 02:26:20 +0000 Subject: Adding TActiveButton and TActiveTextBox --- framework/Web/UI/ActiveControls/TActiveButton.php | 141 +++++++++++++++++++++ .../UI/ActiveControls/TActiveControlAdapter.php | 4 +- framework/Web/UI/ActiveControls/TActiveLabel.php | 6 +- .../Web/UI/ActiveControls/TActivePageAdapter.php | 1 - framework/Web/UI/ActiveControls/TActiveTextBox.php | 139 ++++++++++++++++++++ .../ActiveControls/TCallbackClientSideOptions.php | 10 +- 6 files changed, 291 insertions(+), 10 deletions(-) create mode 100644 framework/Web/UI/ActiveControls/TActiveButton.php create mode 100644 framework/Web/UI/ActiveControls/TActiveTextBox.php (limited to 'framework/Web/UI/ActiveControls') diff --git a/framework/Web/UI/ActiveControls/TActiveButton.php b/framework/Web/UI/ActiveControls/TActiveButton.php new file mode 100644 index 00000000..db4fa85d --- /dev/null +++ b/framework/Web/UI/ActiveControls/TActiveButton.php @@ -0,0 +1,141 @@ +setAdapter(new TActiveControlAdapter($this)); + } + + /** + * @param boolean true to allow fine grain callback updates. + */ + public function setAllowCallbackUpdate($value) + { + $this->setViewState('CallbackUpdate', TPropertyValue::ensureBoolean($value), true); + } + + /** + * @return true to allow fine grain callback updates. + */ + public function getAllowCallbackUpdate() + { + return $this->getViewState('CallbackUpdate', true); + } + + /** + * @return true if can update changes on the client-side during callback. + */ + protected function canUpdateClientSide() + { + return $this->getIsInitialized() && $this->getAllowCallbackUpdate(); + } + + /** + * Raises the callback event. This method is required by {@link + * ICallbackEventHandler} interface. If {@link getCausesValidation + * CausesValidation} is true, it will invoke the page's {@link TPage:: + * validate validate} method first. It will raise {@link onCallback + * OnCallback} event and then the {@link onClick OnClick} event. This method + * is mainly used by framework and control developers. + * @param TCallbackEventParameter the event parameter + */ + public function raiseCallbackEvent($param) + { + $this->raisePostBackEvent($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); + } + + /** + * @param string caption of the button + */ + public function setText($value) + { + parent::setText($value); + if($this->canUpdateClientSide()) + $this->getPage()->getCallbackClient()->setAttribute($this, 'value', $value); + } + + /** + * Callback client-side options can be set by setting the properties of + * the ClientSide property. E.g. + * See {@link TCallbackClientSideOptions} for details on the properties of + * ClientSide. + * @return TCallbackClientSideOptions client-side callback options. + */ + public function getClientSide() + { + if(is_null($this->_clientSide)) + $this->_clientSide = $this->createClientSideOptions(); + return $this->_clientSide; + } + + /** + * @return TCallbackClientSideOptions callback client-side options. + */ + protected function createClientSideOptions() + { + return new TCallbackClientSideOptions; + } + + /** + * Renders the callback control javascript statement. + */ + protected function renderClientControlScript($writer) + { + $writer->addAttribute('id',$this->getClientID()); + $cs = $this->getPage()->getClientScript(); + $cs->registerCallbackControl(get_class($this),$this->getCallbackOptions()); + } + + /** + * @return array list of callback options. + */ + protected function getCallbackOptions() + { + return array_merge($this->getPostBackOptions(), + $this->getClientSide()->getOptions()->toArray()); + } + + /** + * Returns the javascript statement to invoke a callback request for this + * control. Additional options for callback can be set via subproperties of + * {@link getClientSide ClientSide} property. E.g. ClientSide.OnSuccess="..." + * @param TControl callback handler control, use current object if null. + * @return string javascript statement to invoke a callback. + */ + public function getCallbackReference($control=null) + { + $client = $this->getPage()->getClientScript(); + $object = is_null($control) ? $this : $control; + return $client->getCallbackReference($object, $this->getPostBackOptions()); + } +} + +?> \ No newline at end of file diff --git a/framework/Web/UI/ActiveControls/TActiveControlAdapter.php b/framework/Web/UI/ActiveControls/TActiveControlAdapter.php index 6b410edd..2409d9fe 100644 --- a/framework/Web/UI/ActiveControls/TActiveControlAdapter.php +++ b/framework/Web/UI/ActiveControls/TActiveControlAdapter.php @@ -15,13 +15,13 @@ class TActiveControlAdapter extends TControlAdapter if(!self::$_renderedPosts) { $options = TJavascript::encode($this->getPage()->getPostDataLoaders(),false); - $script = "Prado.CallbackRequest.PostDataLoaders.concat({$options});"; + $script = "Prado.CallbackRequest.PostDataLoaders = {$options};"; $this->getPage()->getClientScript()->registerEndScript(get_class($this), $script); self::$_renderedPosts = true; } parent::render($writer); if($this->getPage()->getIsCallback()) $this->getPage()->getCallbackClient()->replace($this->getControl(), $writer); - } + } } ?> \ No newline at end of file diff --git a/framework/Web/UI/ActiveControls/TActiveLabel.php b/framework/Web/UI/ActiveControls/TActiveLabel.php index 7e5a8084..13a88b4f 100644 --- a/framework/Web/UI/ActiveControls/TActiveLabel.php +++ b/framework/Web/UI/ActiveControls/TActiveLabel.php @@ -58,7 +58,9 @@ class TActiveLabel extends TLabel */ protected function canUpdateClientSide() { - return $this->getIsInitialized() && $this->getAllowCallbackUpdate(); + return $this->getIsInitialized() + && $this->getPage()->getIsCallback() + && $this->getAllowCallbackUpdate(); } /** @@ -69,9 +71,7 @@ class TActiveLabel extends TLabel { parent::setText($value); if($this->canUpdateClientSide()) - { $this->getPage()->getCallbackClient()->update($this, $value); - } } /** diff --git a/framework/Web/UI/ActiveControls/TActivePageAdapter.php b/framework/Web/UI/ActiveControls/TActivePageAdapter.php index 67720afd..11c3303e 100644 --- a/framework/Web/UI/ActiveControls/TActivePageAdapter.php +++ b/framework/Web/UI/ActiveControls/TActivePageAdapter.php @@ -76,7 +76,6 @@ class TActivePageAdapter extends TControlAdapter { Prado::trace("ActivePage renderCallbackResponse()",'System.Web.UI.ActiveControls.TActivePageAdapter'); $this->renderResponse($writer); - //$this->getResponse()->flush(); } /** diff --git a/framework/Web/UI/ActiveControls/TActiveTextBox.php b/framework/Web/UI/ActiveControls/TActiveTextBox.php new file mode 100644 index 00000000..ad28b291 --- /dev/null +++ b/framework/Web/UI/ActiveControls/TActiveTextBox.php @@ -0,0 +1,139 @@ +setAdapter(new TActiveControlAdapter($this)); + } + + /** + * @param boolean true to allow fine grain callback updates. + */ + public function setAllowCallbackUpdate($value) + { + $this->setViewState('CallbackUpdate', TPropertyValue::ensureBoolean($value), true); + } + + /** + * @return true to allow fine grain callback updates. + */ + public function getAllowCallbackUpdate() + { + return $this->getViewState('CallbackUpdate', true); + } + + /** + * @return true if can update changes on the client-side during callback. + */ + protected function canUpdateClientSide() + { + return $this->getIsInitialized() + && $this->getPage()->getIsCallback() + && $this->getAllowCallbackUpdate(); + } + + /** + * Callback client-side options can be set by setting the properties of + * the ClientSide property. E.g. + * See {@link TCallbackClientSideOptions} for details on the properties of + * ClientSide. + * @return TCallbackClientSideOptions client-side callback options. + */ + public function getClientSide() + { + if(is_null($this->_clientSide)) + $this->_clientSide = $this->createClientSideOptions(); + return $this->_clientSide; + } + + /** + * @return TCallbackClientSideOptions callback client-side options. + */ + protected function createClientSideOptions() + { + return new TCallbackClientSideOptions; + } + + /** + * Raises the callback event. This method is required by {@link + * ICallbackEventHandler} interface. It class raisePostDataChangedEvent + * first then raises {@link onCallback OnCallback} event. This method is + * mainly used by framework and control developers. + * @param TCallbackEventParameter the event parameter + */ + public function raiseCallbackEvent($param) + { + $this->raisePostDataChangedEvent(); + $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); + } + + /** + * Client-side Text property can only be updated after the OnLoad stage. + * @param string text content for the textbox + */ + public function setText($value) + { + parent::setText($value); + if($this->canUpdateClientSide() && $this->getHasLoadedPostData()) + $this->getPage()->getCallbackClient()->setValue($this, $value); + } + + protected function renderClientControlScript($writer) + { + $writer->addAttribute('id',$this->getClientID()); + $cs = $this->getPage()->getClientScript(); + $cs->registerCallbackControl(get_class($this),$this->getCallbackOptions()); + } + + /** + * @return array list of callback options. + */ + protected function getCallbackOptions() + { + return array_merge($this->getPostBackOptions(), + $this->getClientSide()->getOptions()->toArray()); + } + + /** + * Returns the javascript statement to invoke a callback request for this + * control. Additional options for callback can be set via subproperties of + * {@link getClientSide ClientSide} property. E.g. ClientSide.OnSuccess="..." + * @param TControl callback handler control, use current object if null. + * @return string javascript statement to invoke a callback. + */ + public function getCallbackReference($control=null) + { + $client = $this->getPage()->getClientScript(); + $object = is_null($control) ? $this : $control; + return $client->getCallbackReference($object, $this->getPostBackOptions()); + } +} + +?> \ No newline at end of file diff --git a/framework/Web/UI/ActiveControls/TCallbackClientSideOptions.php b/framework/Web/UI/ActiveControls/TCallbackClientSideOptions.php index 8c6732e3..3eadcd29 100644 --- a/framework/Web/UI/ActiveControls/TCallbackClientSideOptions.php +++ b/framework/Web/UI/ActiveControls/TCallbackClientSideOptions.php @@ -221,11 +221,12 @@ class TCallbackClientSideOptions extends TClientSideOptions /** * @return boolean true if the callback request has priority and will abort * existing prioritized request in order to send immediately. It does not - * affect callbacks that are not prioritized. + * affect callbacks that are not prioritized. Default is true. */ public function getHasPriority() { - return $this->getOption('HasPriority'); + $option = $this->getOption('HasPriority'); + return is_null($option) ? true : $option; } /** @@ -257,11 +258,12 @@ class TCallbackClientSideOptions extends TClientSideOptions /** * @return boolean client-side viewstate will be updated on callback - * response if true. + * response if true. Default is true. */ public function getEnablePageStateUpdate() { - return $this->getOption('EnablePageStateUpdate'); + $option = $this->getOption('EnablePageStateUpdate'); + return is_null($option) ? true : $option; } } -- cgit v1.2.3