tapestry-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mindbri...@apache.org
Subject svn commit: r280046 - in /jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference: For.xml GenericLink.xml Rollover.xml ServiceLink.xml
Date Sat, 10 Sep 2005 22:18:54 GMT
Author: mindbridge
Date: Sat Sep 10 15:18:44 2005
New Revision: 280046

URL: http://svn.apache.org/viewcvs?rev=280046&view=rev
Log:
Applying documentation from Warner Onstine for 
GenericLink, Rollover, and ServiceLink
(TAPESTRY-467, TAPESTRY-480, TAPESTRY-484)

Modified:
    jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/For.xml
    jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/GenericLink.xml
    jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Rollover.xml
    jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ServiceLink.xml

Modified: jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/For.xml
URL: http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/For.xml?rev=280046&r1=280045&r2=280046&view=diff
==============================================================================
--- jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/For.xml
(original)
+++ jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/For.xml
Sat Sep 10 15:18:44 2005
@@ -228,7 +228,6 @@
   <p>This example displays a list of customers:</p>
   
 <source><![CDATA[
-...
 <table cellspacing="10">
   <tr>
     <td>ID</td>
@@ -243,24 +242,19 @@
     <td><span jwcid="@Insert" value="ognl:customer.fullName"/></td>
     <td><span jwcid="@Insert" value="ognl:customer.memberLevel"/></td>
   </tr>
-</table>
-...
-]]>
+</table>]]>
 </source>
 
-<p>&nbsp;</p>
-
-  <p><strong>Edit a list of customers</strong></p>
+  <p><br/><strong>Edit a list of customers</strong></p>
   <p>This examples allows the user to edit a list of customers.
      The 'keyExpression' parameter is optional. It tells the component to use the 'id'
      expression to obtain the primary key of the customer. 
-     This approach is particularly useful when the Customer object is not Serializable,
+     The parameter is particularly useful when the Customer object is not Serializable,
      as only the primary key is stored in the hidden fields, 
      rather than the full Customer record.
   </p>
   
 <source><![CDATA[
-...
 <table cellspacing="10">
   <tr>
     <td>ID</td>
@@ -276,9 +270,7 @@
     <td><span jwcid="@PropertySelection" value="ognl:customer.memberLevel"
               model="ognl:@com.mycorp.Customer@MEMBER_LEVEL_MODEL"/></td>
   </tr>
-</table>
-...
-]]>
+</table>]]>
 </source>
       
   

Modified: jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/GenericLink.xml
URL: http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/GenericLink.xml?rev=280046&r1=280045&r2=280046&view=diff
==============================================================================
--- jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/GenericLink.xml
(original)
+++ jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/GenericLink.xml
Sat Sep 10 15:18:44 2005
@@ -28,15 +28,20 @@
   
   <body>
 
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
+<p> Creates an &lt;a&gt; hyperlink for an arbitrary URL.
 </p>
+<p> Although a GenericLink can be accomplished using an &Any; component, a GenericLink
is more flexible: 
+it can be disabled, like a &DirectLink; or &ActionLink; and can also wrap around
&Rollover; components. 
+GenericLinks are often used with javascript: URLs to perform client-side scripting.</p>
 
 <p>
-  <strong>See also:</strong> 
+  <strong>See also: &ActionLink;, &DirectLink;, &ExternalLink;, &PageLink;,
&Rollover;, &ServiceLink;</strong>
+
 </p>
 
 <section>
   <title>Parameters</title>
+
   
 <table>
   <tr> 
@@ -45,17 +50,70 @@
 	  <th>Direction</th>
     <th>Required</th> 
     <th>Default</th>
+
     <th>Description</th>
   </tr>
