From 3490b6226263b05d980d040a8fbf933c23979ab6 Mon Sep 17 00:00:00 2001
From: "ctrlaltca@gmail.com" <>
Date: Thu, 2 Jun 2011 17:44:51 +0000
Subject: documentation updates: TCallback, TEventTriggeredCallback,
TValueTriggeredCallback, TTimeTriggeredCallback
---
.gitattributes | 12 ++++
.../protected/pages/ActiveControls/Callback.page | 34 ++++++++++
.../ActiveControls/EventTriggeredCallback.page | 15 +++++
.../protected/pages/ActiveControls/Home.page | 78 ++++++++++++++++------
.../ActiveControls/Samples/TCallback/Home.page | 57 ++++++++++++++++
.../ActiveControls/Samples/TCallback/Home.php | 24 +++++++
.../Samples/TEventTriggeredCallback/Home.page | 18 +++++
.../Samples/TEventTriggeredCallback/Home.php | 16 +++++
.../Samples/TTimeTriggeredCallback/Home.page | 24 +++++++
.../Samples/TTimeTriggeredCallback/Home.php | 22 ++++++
.../Samples/TValueTriggeredCallback/Home.page | 17 +++++
.../Samples/TValueTriggeredCallback/Home.php | 11 +++
.../ActiveControls/TimeTriggeredCallback.page | 16 +++++
.../ActiveControls/ValueTriggeredCallback.page | 18 +++++
framework/Web/UI/ActiveControls/TCallback.php | 4 +-
.../UI/ActiveControls/TValueTriggeredCallback.php | 2 +-
16 files changed, 343 insertions(+), 25 deletions(-)
create mode 100644 demos/quickstart/protected/pages/ActiveControls/Callback.page
create mode 100644 demos/quickstart/protected/pages/ActiveControls/EventTriggeredCallback.page
create mode 100644 demos/quickstart/protected/pages/ActiveControls/Samples/TCallback/Home.page
create mode 100644 demos/quickstart/protected/pages/ActiveControls/Samples/TCallback/Home.php
create mode 100644 demos/quickstart/protected/pages/ActiveControls/Samples/TEventTriggeredCallback/Home.page
create mode 100644 demos/quickstart/protected/pages/ActiveControls/Samples/TEventTriggeredCallback/Home.php
create mode 100644 demos/quickstart/protected/pages/ActiveControls/Samples/TTimeTriggeredCallback/Home.page
create mode 100644 demos/quickstart/protected/pages/ActiveControls/Samples/TTimeTriggeredCallback/Home.php
create mode 100644 demos/quickstart/protected/pages/ActiveControls/Samples/TValueTriggeredCallback/Home.page
create mode 100644 demos/quickstart/protected/pages/ActiveControls/Samples/TValueTriggeredCallback/Home.php
create mode 100644 demos/quickstart/protected/pages/ActiveControls/TimeTriggeredCallback.page
create mode 100644 demos/quickstart/protected/pages/ActiveControls/ValueTriggeredCallback.page
diff --git a/.gitattributes b/.gitattributes
index 27bf95a3..73d5f678 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -1292,10 +1292,12 @@ demos/quickstart/protected/pages/ActiveControls/ActiveRadioButtonList.page -text
demos/quickstart/protected/pages/ActiveControls/ActiveRepeater.page -text
demos/quickstart/protected/pages/ActiveControls/ActiveTextBox.page -text
demos/quickstart/protected/pages/ActiveControls/AutoComplete.page -text
+demos/quickstart/protected/pages/ActiveControls/Callback.page -text
demos/quickstart/protected/pages/ActiveControls/CallbackClientScript.page -text
demos/quickstart/protected/pages/ActiveControls/CallbackClientSide.page -text
demos/quickstart/protected/pages/ActiveControls/CallbackOptions.page -text
demos/quickstart/protected/pages/ActiveControls/DragDrop.page -text
+demos/quickstart/protected/pages/ActiveControls/EventTriggeredCallback.page -text
demos/quickstart/protected/pages/ActiveControls/Home.page -text
demos/quickstart/protected/pages/ActiveControls/Introduction.page -text
demos/quickstart/protected/pages/ActiveControls/Samples/DragDrop/Home.page -text
@@ -1356,15 +1358,25 @@ demos/quickstart/protected/pages/ActiveControls/Samples/TActiveTextBox/Home.page
demos/quickstart/protected/pages/ActiveControls/Samples/TActiveTextBox/Home.php -text
demos/quickstart/protected/pages/ActiveControls/Samples/TAutoComplete/Home.page -text
demos/quickstart/protected/pages/ActiveControls/Samples/TAutoComplete/Home.php -text
+demos/quickstart/protected/pages/ActiveControls/Samples/TCallback/Home.page -text
+demos/quickstart/protected/pages/ActiveControls/Samples/TCallback/Home.php -text
demos/quickstart/protected/pages/ActiveControls/Samples/TCallbackClientScript/Home.page -text
demos/quickstart/protected/pages/ActiveControls/Samples/TCallbackClientScript/Home.php -text
demos/quickstart/protected/pages/ActiveControls/Samples/TCallbackClientSide/Home.page -text
demos/quickstart/protected/pages/ActiveControls/Samples/TCallbackClientSide/Home.php -text
demos/quickstart/protected/pages/ActiveControls/Samples/TCallbackOptions/Home.page -text
demos/quickstart/protected/pages/ActiveControls/Samples/TCallbackOptions/Home.php -text
+demos/quickstart/protected/pages/ActiveControls/Samples/TEventTriggeredCallback/Home.page -text
+demos/quickstart/protected/pages/ActiveControls/Samples/TEventTriggeredCallback/Home.php -text
+demos/quickstart/protected/pages/ActiveControls/Samples/TTimeTriggeredCallback/Home.page -text
+demos/quickstart/protected/pages/ActiveControls/Samples/TTimeTriggeredCallback/Home.php -text
+demos/quickstart/protected/pages/ActiveControls/Samples/TValueTriggeredCallback/Home.page -text
+demos/quickstart/protected/pages/ActiveControls/Samples/TValueTriggeredCallback/Home.php -text
demos/quickstart/protected/pages/ActiveControls/Samples/config.xml -text
demos/quickstart/protected/pages/ActiveControls/TActiveButtonClass.png -text
demos/quickstart/protected/pages/ActiveControls/TActiveButtonClass.vsd -text
+demos/quickstart/protected/pages/ActiveControls/TimeTriggeredCallback.page -text
+demos/quickstart/protected/pages/ActiveControls/ValueTriggeredCallback.page -text
demos/quickstart/protected/pages/ActiveControls/id/ActiveButton.page -text
demos/quickstart/protected/pages/ActiveControls/id/ActiveCheckBox.page -text
demos/quickstart/protected/pages/ActiveControls/id/ActiveCustomValidator.page -text
diff --git a/demos/quickstart/protected/pages/ActiveControls/Callback.page b/demos/quickstart/protected/pages/ActiveControls/Callback.page
new file mode 100644
index 00000000..d37eb614
--- /dev/null
+++ b/demos/quickstart/protected/pages/ActiveControls/Callback.page
@@ -0,0 +1,34 @@
+
+TCallback provides a basic callback handler that can be invoked from the
+client side by using the javascript ojbect obtained from the
+ActiveControl.Javascript property.
+You can set the CallbackParameter property from javascript directly on
+the object returned by ActiveControl.Javascript.
+Once you are ready, you can call the dispatch() method on the object to
+execute the callback.
+The server-side event OnCallback is raised when a callback is requested made.
+
+Example usage:
+
+TEventTriggeredCallback triggers a new callback request when a particular EventName
+on a control with ID given by ControlID is raised.
+The default action of the event on the client-side can be prevented when
+PreventDefaultAction is set to true.
+TCallback
+TEventTriggeredCallback
+
The following classes provide the basic infrastructure classes required to -realize the active controls.
+realize the active controls. They can be useful to develop new active controls, but Prado users tipically don't need +to use them.+ TActiveControlAdapter customizes the parent TControl class for active control classes. + It tracks changes in the viewstate values of the control and update + differences of the client-side HTML element attributes. +
++ TActiveListControlAdapter allows the adapted list controls to change the selections + on the client-side during a callback request. +
+ TActivePageAdapter process the page life-cycle for callback requests. +
+ TBaseActiveControl class provided additional basic properties common for every + active control. An instance of TBaseActiveControl or its decendent + TBaseActiveCallbackControl is created by TActiveControlAdapter::getBaseActiveControl() + method. + The EnableUpdate property determines wether the active + control is allowed to update the contents of the client-side when the callback + response returns. +
+ TCallbackResponseAdapter alters the THttpResponse's outputs. + A TCallbackResponseWriter is used instead of the TTextWrite when + createHtmlWriter is called. Each call to createHtmlWriter will create + a new TCallbackResponseWriter. When flushContent() is called each + instance of TCallbackResponseWriter's content is flushed. + The callback response data can be set using the ResponseData property. +
The following classes provide advanced properties and events needed to realize the active controls. +A Prado user can use them to customize active controls behaviour and interact directly with the client side during a callback. +
++An active label text being set as the result of a callback: + |
+
+ Click Me!
+ |
+A TCallback with a 3-items array as parameter. +The first parameter is defined in the onclick() attribute of the red div; +The second parameter is defined in the body of the javascript function; +The third parameter is taken from the textbox; + |
+
+ Click Me!
+Parameter 1 is Parameter 2 is Parameter 3 is |
+ A callback will be executed when the textbox receives and loses focus + |
+ |
+A timer updating a label with the current time every 5 seconds: + |
+ |
+ A callback will be executed when the textbox text changes + |
+ |
+TTimeTriggeredCallback sends callback request every Interval seconds. +Upon each callback request, the OnCallback event is raised. +The timer can be started by calling startTimer() and stopped using +stopTimer(). The timer can be automatically started when +StartTimerOnLoad is true. +
+ ++TValueTriggeredCallback observes the value with PropertyName of a +control with ControlID. Changes to the observed +property value will trigger a new callback request. The property value is checked +for changes every Interval seconds. +A DecayRate can be set to increase the polling +interval linearly if no changes are observed. Once a change is +observed, the polling interval is reset to the original value. +
+ +
diff --git a/framework/Web/UI/ActiveControls/TValueTriggeredCallback.php b/framework/Web/UI/ActiveControls/TValueTriggeredCallback.php
index 4f7c8332..d87af4dc 100644
--- a/framework/Web/UI/ActiveControls/TValueTriggeredCallback.php
+++ b/framework/Web/UI/ActiveControls/TValueTriggeredCallback.php
@@ -22,7 +22,7 @@ Prado::using('System.Web.UI.ActiveControls.TTriggeredCallback');
*
* A {@link setDecayRate DecayRate} can be set to increase the polling
* interval linearly if no changes are observed. Once a change is
- * observe, the polling interval is reset to the original value.
+ * observed, the polling interval is reset to the original value.
*
* @author Wei Zhuo
* @version $Id$
--
cgit v1.2.3