Author: andyhot
Date: Thu Apr 27 05:08:42 2006
New Revision: 397526
URL: http://svn.apache.org/viewcvs?rev=397526&view=rev
Log:
Contrib documentation for checkboxes
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/CheckboxGroup.xml
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/ControlCheckbox.xml
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/ControlledCheckbox.xml
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/DumpObject.xml
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/CheckboxGroup.xml
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/CheckboxGroup.xml?rev=397526&r1=397525&r2=397526&view=diff
==============================================================================
---
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/CheckboxGroup.xml
(original)
+++
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/CheckboxGroup.xml
Thu Apr 27 05:08:42 2006
@@ -28,34 +28,41 @@
<body>
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
+<p>
+ A component defining a group of checkboxes that will be controlled
together.
+ Typically the ControlCheckbox and ControlledCheckbox components are
placed
+ in the body of this component.
</p>
<p>
- <strong>See also:</strong>
+ <strong>See also: &ControlCheckbox;, &ControlledCheckbox;</strong>
</p>
<section>
<title>Parameters</title>
<table>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Direction</th>
- <th>Required</th>
- <th>Default</th>
- <th>Description</th>
- </tr>
-
- </table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td colspan="6">No parameters defined.</td>
+ </tr>
+
+</table>
<p>
- Body: <strong>removed / allowed</strong>
+ Body: <strong>allowed</strong>
</p>
<p>
- Informal parameters: <strong>allowed / forbidden</strong>
+ Informal parameters: <strong>forbidden</strong>
</p>
<p>
@@ -66,7 +73,38 @@
<section>
<title>Examples</title>
-
+ <p>Template</p>
+ <source><![CDATA[
+<form jwcid="form">
+ <span jwcid="checkboxGroup">
+ <input jwcid="controlCheckbox"/>
+ <input jwcid="controlledCheckbox1"/>
+ <input jwcid="controlledCheckbox2"/>
+ <input jwcid="controlledCheckbox3"/>
+ </span>
+ ...
+</form>
+ ]]></source>
+
+ <p>Specification</p>
+ <source><![CDATA[
+<property name="state1" persist="session" initial-value="false"/>
+<property name="state2" persist="session" initial-value="false"/>
+<property name="state3" persist="session" initial-value="false"/>
+
+ <component id="checkboxGroup" type="contrib:CheckboxGroup"/>
+ <component id="controlCheckbox" type="contrib:ControlCheckbox"/>
+
+<component id="controlledCheckbox1" type="contrib:ControlledCheckbox">
+ <binding name="value" value="state1"/>
+</component>
+<component id="controlledCheckbox2" type="contrib:ControlledCheckbox">
+ <binding name="value" value="state2"/>
+</component>
+<component id="controlledCheckbox3" type="contrib:ControlledCheckbox">
+ <binding name="value" value="state3"/>
+</component>
+ ]]></source>
</section>
</body>
</document>
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/ControlCheckbox.xml
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/ControlCheckbox.xml?rev=397526&r1=397525&r2=397526&view=diff
==============================================================================
---
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/ControlCheckbox.xml
(original)
+++
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/ControlCheckbox.xml
Thu Apr 27 05:08:42 2006
@@ -28,11 +28,13 @@
<body>
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
+<p>
+ Creates a checkbox that will automatically select or deselect
+ all controlled checkboxes in the checkbox group.
</p>
<p>
- <strong>See also:</strong>
+ <strong>See also: &CheckboxGroup;, &ControlledCheckbox;</strong>
</p>
<section>
@@ -47,26 +49,71 @@
<th>Default</th>
<th>Description</th>
</tr>
-
+ <tr>
+ <td>group</td>
+ <td><link
href="&apicontrib;/contrib/form/checkboxes/CheckboxGroup.html">CheckboxGroup</link></td>
+ <td>in</td>
+ <td>no</td>
+ <td>null</td>
+ <td>
+ If provided, it specifies the CheckboxGroup
+ this component belongs to. If it is not specified, then the
component is a
+ a part of the CheckboxGroup that wraps it.
+ Please note that if this parameter is used, then the CheckboxGroup
it refers to
+ must either enclose the current component, or must be defined
after it.
+ </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>type, onclick</em>
</p>
</section>
<section>
<title>Examples</title>
-
+ <p>Template</p>
+ <source><![CDATA[
+<form jwcid="form">
+ <span jwcid="checkboxGroup">
+ <input jwcid="controlCheckbox"/>
+ <input jwcid="controlledCheckbox1"/>
+ <input jwcid="controlledCheckbox2"/>
+ <input jwcid="controlledCheckbox3"/>
+ </span>
+ ...
+</form>
+ ]]></source>
+
+ <p>Specification</p>
+ <source><![CDATA[
+<property name="state1" persist="session" initial-value="false"/>
+<property name="state2" persist="session" initial-value="false"/>
+<property name="state3" persist="session" initial-value="false"/>
+
+ <component id="checkboxGroup" type="contrib:CheckboxGroup"/>
+ <component id="controlCheckbox" type="contrib:ControlCheckbox"/>
+
+<component id="controlledCheckbox1" type="contrib:ControlledCheckbox">
+ <binding name="value" value="state1"/>
+</component>
+<component id="controlledCheckbox2" type="contrib:ControlledCheckbox">
+ <binding name="value" value="state2"/>
+</component>
+<component id="controlledCheckbox3" type="contrib:ControlledCheckbox">
+ <binding name="value" value="state3"/>
+</component>
+ ]]></source>
</section>
+
</body>
</document>
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/ControlledCheckbox.xml
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/ControlledCheckbox.xml?rev=397526&r1=397525&r2=397526&view=diff
==============================================================================
---
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/ControlledCheckbox.xml
(original)
+++
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/ControlledCheckbox.xml
Thu Apr 27 05:08:42 2006
@@ -28,11 +28,14 @@
<body>
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
+<p>
+ A checkbox whose state may be controlled by other checkboxes using
JavaScript.
+ The checkbox rendered by this component may be automatically selected
or deselected
+ by a ControlCheckbox within the same group.
</p>
<p>
- <strong>See also:</strong>
+ <strong>See also: &CheckboxGroup;, &ControlCheckbox;</strong>
</p>
<section>
@@ -47,7 +50,41 @@
<th>Default</th>
<th>Description</th>
</tr>
-
+ <tr>
+ <td>value</td>
+ <td>boolean</td>
+ <td>in/out</td>
+ <td>yes</td>
+ <td></td>
+ <td>
+ Value editted by the component; read on render, updated on form
submit.
+ This sets the check attribute of the rendered element.
+ </td>
+ </tr>
+ <tr>
+ <td>disabled</td>
+ <td>boolean</td>
+ <td>in</td>
+ <td>no</td>
+ <td>false</td>
+ <td>
+ If true, then the checkbox will render as disabled and any
input from the checkbox will be ignored.
+ </td>
+ </tr>
+ <tr>
+ <td>group</td>
+ <td><link
href="&apicontrib;/contrib/form/checkboxes/CheckboxGroup.html">CheckboxGroup</link></td>
+ <td>in</td>
+ <td>no</td>
+ <td>null</td>
+ <td>
+ If provided, it specifies the CheckboxGroup
+ this component belongs to. If it is not specified, then the
component is a
+ a part of the CheckboxGroup that wraps it.
+ Please note that if this parameter is used, then the CheckboxGroup
it refers to
+ must either enclose the current component, or must be defined
after it.
+ </td>
+ </tr>
</table>
<p>
@@ -66,7 +103,38 @@
<section>
<title>Examples</title>
-
+ <p>Template</p>
+ <source><![CDATA[
+<form jwcid="form">
+ <span jwcid="checkboxGroup">
+ <input jwcid="controlCheckbox"/>
+ <input jwcid="controlledCheckbox1"/>
+ <input jwcid="controlledCheckbox2"/>
+ <input jwcid="controlledCheckbox3"/>
+ </span>
+ ...
+</form>
+ ]]></source>
+
+ <p>Specification</p>
+ <source><![CDATA[
+<property name="state1" persist="session" initial-value="false"/>
+<property name="state2" persist="session" initial-value="false"/>
+<property name="state3" persist="session" initial-value="false"/>
+
+ <component id="checkboxGroup" type="contrib:CheckboxGroup"/>
+ <component id="controlCheckbox" type="contrib:ControlCheckbox"/>
+
+<component id="controlledCheckbox1" type="contrib:ControlledCheckbox">
+ <binding name="value" value="state1"/>
+</component>
+<component id="controlledCheckbox2" type="contrib:ControlledCheckbox">
+ <binding name="value" value="state2"/>
+</component>
+<component id="controlledCheckbox3" type="contrib:ControlledCheckbox">
+ <binding name="value" value="state3"/>
+</component>
+ ]]></source>
</section>
</body>
</document>
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/DumpObject.xml
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/DumpObject.xml?rev=397526&r1=397525&r2=397526&view=diff
==============================================================================
---
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/DumpObject.xml
(original)
+++
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/DumpObject.xml
Thu Apr 27 05:08:42 2006
@@ -78,6 +78,12 @@
<source><![CDATA[
<span jwcid="@contrib:DumpObject" object="ognl:new java.util.Date()"/>
]]></source>
+<p>and the output will be like this:</p>
+ <source><![CDATA[
+0000: aced0005 7372000e 6a617661 2e757469 |....sr..java.uti|
+0010: 6c2e4461 7465686a 81014b59 74190300 |l.Datehj..KYt...|
+0020: 00787077 08000001 0adac264 3d78 |.xpw.......d=x |
+ ]]></source>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
