Repository: tapestry-5 Updated Branches: refs/heads/master 2650b107c -> 24d47d1a2
TAP5-2111: Improve ZoneRefresh javadoc, point out that is triggers the 'refresh' event. Project: http://git-wip-us.apache.org/repos/asf/tapestry-5/repo Commit: http://git-wip-us.apache.org/repos/asf/tapestry-5/commit/24d47d1a Tree: http://git-wip-us.apache.org/repos/asf/tapestry-5/tree/24d47d1a Diff: http://git-wip-us.apache.org/repos/asf/tapestry-5/diff/24d47d1a Branch: refs/heads/master Commit: 24d47d1a2ea7f6c79d215cd98c38a0ff66c0d3eb Parents: 2650b10 Author: Jochen Kemnade <jochen.kemn...@eddyson.de> Authored: Tue Jun 3 17:04:15 2014 +0200 Committer: Jochen Kemnade <jochen.kemn...@eddyson.de> Committed: Tue Jun 3 17:04:15 2014 +0200 ---------------------------------------------------------------------- .../apache/tapestry5/corelib/mixins/ZoneRefresh.java | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/24d47d1a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/mixins/ZoneRefresh.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/mixins/ZoneRefresh.java b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/mixins/ZoneRefresh.java index 6eb6dab..130f7dc 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/mixins/ZoneRefresh.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/mixins/ZoneRefresh.java @@ -19,6 +19,7 @@ import org.apache.tapestry5.ComponentResources; import org.apache.tapestry5.EventConstants; import org.apache.tapestry5.Link; import org.apache.tapestry5.annotations.AfterRender; +import org.apache.tapestry5.annotations.Events; import org.apache.tapestry5.annotations.InjectContainer; import org.apache.tapestry5.annotations.Parameter; import org.apache.tapestry5.corelib.components.Zone; @@ -28,14 +29,19 @@ import org.apache.tapestry5.services.javascript.JavaScriptSupport; /** * <p> - * This mixin periodically refreshs a @{link org.apache.tapestry5.corelib.components.Zone zone} + * This mixin periodically refreshs a {@link org.apache.tapestry5.corelib.components.Zone zone} * by triggering an event on the server using ajax requests. * </p> - * <p/> - * <b>Note: </b> This mixin is only meant for a @{link org.apache.tapestry5.corelib.components.Zone zone} + * <p> + * Server-side, the mixin triggers the "refresh" event with the mixin's context. A container may but + * does not need to handle the event. If the event is handled and a value is returned, that value is + * used to render the response. Otherwise, the Zone's body is re-rendered. + * </p> + * <b>Note: </b> This mixin is only meant for a {@link org.apache.tapestry5.corelib.components.Zone zone}. * * @tapestrydoc */ +@Events(EventConstants.REFRESH) public class ZoneRefresh { /**
