You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by ds...@apache.org on 2005/10/12 00:28:17 UTC

svn commit: r312967 - in /jakarta/tapestry/trunk: contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/MultiplePropertySelection.xml src/documentation/content/xdocs/links.ent status.xml

Author: dsolis
Date: Tue Oct 11 15:27:58 2005
New Revision: 312967

URL: http://svn.apache.org/viewcvs?rev=312967&view=rev
Log:
Fix bug:TAPESTRY-493. Document MultiplePropertySelection component

Modified:
    jakarta/tapestry/trunk/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/MultiplePropertySelection.xml
    jakarta/tapestry/trunk/src/documentation/content/xdocs/links.ent
    jakarta/tapestry/trunk/status.xml

Modified: jakarta/tapestry/trunk/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/MultiplePropertySelection.xml
URL: http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/MultiplePropertySelection.xml?rev=312967&r1=312966&r2=312967&view=diff
==============================================================================
--- jakarta/tapestry/trunk/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/MultiplePropertySelection.xml (original)
+++ jakarta/tapestry/trunk/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/MultiplePropertySelection.xml Tue Oct 11 15:27:58 2005
@@ -28,11 +28,15 @@
   
   <body>
 
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
+<p> A component which uses &lt;input type=checkbox&gt; to set a property of some object. Typically,
+ the values for the object are defined using an org.apache.commons.lang.enum.Enum. A
+ MultiplePropertySelection is dependent on an &IPropertySelectionModel; to provide the list
+ of possible values.
+ <br/>The &Palette; component is more powerful, but requires client-side JavaScript and is not fully cross-browser compatible.
 </p>
 
 <p>
-  <strong>See also:</strong> 
+  <strong>See also: &Palette;</strong>
 </p>
 
 <section>
@@ -47,15 +51,43 @@
     <th>Default</th>
     <th>Description</th>
   </tr>
+    <tr>
+      <td>selectedList</td>
+      <td>java.util.List</td> <td>in-out</td> <td>yes</td> <td>&nbsp;</td>
+      <td>
+        The property to set. During rendering, this property is read, and sets the default value of the options in the select. When the form is submitted, list is cleared, then has each selected option added to it.
+      </td>
+    </tr>
+    <tr>
+      <td>renderer</td>
+      <td>&IMultiplePropertySelectionRenderer;</td> <td>in</td> <td>no</td> <td>shared instance of &CheckBoxMultiplePropertySelectionRenderer;</td>
+      <td>
+        Defines the object used to render this component. The default renders a table of checkboxes.
+      </td>
+    </tr>
+    <tr>
+      <td>model</td>
+      <td>&IPropertySelectionModel;</td> <td>in</td> <td>yes</td> <td>&nbsp;</td>
+      <td>
+        The model provides a list of possible labels, and matches those labels against possible values that can be assigned back to the property.
+      </td>
+    </tr>
+    <tr>
+      <td>disabled</td>
+      <td>boolean</td> <td>in</td> <td>no</td> <td>false</td>
+      <td>
+        Controls whether the &lt;select&gt; is active or not. A disabled PropertySelection does not update its value parameter.
+      </td>
+    </tr>
 
 	</table>
   
 <p>
-  Body: <strong>removed / allowed</strong>
+  Body: <strong>removed</strong>
 </p>  
 
 <p>
-  Informal parameters: <strong>allowed  / forbidden</strong>
+  Informal parameters: <strong>forbidden</strong>
 </p>
 
 <p>
@@ -64,9 +96,5 @@
 
 </section>
 
-<section>
-  <title>Examples</title>
-
-</section>
 </body>
 </document>

Modified: jakarta/tapestry/trunk/src/documentation/content/xdocs/links.ent
URL: http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/src/documentation/content/xdocs/links.ent?rev=312967&r1=312966&r2=312967&view=diff
==============================================================================
--- jakarta/tapestry/trunk/src/documentation/content/xdocs/links.ent (original)
+++ jakarta/tapestry/trunk/src/documentation/content/xdocs/links.ent Tue Oct 11 15:27:58 2005
@@ -27,6 +27,7 @@
 
 <!ENTITY apiroot "&projectroot;tapestry/apidocs/org/apache/tapestry">
 <!ENTITY hivedoc "&projectroot;tapestry/hivedocs">
+<!ENTITY apicontrib "&projectroot;tapestry-contrib/apidocs/org/apache/tapestry">
 
 <!ENTITY AbstractComponent 			'<link href="&apiroot;/AbstractComponent.html">AbstractComponent</link>'>
 <!ENTITY AbstractEngine 			'<link href="&apiroot;/engine/AbstractEngine.html">AbstractEngine</link>'>
@@ -118,6 +119,10 @@
 <!ENTITY ValidationDelegate 		'<link href="&apiroot;/valid/ValidationDelegate.html">ValidationDelegate</link>'>
 <!ENTITY WebRequest					'<link href="&apiroot;/web/WebRequest.html">WebRequest</link>'>
 <!ENTITY WebResponse			    '<link href="&apiroot;/web/WebResponse.html">WebResponse</link>'>
+
+<!-- Contrib Tapestry classes -->
+<!ENTITY CheckBoxMultiplePropertySelectionRenderer 		'<link href="&apicontrib;/contrib/form/CheckBoxMultiplePropertySelectionRenderer.html">CheckBoxMultiplePropertySelectionRenderer</link>'>
+<!ENTITY IMultiplePropertySelectionRenderer 			'<link href="&apicontrib;/contrib/form/IMultiplePropertySelectionRenderer.html">IMultiplePropertySelectionRenderer</link>'>
 
 <!-- Links to Component Reference -->
 

Modified: jakarta/tapestry/trunk/status.xml
URL: http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/status.xml?rev=312967&r1=312966&r2=312967&view=diff
==============================================================================
--- jakarta/tapestry/trunk/status.xml (original)
+++ jakarta/tapestry/trunk/status.xml Tue Oct 11 15:27:58 2005
@@ -52,6 +52,7 @@
   <changes>
     <release version="4.0-beta-11" date="unreleased">
       <action type="fix" dev="HLS" fixes-bug="TAPESTRY-650">ClassNotFoundException thrown when deserializing an object from a client persistent property</action>
+      <action type="fix" dev="DS" fixes-bug="TAPESTRY-493">Document MultiplePropertySelection component</action>
     </release>
     <release version="4.0-beta-10" date="Oct 8 2005">
       <action type="fix" dev="HLS" fixes-bug="TAPESTRY-344">Unimplemented abstract method check broken</action>



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