Author: vkorluzhenko
Date: 2007-12-17 12:20:01 -0500 (Mon, 17 Dec 2007)
New Revision: 4872
Modified:
branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.desc.xml
branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml
Log:
http://jira.jboss.com/jira/browse/RF-1174-fixed errors
Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.desc.xml
===================================================================
---
branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.desc.xml 2007-12-17
15:43:36 UTC (rev 4871)
+++
branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.desc.xml 2007-12-17
17:20:01 UTC (rev 4872)
@@ -23,6 +23,7 @@
<listitem>Highly customizable look and feel</listitem>
<listitem>Reordering and sorting possibilities for lists
items</listitem>
<listitem>Multiple selection of lists items</listitem>
+ <listitem>Keyboard support</listitem>
<!--listitem> Built-In Drag-and-Drop support</listitem-->
</itemizedlist>
</section>
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-17
15:43:36 UTC (rev 4871)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml 2007-12-17
17:20:01 UTC (rev 4872)
@@ -13,7 +13,7 @@
<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}" converter="listShuttleconverter">
<f:facet name="sourceCaption">
<h:outputText value="Cars Store #1" />
</f:facet>
@@ -46,45 +46,19 @@
</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>
- <listitem>optional <property>caption</property>,
<property>header</property><!--(sorted
- and non-sorted), <property>footer</property>-->
elements</listitem>
- <listitem><property>copy/moving controls set</property>
is a set of controls, which
- performs moving/copying items between lists</listitem>
<listitem><property>optional ordering controls
set</property> is a set of controls
that performs reordering</listitem>
</itemizedlist>
</para>
- <para>The <emphasis role="bold">
- <property><rich:listShuttle></property>
- </emphasis> component provides to use <emphasis>
- <property>"source"</property>
- </emphasis> and <emphasis>
- <property>"target"</property>
- </emphasis> facets. It is possible to use the facets only together
defined. In case the
- facets definition skipped both lists contain the columns defined nested to
listShuttle
- component.</para>
- <para>Here is a simple example as it could be used on a page.</para>
- <para>
- <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}">
- <f:facet name="source">
- <rich:column>
- <h:outputText value="#{list.text}"/>
- </rich:column>
- </f:facet>
- <f:facet name="target">
- <rich:column>
- <h:outputText value="#{item.name}" />
- </rich:column>
- <rich:column>
- <h:outputText value="#{item.price}" />
- </rich:column>
- </f:facet>
-<rich:listShuttle>
-...]]></programlisting>
- <!-- ADD SCREESHOT-->
+ <para> The <emphasis>
+ <property>"sourceValue" </property>
+ </emphasis> attribute defines the collection to be shown in source
list.</para>
+ <para>The <emphasis>
+ <property>"targetValue" </property>
+ </emphasis> attribute defines the collection to store the value from target
list.</para>
+ <para> The <emphasis>
+ <property>"var" </property>
+ </emphasis> could be shared between both collections to defined lists on
the page.</para>
<para>Captions could be added to a list only after it was defined as a
<emphasis>
<property>"sourceCaption"</property>
</emphasis> and <emphasis>
@@ -144,55 +118,10 @@
<rich:orderingList>
...
]]></programlisting>
- <!-- copy/move control set -->
- <para>The <emphasis role="bold">
- <property><rich:listShuttle></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>"copyControlLabel"</property></emphasis>,
<emphasis><property>"removeControlLabel"</property></emphasis>,
-
<emphasis><property>"copyAllControlLabel"</property></emphasis>,
<emphasis><property>"removeAllControlLabel"</property></emphasis>attributes.
- </para>
- <para>It is also possible to use
- <emphasis>
- <property>"copyControl" </property>
- </emphasis>,
- <!--<emphasis>
- <property>"copy_disabled" </property>
- </emphasis>, -->
- <emphasis>
- <property>"removeControl" </property>
- </emphasis>,
- <!--<emphasis>
- <property>"remove_disabled" </property>
- </emphasis>, -->
- <emphasis>
- <property>"copyAllControl" </property>
- </emphasis>,
- <!--<emphasis>
- <property>"copyAll_disabled" </property>
- </emphasis>, -->
- <emphasis>
- <property>"removeAllControl" </property>
- </emphasis>
- <!--<emphasis>
- <property>"removeAll_disabled" </property>
- </emphasis>--> facets in order to replace the default controls
with facets content.
- </para>
- <!-- attributes -->
- <para> The <emphasis>
- <property>"sourceValue" </property>
- </emphasis> attribute defines the collection to be shown in source
list.</para>
- <para>The <emphasis>
- <property>"targetValue" </property>
- </emphasis> attribute defines the collection to store the value from
target list.</para>
- <para> The <emphasis>
- <property>"var" </property>
- </emphasis> could be shared between both collections to defined lists
on the page.</para>
+
+
<!--para>Controls rendering is based on the <emphasis>
<property>"controlsType" </property>
</emphasis> attribute. Possible types are
<property>button</property> and
@@ -260,13 +189,9 @@
already present in a list</entry>
</row>
<row>
- <entry>Space</entry>
- <entry>Inverts selection on the active
element</entry>
- </row>
- <row>
<entry>Up, Down arrows</entry>
<entry>Changes the active element to the next or previous
in a list and make
- it the only selected. Scroll should follow the selection to
keep it
+ it the only selected. Scroll follows the selection to keep
it
visible</entry>
</row>
</tbody>