| <?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>MultiplePropertySelection</title> |
| </properties> |
| <body> |
| |
| <section name="MultiplePropertySelection"> |
| |
| <p> |
| A component which uses <code><input type=checkbox></code> 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 |
| <a |
| href="../../apidocs/org/apache/tapestry/form/IPropertySelectionModel.html"> |
| IPropertySelectionModel |
| </a> |
| to provide the list of possible values. |
| <br /> |
| The |
| <a href="palette.html">Palette</a> |
| component is more powerful, but requires client-side JavaScript and is not fully |
| cross-browser compatible. |
| </p> |
| |
| <p> |
| <strong> |
| See also: |
| <a href="palette.html">Palette</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>selectedList</td> |
| <td>java.util.Collection</td> |
| <td>yes</td> |
| <td> </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> |
| <a |
| href="../../tapestry-contrib/apidocs/org/apache/tapestry/contrib/form/IMultiplePropertySelectionRenderer.html"> |
| IMultiplePropertySelectionRenderer |
| </a> |
| </td> |
| <td>no</td> |
| <td> |
| shared instance of |
| <a |
| href="../../tapestry-contrib/apidocs/org/apache/tapestry/contrib/form/CheckBoxMultiplePropertySelectionRenderer.html"> |
| CheckBoxMultiplePropertySelectionRenderer |
| </a> |
| </td> |
| <td> |
| Defines the object used to render this component. The default renders a |
| table of checkboxes. |
| </td> |
| </tr> |
| <tr> |
| <td>model</td> |
| <td> |
| <a |
| href="../../apidocs/org/apache/tapestry/form/IPropertySelectionModel.html"> |
| IPropertySelectionModel |
| </a> |
| </td> |
| <td>yes</td> |
| <td> </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>no</td> |
| <td>false</td> |
| <td> |
| Controls whether the <code><select></code> is active or not. A disabled |
| PropertySelection does not update its value parameter. |
| </td> |
| </tr> |
| |
| </table> |
| |
| <p> |
| Body: |
| <strong>removed</strong> |
| </p> |
| |
| <p> |
| Informal parameters: |
| <strong>forbidden</strong> |
| </p> |
| |
| <p> |
| Reserved parameters: |
| <em>none</em> |
| </p> |
| |
| </subsection> |
| |
| </section> |
| |
| </body> |
| </document> |
