From 6dd529fdc25404da07cf9256d92f2a94985c65fc Mon Sep 17 00:00:00 2001
From: wei <>
Date: Fri, 11 Aug 2006 06:55:09 +0000
Subject: Update callback request client-side API.

---
 framework/Web/UI/ActiveControls/TBaseActiveControl.php | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

(limited to 'framework/Web/UI')

diff --git a/framework/Web/UI/ActiveControls/TBaseActiveControl.php b/framework/Web/UI/ActiveControls/TBaseActiveControl.php
index 0c95a6a5..cb944253 100644
--- a/framework/Web/UI/ActiveControls/TBaseActiveControl.php
+++ b/framework/Web/UI/ActiveControls/TBaseActiveControl.php
@@ -334,11 +334,16 @@ class TBaseActiveCallbackControl extends TBaseActiveControl
 	}
 
 	/**
-	 * 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="..."
-	 * @return string javascript statement to invoke a callback.
+	 * Returns the javascript callback request instance. To invoke a callback
+	 * request for this control call the <tt>dispatch()</tt> method on the
+	 * request instance. Example code in javascript
+	 * <code>
+	 *   request = <%= $this->mycallback->ActiveControl->Javascript %>;
+	 *   request.setParameter('hello');
+	 *   request.dispatch(); //make the callback request.
+	 * </code>
+	 * @return string javascript client-side callback request object (javascript
+	 * code)
 	 */
 	public function getJavascript()
 	{
-- 
cgit v1.2.3