Author: bdotte
Date: Fri Jul 27 15:01:57 2007
New Revision: 560399
URL: http://svn.apache.org/viewvc?view=rev&rev=560399
Log:
Update site documentation with addition of implicit listeners on the XTile,
DirectLink, InvokeListener, and Suggest components made for TAPESTRY-394.
Modified:
tapestry/tapestry4/trunk/src/site/xdoc/components/general/invokelistener.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/link/directlink.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/scriptaculous/suggest.xml
tapestry/tapestry4/trunk/src/site/xdoc/usersguide/listenermethods.xml
tapestry/tapestry4/trunk/tapestry-contrib/src/site/xdoc/componentreference/xtile.xml
Modified:
tapestry/tapestry4/trunk/src/site/xdoc/components/general/invokelistener.xml
URL:
http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/general/invokelistener.xml?view=diff&rev=560399&r1=560398&r2=560399
==============================================================================
---
tapestry/tapestry4/trunk/src/site/xdoc/components/general/invokelistener.xml
(original)
+++
tapestry/tapestry4/trunk/src/site/xdoc/components/general/invokelistener.xml
Fri Jul 27 15:01:57 2007
@@ -57,9 +57,12 @@
IActionListener
</a>
</td>
- <td>yes</td>
+ <td>no</td>
<td></td>
- <td>The listener to invoke.</td>
+ <td>The listener to invoke. If this parameter is not
provided,
+ Tapestry will attempt to find a listener with
the capitalized id of the
+ component, prefixed by "do". For example,
jwcid="[EMAIL PROTECTED]" would
+ expect a listener called doClear().</td>
</tr>
<tr>
Modified: tapestry/tapestry4/trunk/src/site/xdoc/components/link/directlink.xml
URL:
http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/link/directlink.xml?view=diff&rev=560399&r1=560398&r2=560399
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/link/directlink.xml
(original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/link/directlink.xml Fri
Jul 27 15:01:57 2007
@@ -65,12 +65,14 @@
IActionListener
</a>
</td>
- <td>yes</td>
+ <td>no</td>
<td> </td>
<td>
Specifies an object that is notified when the link
is clicked, which is
typically a listener method of its container (for
example, listeners.
- <em>method</em>).
+ <em>method</em>). If this parameter is not
provided, Tapestry will attempt
+ to find a listener with the capitalized id of
the component, prefixed by
+ "do". For example, jwcid="[EMAIL PROTECTED]"
would expect a listener called doClear().
</td>
</tr>
<tr>
Modified:
tapestry/tapestry4/trunk/src/site/xdoc/components/scriptaculous/suggest.xml
URL:
http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/scriptaculous/suggest.xml?view=diff&rev=560399&r1=560398&r2=560399
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/scriptaculous/suggest.xml
(original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/scriptaculous/suggest.xml
Fri Jul 27 15:01:57 2007
@@ -154,14 +154,17 @@
IActionListener
</a>
</td>
- <td>yes</td>
+ <td>no</td>
<td> </td>
<td>
Specifies an object that is notified when input is
typed in to the field, which is
typically a listener method of its container (for
example, listeners.
<em>method</em>). This listener method will by
default contain exactly one parameter of type String when
invoked - which wil be the value that was typed in
to the field in the browser. You may add other
- additional parameters using the <b>parameters</b>
parameter of this component.
+ additional parameters using the <b>parameters</b>
parameter of this component. If this parameter is not provided,
+ Tapestry will attempt to find a listener with
the capitalized id of the
+ component, prefixed by "do". For example,
jwcid="[EMAIL PROTECTED]" would expect
+ a listener called doNameSearch().
<br /><br />
Modified: tapestry/tapestry4/trunk/src/site/xdoc/usersguide/listenermethods.xml
URL:
http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/usersguide/listenermethods.xml?view=diff&rev=560399&r1=560398&r2=560399
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/usersguide/listenermethods.xml
(original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/usersguide/listenermethods.xml Fri
Jul 27 15:01:57 2007
@@ -35,7 +35,12 @@
<a href="../components/form/form.html">Form</a>
take a listener parameter, and you can use a listener:
<a href="bindings.html">binding reference</a>
- to use a listener method in your class as the listener.
+ to use a listener method in your class as the listener. As of
Tapestry 4.1.3, components
+ that require a listener (XTile, DirectLink, InvokeListener,
Suggest) no longer need
+ an explicit listener provided for their "listener" parameter as
long as a listener method
+ exists on the component whose name is composed of the
capitalized component id, prefixed
+ by "do". For example, jwcid="[EMAIL PROTECTED]" would expect a
listener method called
+ doClear() if the listener parameter is not used.
</p>
<span class="info">
Modified:
tapestry/tapestry4/trunk/tapestry-contrib/src/site/xdoc/componentreference/xtile.xml
URL:
http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/tapestry-contrib/src/site/xdoc/componentreference/xtile.xml?view=diff&rev=560399&r1=560398&r2=560399
==============================================================================
---
tapestry/tapestry4/trunk/tapestry-contrib/src/site/xdoc/componentreference/xtile.xml
(original)
+++
tapestry/tapestry4/trunk/tapestry-contrib/src/site/xdoc/componentreference/xtile.xml
Fri Jul 27 15:01:57 2007
@@ -59,14 +59,17 @@
IActionListener
</a>
</td>
- <td>yes</td>
+ <td>no</td>
<td></td>
<td>
The listener that will be invoked when the
Javascript function with the
given name is invoked. Any parameters passed to
the send function will
be available from
<code>cycle.getListenerParameters()</code>. In addition, the
listener can perform
<code>cycle.setListenerParameters()</code> to pass an array of
- strings to the JavaScript receive function.
+ strings to the JavaScript receive function. If
this parameter is not provided,
+ Tapestry will attempt to find a listener with
the capitalized id of the
+ component, prefixed by "do". For example,
jwcid="[EMAIL PROTECTED]" would expect
+ a listener called doClear().
</td>
</tr>
