[richfaces-svn-commits] JBoss Rich Faces SVN: r4905 - branches/3.1.x/docs/userguide/en/src/main/docbook/included.

[richfaces-svn-commits at lists.jboss.org]

Author: artdaw
Date: 2007-12-18 14:40:59 -0500 (Tue, 18 Dec 2007)
New Revision: 4905

Modified:
   branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml
Log:
http://jira.jboss.com/jira/browse/RF-1174 - edit Details of Usage according to dev project. Add 'convertor' attribute, move/copy controls set

Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml
===================================================================
--- branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml	2007-12-18 19:01:49 UTC (rev 4904)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml	2007-12-18 19:40:59 UTC (rev 4905)
@@ -45,9 +45,12 @@
                 <property>&lt;rich:listShuttle&gt;</property>
             </emphasis> component consists of the following parts: <itemizedlist>
                 <listitem>two <property>item lists</property> (source and target). List consists of
-                    items. Each item has three different representations: common, selected, active</listitem>
+                items. Each item has three different representations: common, selected, active</listitem>
+                <listitem>optional <property>caption</property> element</listitem>
                 <listitem><property>optional ordering controls set</property> is a set of controls
-                    that performs reordering</listitem>
+                that performs reordering</listitem>
+                <listitem><property>copy/moving controls set</property> is a set of controls, which
+                    performs moving/copying items between lists</listitem>
             </itemizedlist>
         </para>
         <para> The <emphasis>
@@ -59,6 +62,12 @@
         <para> The <emphasis>
             <property>&quot;var&quot; </property>
         </emphasis> could be shared between both collections to defined lists on the page.</para>
+        <para>
+            The <emphasis>
+                <property>&quot;converter&quot; </property>
+            </emphasis> attribute is used to convert component data to a particular component&apos;s value.
+            For example, when you select items in a list, a converter is used to format a set of objects to a strings to be displayed.  
+        </para>
         <para>Captions could be added to a list only after it was defined as a <emphasis>
                 <property>&quot;sourceCaption&quot;</property>
             </emphasis> and <emphasis>
@@ -101,7 +110,8 @@
             <emphasis role="bold">Example:</emphasis>
         </para>
         <programlisting role="XML"><![CDATA[...
-<rich:listShuttle var="item" sourceValue="#{bean.source}" targetValue="#{bean.target}" sourceSelection="#{bean.sourceSelection}" targetSelection="#{bean.targetSelection}">
+<rich:listShuttle var="item" sourceValue="#{bean.source}" targetValue="#{bean.target}" sourceSelection="#{bean.sourceSelection}" targetSelection="#{bean.targetSelection}" 
+                        converter="listShuttleconverter">
 ...			         
         <f:facet name="topControl">
             <h:outputText value="Move to top" />
@@ -118,15 +128,58 @@
 <rich:orderingList>
 ...
 ]]></programlisting>
+       
+        <!-- copy/move control set -->
         
+        <para>The <emphasis role="bold">
+            <property>&lt;rich:listShuttle&gt;</property>
+        </emphasis>component also provides 4 predefined controls in <property>move/copy
+            controls set</property> for moving or copying items between source and target lists.
+            Every control has possibility to be disabled. </para>
+        <para>A <property>move/copy
+            controls set</property> could be defined with 
+            <emphasis><property>&quot;copyControlLabel&quot;</property></emphasis>, <emphasis><property>&quot;removeControlLabel&quot;</property></emphasis>,
+            <emphasis><property>&quot;copyAllControlLabel&quot;</property></emphasis>, <emphasis><property>&quot;removeAllControlLabel&quot;</property></emphasis>attributes.
+        </para>
+        <para>It is also possible to use
+            <emphasis>
+                <property>&quot;copyControl&quot; </property>
+            </emphasis>, 
+            <emphasis>
+                <property>&quot;removeControl&quot; </property>
+            </emphasis>, 
+            <emphasis>
+                <property>&quot;copyAllControl&quot; </property>
+            </emphasis>, 
+            <emphasis>
+                <property>&quot;removeAllControl&quot; </property>
+            </emphasis> 
+          facets in order to replace the default controls with facets content.
+        </para>
         
+        <!-- The following facets currently do not work-->
+        <!--<emphasis>
+            <property>&quot;copy_disabled&quot; </property>
+            </emphasis>, -->
+        <!--<emphasis>
+            <property>&quot;remove_disabled&quot; </property>
+            </emphasis>, -->
+        <!--<emphasis>
+            <property>&quot;copyAll_disabled&quot; </property>
+            </emphasis>, -->
+        <!--<emphasis>
+            <property>&quot;removeAll_disabled&quot; </property>
+            </emphasis>-->
         
-        
-        <!--para>Controls rendering is based on the <emphasis>
+        <para>Controls rendering is based on the <emphasis>
                 <property>&quot;controlsType&quot; </property>
             </emphasis> attribute. Possible types are <property>button</property> and
-            <property>none</property>.</para-->
-        
+            <property>none</property>.</para>
+        <note>
+            <para>
+                Currently the button controls type is based on &lt;div&gt; element.     
+            </para>
+        </note>
         <!-- template wiil be done in 3.2.0 -->
         <!--para>The <emphasis role="bold">
                 <property>&lt;rich:listShuttle&gt;</property>