Author: mindbridge
Date: Wed Feb 8 12:29:55 2006
New Revision: 376052
URL: http://svn.apache.org/viewcvs?rev=376052&view=rev
Log:
Updating the Submit components documentation.
Making the explanation of 'action' and 'listener' more
explicit.
Modified:
jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/ImageSubmit.jwc
jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/LinkSubmit.jwc
jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/Submit.jwc
Modified:
jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/ImageSubmit.jwc
URL:
http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/ImageSubmit.jwc?rev=376052&r1=376051&r2=376052&view=diff
==============================================================================
---
jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/ImageSubmit.jwc
(original)
+++
jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/ImageSubmit.jwc
Wed Feb 8 12:29:55 2006
@@ -57,15 +57,19 @@
<parameter name="listener">
<description>
- Notified when the button is clicked.
+ A listener that is notified when this component is triggered.
+ The listener is notified immediately when the component is
identified as clicked.
+ This behaviour is useful when the component is in a loop, but not
all elements
+ enclosed by the Form would have had a chance to update their
properties at the
+ time of the listener invocation. Please see the 'action' parameter
as an alternative.
</description>
</parameter>
<parameter name="action">
<description>
- A listener that is notified if this component is triggered
- just before the form's listener, after all components
- enclosed by the Form have had a chance to update their properties.
+ A listener that is notified when this component is triggered.
+ The listener notification is delayed until all components enclosed
by the Form
+ have had a chance to update their properties.
</description>
</parameter>
Modified:
jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/LinkSubmit.jwc
URL:
http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/LinkSubmit.jwc?rev=376052&r1=376051&r2=376052&view=diff
==============================================================================
---
jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/LinkSubmit.jwc
(original)
+++
jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/LinkSubmit.jwc
Wed Feb 8 12:29:55 2006
@@ -32,14 +32,18 @@
<parameter name="listener">
<description>
- A listener that is notified if this component is triggered.
+ A listener that is notified when this component is triggered.
+ The listener is notified immediately when the component is
identified as clicked.
+ This behaviour is useful when the component is in a loop, but not
all elements
+ enclosed by the Form would have had a chance to update their
properties at the
+ time of the listener invocation. Please see the 'action' parameter
as an alternative.
</description>
</parameter>
<parameter name="action">
<description>
- A listener that is notified if this component is triggered
- just before the form's listener, after all components
- enclosed by the Form have had a chance to update their properties.
+ A listener that is notified when this component is triggered.
+ The listener notification is delayed until all components enclosed
by the Form
+ have had a chance to update their properties.
</description>
</parameter>
<parameter name="parameters">
Modified:
jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/Submit.jwc
URL:
http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/Submit.jwc?rev=376052&r1=376051&r2=376052&view=diff
==============================================================================
---
jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/Submit.jwc
(original)
+++
jakarta/tapestry/trunk/framework/src/java/org/apache/tapestry/form/Submit.jwc
Wed Feb 8 12:29:55 2006
@@ -52,14 +52,18 @@
</parameter>
<parameter name="listener">
<description>
- A listener that is notified if this component is triggered.
+ A listener that is notified when this component is triggered.
+ The listener is notified immediately when the component is
identified as clicked.
+ This behaviour is useful when the component is in a loop, but not
all elements
+ enclosed by the Form would have had a chance to update their
properties at the
+ time of the listener invocation. Please see the 'action' parameter
as an alternative.
</description>
</parameter>
<parameter name="action">
<description>
- A listener that is notified if this component is triggered
- just before the form's listener, after all components
- enclosed by the Form have had a chance to update their properties.
+ A listener that is notified when this component is triggered.
+ The listener notification is delayed until all components enclosed
by the Form
+ have had a chance to update their properties.
</description>
</parameter>
<parameter name="parameters">
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