+  <tr>
+    <td>href</td>
+    <td>String</td>
+
+    <td>in</td>
+
+    <td>yes</td>
+    <td></td>
+    <td>
+      The URL to trigger when the link is clicked. This is often of the form:
+&lt;a&gt; href="javascript:functionName('param')">
+    </td>
+  </tr>
+  <tr>
+
+    <td>disabled</td>
+    <td>boolean</td>
+    <td>in</td>
+    <td>no</td>
+    <td>false</td>
+
+    <td>
+
+      Controls whether the link is produced. If disabled, the portion of the template the
link surrounds is still rendered, but not the link itself.
+    </td>
+  </tr>
+  <tr>
+    <td>anchor</td>
+
+    <td>String</td>
+    <td>in</td>
+
+    <td>no</td>
+    <td></td>
+    <td>
+       The name of an anchor or element to link to. The final URL will have '#' and the anchor
appended to it.
+    </td>
+
+  </tr>
+  <tr>
+    <td>renderer</td>
+
+    <td>&ILinkRenderer;</td>
+    <td>in</td>
+    <td>no</td>
+    <td></td>
+
+    <td>
+      The object which will actually render the link.
+    </td>
+  </tr>
 
 	</table>
   
 <p>
-  Body: <strong>removed / allowed</strong>
-</p>  
+  Body: <strong>rendered</strong>
+</p>
 
 <p>
-  Informal parameters: <strong>allowed  / forbidden</strong>
+
+  Informal parameters: <strong>allowed</strong>
 </p>
 
 <p>
@@ -66,7 +124,10 @@
 
 <section>
   <title>Examples</title>
+  <p>
+Under Construction.
 
+</p>
 </section>
 </body>
-</document>
\ No newline at end of file
+</document>

Modified: jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Rollover.xml
URL: http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Rollover.xml?rev=280046&r1=280045&r2=280046&view=diff
==============================================================================
--- jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Rollover.xml
(original)
+++ jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Rollover.xml
Sat Sep 10 15:18:44 2005
@@ -28,11 +28,19 @@
   
   <body>
 
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
+<p>  The Rollover component provides a rollover image button for use with any kind
of link 
+ component. A rollover button image changes when the mouse move over it or off of it. 
+ A Rollover is disabled if the link that wraps it is disabled (in which case it doesn't 
+ respond to the mouse). If this dynamic behavior isn't required use the simpler &Image;

+ component.
+ </p>
+<p> The component provides all the necessary JavaScript to swap the image when the
mouse 
+enters and exits the button. However, the Rollover must be wrapped (ultimately) by a 
+&Body; component.
 </p>
 
 <p>
-  <strong>See also:</strong> 
+  <strong>See also: &Body;, &GenericLink;, &Image;, &PageLink;, &Script;</strong>

 </p>
 
 <section>
@@ -48,24 +56,89 @@
     <th>Description</th>
   </tr>
 
+  <tr>
+    <td>image</td>
+    <td>&IAsset;</td>
+ 
+    <td>in</td>
+    <td>yes</td>
+    <td></td>
+    <td>
+       The initial image to show, if the surrounding link component is not disabled.
+    </td>
+  </tr>
+
+  <tr>
+    <td>focus</td>
+    <td>&IAsset;</td>
+    <td>in</td>
+    <td>no</td>
+    <td></td>
+
+    <td>
+       If provided (and the component is not disabled), then a JavaScript onMouseOver 
+       event handler is added to change the image. An onMouseOut event handler is also 
+       provided, to change the button to either it's base image, or its blur image.
+    </td>
+  </tr>
+  <tr>
+    <td>blur</td>
+    <td>&IAsset;</td>
+    <td>in</td>
+
+    <td>no</td>
+    <td></td>
+    <td>
+       If provided (and the component is not disabled), then a JavaScript onMouseOut event

+       handler is added to change the image when the mouse is moved off of the image.
+    </td>
+  </tr>
+  <tr>
+    <td>disabled</td>
+
+    <td>&IAsset;</td>
+    <td>in</td>
+    <td>no</td>
+    <td></td>
+    <td>
+       <p>Image used when the Rollover is disabled. A Rollover is disabled when the
 
+       link component containing it is disabled. Note that the Rollover component is wrapped

+       by a link component such as the &PageLink; component.</p>
+		<p>If no disabled asset is specified, then image asset is used instead. A 
+		disabled Rollover does not respond to the mouse.</p>
+    </td>
+
+  </tr>
+  <tr>
+    <td>renderer</td>
+    <td>&ILinkRenderer;</td>
+    <td>in</td>
+    <td>no</td>
+    <td></td>
+
+    <td>
+      The object which will actually render the link.
+    </td>
+  </tr>
 	</table>
   
 <p>
