Author: dsolis
Date: Wed Oct 12 15:31:46 2005
New Revision: 315064
URL: http://svn.apache.org/viewcvs?rev=315064&view=rev
Log:
Fix bug:TAPESTRY-496. Document Palette component
Modified:
jakarta/tapestry/trunk/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Palette.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/Palette.xml
URL:
http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Palette.xml?rev=315064&r1=315063&r2=315064&view=diff
==============================================================================
---
jakarta/tapestry/trunk/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Palette.xml
(original)
+++
jakarta/tapestry/trunk/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Palette.xml
Wed Oct 12 15:31:46 2005
@@ -28,11 +28,13 @@
<body>
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
+<p> A component used to make a number of selections from a list. The general
look is a pair of <select> elements. with a pair of buttons between them.
The right element is a list of values that can be selected. The buttons move
values from the right column ("available") to the left column ("selected").
+<br/>This all takes a bit of JavaScript to accomplish (quite a bit), which
means a &Body; component must wrap the Palette. If JavaScript is not enabled in
the client browser, then the user will be unable to make (or change) any
selections.
+<br/>Cross-browser compatibility is not perfect. In some cases, the
&MultiplePropertySelection; component may be a better choice.
</p>
<p>
- <strong>See also:</strong>
+ <strong>See also:&MultiplePropertySelection;</strong>
</p>
<section>
@@ -47,15 +49,79 @@
<th>Default</th>
<th>Description</th>
</tr>
-
+ <tr>
+ <td>selected</td>
+ <td>java.util.List</td> <td>in</td> <td>yes</td> <td> </td>
+ <td>
+ A List of selected values. Possible selections are defined by the
model; this should be a subset of the possible values. This may be null when
the component is renderred. When the containing form is submitted, this
parameter is updated with a new List of selected objects.
+ <br/>The order may be set by the user, as well, depending on the
sortMode parameter.
+ </td>
+ </tr>
+ <tr>
+ <td>model</td>
+ <td>&IPropertySelectionModel;</td> <td>in</td> <td>yes</td>
<td> </td>
+ <td>
+ Works, as with a &PropertySelection; component, to define the possible
values.
+ </td>
+ </tr>
+ <tr>
+ <td>sort</td>
+ <td>&SortMode;</td> <td>in</td> <td>no</td> <td>&SortMode.NONE;</td>
+ <td>
+ Controls automatic sorting of the options.
+ </td>
+ </tr>
+ <tr>
+ <td>rows</td>
+ <td>int</td> <td>in</td> <td>no</td> <td>10</td>
+ <td>
+ The number of rows that should be visible in the Pallete's
<select> elements.
+ </td>
+ </tr>
+ <tr>
+ <td>tableClass</td>
+ <td>String</td> <td>in</td> <td>no</td> <td>tapestry-palette</td>
+ <td>
+ The CSS class for the table which surrounds the other elements of the
Palette.
+ </td>
+ </tr>
+ <tr>
+ <td>selectedTitleBlock</td>
+ <td>&Block;</td> <td>in</td> <td>no</td> <td>"Selected"</td>
+ <td>
+ If specified, allows a Block to be placed within the <th>
reserved for the title above the selected items <select> (on the right).
This allows for images or other components to be placed there. By default, the
simple word Selected is used.
+ </td>
+ </tr>
+ <tr>
+ <td>availableTitleBlock</td>
+ <td>&Block;</td> <td>in</td> <td>no</td> <td>"Available"</td>
+ <td>
+ As with selectedTitleBlock, but for the left column, of items which
are available to be selected. The default is the word Available.
+ </td>
+ </tr>
+ <tr>
+ <td>selectImage
+<br/>selectDisabledImage
+<br/>deselectImage
+<br/>deselectDisabledImage
+<br/>upImage
+<br/>upDisabledImage
+<br/>downImage
+<br/>downDisabledImage</td>
+ <td>&IAsset;</td> <td>in</td> <td>no</td> <td> </td>
+ <td>
+ If any of these are specified then they override the default images
provided with the component. This allows the look and feel to be customized
relatively easily.
+<br/>The most common reason to replace the images is to deal with backgrounds.
The default images are anti-aliased against a white background. If a colored or
patterned background is used, the default images will have an ugly white
fringe. Until all browsers have full support for PNG (which has a true alpha
channel), it is necessary to customize the images to match the background.
+ </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 +130,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=315064&r1=315063&r2=315064&view=diff
==============================================================================
--- jakarta/tapestry/trunk/src/documentation/content/xdocs/links.ent (original)
+++ jakarta/tapestry/trunk/src/documentation/content/xdocs/links.ent Wed Oct 12
15:31:46 2005
@@ -123,6 +123,8 @@
<!-- 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>'>
+<!ENTITY SortMode '<link
href="&apicontrib;/contrib/palette/SortMode.html">SortMode</link>'>
+<!ENTITY SortMode.NONE '<link
href="&apicontrib;/contrib/palette/SortMode.html#NONE">SortMode.NONE</link>'>
<!-- Links to Component Reference -->
@@ -159,7 +161,6 @@
<!ENTITY InspectorButton '<link
href="site:InspectorButton">InspectorButton</link>'>
<!ENTITY Option '<link
href="site:Option">Option</link>'>
<!ENTITY PageLink '<link
href="site:PageLink">PageLink</link>'>
-<!ENTITY Palette '<link
href="site:contrib.Palette">Palette</link>'>
<!ENTITY PropertySelection '<link
href="site:PropertySelection">PropertySelection</link>'>
<!ENTITY Radio '<link
href="site:Radio">Radio</link>'>
<!ENTITY RadioGroup '<link
href="site:RadioGroup">RadioGroup</link>'>
@@ -179,7 +180,9 @@
<!-- Links to contrib Component Reference -->
<!ENTITY Choose '<link
href="site:Choose">Choose</link>'>
+<!ENTITY MultiplePropertySelection '<link
href="site:MultiplePropertySelection">MultiplePropertySelection</link>'>
<!ENTITY Otherwise '<link
href="site:Otherwise">Otherwise</link>'>
+<!ENTITY Palette '<link
href="site:Palette">Palette</link>'>
<!ENTITY When '<link href="site:When">When</link>'>
<!-- External links -->
Modified: jakarta/tapestry/trunk/status.xml
URL:
http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/status.xml?rev=315064&r1=315063&r2=315064&view=diff
==============================================================================
--- jakarta/tapestry/trunk/status.xml (original)
+++ jakarta/tapestry/trunk/status.xml Wed Oct 12 15:31:46 2005
@@ -53,6 +53,7 @@
<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>
+ <action type="fix" dev="DS" fixes-bug="TAPESTRY-496">Document Palette
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: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
