summaryrefslogtreecommitdiff
path: root/framework/Web/UI/ActiveControls
diff options
context:
space:
mode:
authorwei <>2006-08-11 06:55:09 +0000
committerwei <>2006-08-11 06:55:09 +0000
commit6dd529fdc25404da07cf9256d92f2a94985c65fc (patch)
tree71626b8d6190b377fcd72261e60edbbab59c320b /framework/Web/UI/ActiveControls
parentb687748278d29510bb28875627c98b5da0a96cc5 (diff)
Update callback request client-side API.
Diffstat (limited to 'framework/Web/UI/ActiveControls')
-rw-r--r--framework/Web/UI/ActiveControls/TBaseActiveControl.php15
1 files changed, 10 insertions, 5 deletions
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()
{