-  Body: <strong>removed / allowed</strong>
+  Body: <strong>removed</strong>
 </p>  
 
 <p>
-  Informal parameters: <strong>allowed  / forbidden</strong>
+  Informal parameters: <strong>allowed</strong>
 </p>
 
 <p>
-  Reserved parameters: <em>none</em>
+  Reserved parameters: <em>name, src, border</em>
 </p>
 
 </section>
 
 <section>
   <title>Examples</title>
+  <p> This example is under construction.</p>
 
 </section>
 </body>

Modified: jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ServiceLink.xml
URL: http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ServiceLink.xml?rev=280046&r1=280045&r2=280046&view=diff
==============================================================================
--- jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ServiceLink.xml
(original)
+++ jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ServiceLink.xml
Sat Sep 10 15:18:44 2005
@@ -28,11 +28,14 @@
   
   <body>
 
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
+<p>  A component for creating a link for an arbitrary engine service that uses no parameters,
such as the reset or home service. A ServiceLink component can emulate an ActionLink, PageLink
or DirectLink component, but is most often used in conjunction with an application-specific
service.
+</p>
+
+<p>Prior to release 2.2, this component was named <strong>Service</strong>.
 </p>
 
 <p>
-  <strong>See also:</strong> 
+  <strong>See also: &ActionLink;, &DirectLink;, &ExternalLink;, &GenericLink;,
&PageLink;</strong>
 </p>
 
 <section>
@@ -48,25 +51,86 @@
     <th>Description</th>
   </tr>
 
+  <tr>
+    <td>service</td>
+    <td>String</td>
+ 
+    <td>in</td>
+    <td>yes</td>
+    <td></td>
+    <td>
+      The name of the &IEngineService; to invoke.
+    </td>
+  </tr>
+  <tr>
+    <td>parameters</td>
+    <td>Object or<br />
+Object[] or <br />
+List</td>
+
+    <td>in</td>
+    <td>no</td>
+    <td></td>
+    <td>
+       An array of Objects to be encoded into the URL. These parameters will be decoded when
the link is triggered.
+    </td>
+  </tr>
+  <tr>
+    <td>disabled</td>
+    <td>boolean</td>
+    <td>in</td>
+    <td>no</td>
+    <td>false</td>
+
+    <td>
+      <p>Controls whether the link is produced. If disabled, the portion of the template
the
+      link surrounds is still rendered, but not the link itself.</p>
+      <p>Using the namespace scheme, to create a link to a page in a library, you must
provide the libraries namespace prefix.</p>
+    </td>
+  </tr>
+  <tr>
+    <td>anchor</td>
+
+    <td>String</td>
+    <td>in</td>
+    <td>no</td>
+    <td></td>
+    <td>
+      The name of an anchor or element to link to. The final URL will have '#' and the anchor
appended to it.
+    </td>
+
+  </tr>
+  <tr>
+    <td>renderer</td>
+    <td>&ILinkRenderer;</td>
+    <td>in</td>
+    <td>no</td>
+    <td></td>
+
+    <td>
+      The object which will actually render the link.
+    </td>
+  </tr>
+
 	</table>
   
 <p>
-  Body: <strong>removed / allowed</strong>
+  Body: <strong>rendered</strong>
 </p>  
 
 <p>
-  Informal parameters: <strong>allowed  / forbidden</strong>
+  Informal parameters: <strong>allowed</strong>
 </p>
 
 <p>
-  Reserved parameters: <em>none</em>
+  Reserved parameters: <em>href</em>
 </p>
 
 </section>
 
 <section>
   <title>Examples</title>
-
+  <p> This example is under construction.</p>
 </section>
 </body>
-</document>
\ No newline at end of file
+</document>



---------------------------------------------------------------------
To unsubscribe, e-mail: tapestry-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: tapestry-dev-help@jakarta.apache.org


Mime
View raw message