| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| Copyright 2005 The Apache Software Foundation |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <document> |
| <properties> |
| <title>CheckboxGroup</title> |
| </properties> |
| <body> |
| |
| <section name="CheckboxGroup"> |
| |
| <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> |
| <img src="../images/checkboxgroup.png" alt="CheckboxGroup selection of table columns."/> |
| <p> |
| <strong> |
| See also: |
| <a href="controlcheckbox.html">ControlCheckbox</a> |
| , |
| <a href="controlledcheckbox.html">ControlledCheckbox</a> |
| </strong> |
| </p> |
| |
| <subsection name="Parameters"> |
| |
| |
| <table> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>No parameters defined.</td> |
| <td></td> |
| <td></td> |
| <td></td> |
| <td></td> |
| </tr> |
| </table> |
| |
| <p> |
| Body: |
| <strong>allowed</strong> |
| </p> |
| |
| <p> |
| Informal parameters: |
| <strong>forbidden</strong> |
| </p> |
| |
| <p> |
| Reserved parameters: |
| <em>none</em> |
| </p> |
| |
| </subsection> |
| |
| <subsection name="Examples"> |
| |
| <p>Template</p> |
| <source xml:space="preserve"> |
| <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 xml:space="preserve"> |
| <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> |
| </subsection> |
| |
| </section> |
| |
| </body> |
| </document> |
