* @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; /** * Load active control adapter. */ use Prado\Prado; use Prado\Web\UI\WebControls\TLinkButton; Prado::using('System.Web.UI.ActiveControls.TActiveControlAdapter'); /** * TActiveLinkButton is the active control counter part to TLinkButton. * * When a TActiveLinkButton is clicked, rather than a normal post back request a * callback request is initiated. * * The {@link onCallback OnCallback} event is raised during a callback request * and it is raise after the {@link onClick OnClick} event. * * When the {@link TBaseActiveCallbackControl::setEnableUpdate ActiveControl.EnableUpdate} * property is true, changing the {@link setText Text} property during callback request * will update the link text upon callback response completion. * * @author Wei Zhuo * @package Prado\Web\UI\ActiveControls * @since 3.1 */ class TActiveLinkButton extends TLinkButton implements IActiveControl, ICallbackEventHandler { /** * Creates a new callback control, sets the adapter to * TActiveControlAdapter. If you override this class, be sure to set the * adapter appropriately by, for example, by calling this constructor. */ 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(); } /** * Raises the callback event. This method is required by * {@link ICallbackEventHandlerICallbackEventHandler} interface. If * {@link getCausesValidation CausesValidation} is true, it will * invoke the page's {@link TPage::validate validate} method first. It will raise * {@link onClick OnClick} event first and then the {@link onCallback OnCallback} * 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); } /** * Updates the link text on the client-side if the * {@link setEnableUpdate EnableUpdate} property is set to true. * @param string caption of the button */ public function setText($value) { parent::setText($value); if($this->getActiveControl()->canUpdateClientSide()) $this->getPage()->getCallbackClient()->update($this, $value); } /** * Override parent implementation, no javascript is rendered here instead * the javascript required for active control is registered in {@link addAttributesToRender}. */ protected function renderClientControlScript($writer) { } /** * Ensure that the ID attribute is rendered and registers the javascript code * for initializing the active control. */ protected function addAttributesToRender($writer) { parent::addAttributesToRender($writer); $writer->addAttribute('id',$this->getClientID()); if($this->getEnabled(true)) { $this->getActiveControl()->registerCallbackClientScript( $this->getClientClassName(), $this->getPostBackOptions()); } } /** * Ensures that the anchor is rendered correctly when its Enabled property * changes in a callback * @param bool enabled */ public function setEnabled($value) { parent::setEnabled($value); if($this->getActiveControl()->canUpdateClientSide()) { if($this->getEnabled(true)) { $nop = "javascript:;//".$this->getClientID(); $this->getPage()->getCallbackClient()->setAttribute($this, 'href', $nop); $this->getActiveControl()->registerCallbackClientScript( $this->getClientClassName(), $this->getPostBackOptions()); } else { $this->getPage()->getCallbackClient()->setAttribute($this, 'href', false); } } } /** * @return string corresponding javascript class name for this TActiveLinkButton. */ protected function getClientClassName() { return 'Prado.WebUI.TActiveLinkButton'; } }