Author: mindbridge
Date: Wed Feb 8 12:25:10 2006
New Revision: 376049
URL: http://svn.apache.org/viewcvs?rev=376049&view=rev
Log:
Updating the Submit components documentation.
Making the explanation of 'action' and 'listener' more
explicit.
Modified:
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ImageSubmit.xml
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/LinkSubmit.xml
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Submit.xml
Modified:
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ImageSubmit.xml
URL:
http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ImageSubmit.xml?rev=376049&r1=376048&r2=376049&view=diff
==============================================================================
---
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ImageSubmit.xml
(original)
+++
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ImageSubmit.xml
Wed Feb 8 12:25:10 2006
@@ -135,31 +135,32 @@
</td>
</tr>
- <tr>
- <td>listener</td>
- <td>
- &IActionListener;
- </td>
+ <tr>
+ <td>action</td>
+ <td>&IActionListener;</td>
<td>in</td>
<td>no</td>
<td> </td>
<td>
- An optional listener (typically specified as the name of a listener
method), notified
- when the Submit is triggered.
+ 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.
</td>
- </tr>
+ </tr>
<tr>
- <td>action</td>
+ <td>listener</td>
<td>&IActionListener;</td>
<td>in</td>
<td>no</td>
<td> </td>
<td>
- 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 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.
</td>
- </tr>
+ </tr>
<tr>
<td>parameters</td>
<td>Object</td>
Modified:
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/LinkSubmit.xml
URL:
http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/LinkSubmit.xml?rev=376049&r1=376048&r2=376049&view=diff
==============================================================================
---
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/LinkSubmit.xml
(original)
+++
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/LinkSubmit.xml
Wed Feb 8 12:25:10 2006
@@ -71,10 +71,23 @@
</td>
</tr>
<tr>
+ <td>action</td>
+ <td>&IActionListener;</td> <td>in</td> <td>no</td> <td> </td>
+ <td>
+ 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.
+ </td>
+ </tr>
+ <tr>
<td>listener</td>
<td>&IActionListener;</td> <td>in</td> <td>no</td> <td> </td>
<td>
- If specified, the listener is notified. This notification occurs as
the component is rewinded, i.e., prior to the Form's listener. In addition, the
selected property (if bound) will be updated before the listener is notified.
+ 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.
</td>
</tr>
</table>
Modified:
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Submit.xml
URL:
http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Submit.xml?rev=376049&r1=376048&r2=376049&view=diff
==============================================================================
---
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Submit.xml
(original)
+++
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Submit.xml
Wed Feb 8 12:25:10 2006
@@ -47,11 +47,11 @@
<p>
It is even possible to combine the two, in which case the property is set
first,
-then the listener is notified. The listener may be notified immediately
-(i.e., in the middle of processing the form submission) if provided
-via the 'listener' parameter, but if it is provided via the 'action' parameter,
-the listener will be notified later, just before the form's listener (if any)
-is invoked.
+then the listener is notified. The listener may provided via the 'action'
parameter and
+it will be notified when all components enclosed by the Form have had a chance
+to update their properties. Alternatively, the listener can be provided via
the
+'listener' parameter and it will be notified immediately in the middle of
processing
+the form submission.
</p>
@@ -120,28 +120,29 @@
</tr>
<tr>
- <td>listener</td>
- <td>
- &IActionListener;
- </td>
+ <td>action</td>
+ <td>&IActionListener;</td>
<td>in</td>
<td>no</td>
<td> </td>
<td>
- An optional listener (typically specified as the name of a
listener method), notified
- when the Submit is triggered.
+ 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.
</td>
</tr>
<tr>
- <td>action</td>
+ <td>listener</td>
<td>&IActionListener;</td>
<td>in</td>
<td>no</td>
<td> </td>
<td>
- 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 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.
</td>
</tr>
<tr>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
