* Prado 3.3.0

1 files changed, 99 insertions, 0 deletions

diff --git a/lib/prado/framework/Web/UI/ActiveControls/TCallback.php b/lib/prado/framework/Web/UI/ActiveControls/TCallback.php
new file mode 100644
index 0000000..1aae6ce
--- /dev/null
+++ b/lib/prado/framework/Web/UI/ActiveControls/TCallback.php
@@ -0,0 +1,99 @@
+<?php
+/**
+ * TCallback class file.
+ *
+ * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
+ * @link https://github.com/pradosoft/prado
+ * @copyright Copyright &copy; 2005-2015 The PRADO Group
+ * @license https://github.com/pradosoft/prado/blob/master/COPYRIGHT
+ * @package System.Web.UI.ActiveControls
+ */
+
+/**
+ * Load active control adapter.
+ */
+Prado::using('System.Web.UI.ActiveControls.TActiveControlAdapter');
+
+/**
+ * TCallback component class.
+ *
+ * The TCallback provides a basic callback handler that can be invoked from the
+ * client side by running the javascript code obtained from the
+ * {@link TBaseActiveCallbackControl::getJavascript ActiveControl.Javascript} property.
+ * The event {@link onCallback OnCallback} is raised when a callback is requested made.
+ *
+ * Example usage:
+ * <code>
+ * 	<com:TCallback ID="callback1" OnCallback="callback1_Requested" />
+ *  <script type="text/javascript">
+ * 		function do_callback1()
+ *      {
+ *           var request = <%= $this->callback1->ActiveControl->Javascript %>;
+ *			 request.dispatch();
+ *      }
+ *  </script>
+ *  <div onclick="do_callback1()">Click Me!</div>
+ * </code>
+ *
+ * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
+ * @package System.Web.UI.ActiveControls
+ * @since 3.1
+ */
+class TCallback extends TControl implements ICallbackEventHandler, IActiveControl
+{
+	/**
+	 * 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, call this constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+		$this->setAdapter(new TActiveControlAdapter($this));
+	}
+
+	/**
+	 * @return TBaseActiveCallbackControl standard callback 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 ICallbackEventHandler ICallbackEventHandler} interface. If
+	 * {@link getCausesValidation ActiveControl.CausesValidation} is true,
+	 * it will invoke the page's {@link TPage::validate validate} method first.
+	 * It will raise {@link onCallback OnCallback} event. This method is mainly
+	 * used by framework and control developers.
+	 * @param TCallbackEventParameter the event parameter
+	 */
+	public function raiseCallbackEvent($param)
+	{
+		if($this->getActiveControl()->canCauseValidation())
+			$this->getPage()->validate($this->getActiveControl()->getValidationGroup());
+		$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);
+	}
+}
+