You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tapestry.apache.org by hl...@apache.org on 2012/08/11 00:07:25 UTC

[8/13] git commit: Improve documentation for the events module Simplify the module to simply define an object, rather than provide a callback, etc.

Improve documentation for the events module
Simplify the module to simply define an object, rather than provide a callback, etc.


Project: http://git-wip-us.apache.org/repos/asf/tapestry-5/repo
Commit: http://git-wip-us.apache.org/repos/asf/tapestry-5/commit/b9aeec36
Tree: http://git-wip-us.apache.org/repos/asf/tapestry-5/tree/b9aeec36
Diff: http://git-wip-us.apache.org/repos/asf/tapestry-5/diff/b9aeec36

Branch: refs/heads/5.4-js-rewrite
Commit: b9aeec36ff7b63e1e28b6c6d224cc377425564fe
Parents: 309253a
Author: Howard M. Lewis Ship <hl...@apache.org>
Authored: Fri Aug 10 11:40:29 2012 -0700
Committer: Howard M. Lewis Ship <hl...@apache.org>
Committed: Fri Aug 10 11:40:29 2012 -0700

----------------------------------------------------------------------
 .../META-INF/modules/core/events.coffee            |   22 +++++++++-----
 1 files changed, 14 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/b9aeec36/tapestry-core/src/main/coffeescript/META-INF/modules/core/events.coffee
----------------------------------------------------------------------
diff --git a/tapestry-core/src/main/coffeescript/META-INF/modules/core/events.coffee b/tapestry-core/src/main/coffeescript/META-INF/modules/core/events.coffee
index 15993d7..9832c02 100644
--- a/tapestry-core/src/main/coffeescript/META-INF/modules/core/events.coffee
+++ b/tapestry-core/src/main/coffeescript/META-INF/modules/core/events.coffee
@@ -12,19 +12,25 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# ## core/events
+#
 # This module defines logical names for all events that Tapestry-controlled elements
 # trigger or listener for. Prototype requires that all custom events have a namespace prefix; jQuery appears to
 # allow it without issue.
-define [], ->
-  zone: # Invoked on a zone element to force an update to its content. The event memo is the
-  # new content (an Element, or a string containing HTML markup). A top-level handler
-  # is responsible for the actual update; it fires an event on the element just before,
-  # and just after, the content is changed.
+define
+  # Defines a number of event names specific to Tapestry Zones. Zones are Tapestry components that are structured
+  # to correctly support dynamic updates from the server via an Ajax request, and a standard response
+  # (the partial page render reponse). More details are available in the `core/zone` module.
+  zone:
+    # Invoked on a zone element to force an update to its content. The event memo is the new content (an Element, or a
+    # `core/spi:ElementWrapper`, or a string containing HTML markup). A standard top-level handler is defined by module
+    # `core/zone`, and is responsible for the actual update; it triggers the `events.zone.willUpdate` and
+    # `events.zone.didUpdate` events just before and just after changing the element's content.
     update: "t5:zone-update"
 
-    # Triggered just before the content in a Zone will be updated.
+    # Triggered (by the standard handler) just before the content in a Zone will be updated.
     willUpdate: "t5:zone-will-update"
 
-    # Triggered just afer the content in a Zone has updated. If the zone was not visible,
-    # it is made visible after its content is changed, and before this event is triggered.
+    # Triggered (by the standard hanndler) just after the content in a Zone has updated. If the zone was not visible, it
+    # is made visible after its content is changed, and before this event is triggered.
     didUpdate: "t5:zone-did-update"
\ No newline at end of file