Author: artdaw
Date: 2007-12-08 10:58:31 -0500 (Sat, 08 Dec 2007)
New Revision: 4633
Modified:
branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml
Log:
http://jira.jboss.com/jira/browse/RF-1174 -
controlsType comment-out in Details of Usage in accordance with Table of Attributes.
Comment-out footer facet.
"copy_disabled" , "remove_disabled", "copyAll_disabled" ,
"removeAll_disabled" facets do not work. Comment-out.
add "topControlLabel" , "bottomControlLabel" ,
"upControlLabel" , "downControlLabel" attributes.
edit examples.
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-08
12:48:41 UTC (rev 4632)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml 2007-12-08
15:58:31 UTC (rev 4633)
@@ -13,14 +13,20 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
-<rich:listShuttle value="#{bean.list}" var="list"
selection="#{value.resultList}">
- <f:facet name="header">
- <h:outputText value="Header1"/>
+<rich:listShuttle var="item" sourceValue="#{bean.source}"
targetValue="#{bean.target}" sourceSelection="#{bean.sourceSelection}"
targetSelection="#{bean.targetSelection}">
+ <f:facet name="sourceCaption">
+ <h:outputText value="Cars Store #1" />
</f:facet>
- <rich:column>
- <h:outputText value="#{list.text}">
- </rich:column>
-<rich:listShuttle>
+ <f:facet name="targetCaption">
+ <h:outputText value="Cars Store #2" />
+ </f:facet>
+ <h:column>
+ <f:facet name="header">
+ <h:outputText value="Cars" />
+ </f:facet>
+ <h:outputText value="#{item.name}" />
+ </h:column>
+</rich:listShuttle>
...]]></programlisting>
</section>
<section>
@@ -41,10 +47,10 @@
<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
+ 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
+ <listitem><property>optional ordering controls
set</property> is a set of controls
that performs reordering</listitem>
</itemizedlist>
</para>
@@ -62,19 +68,19 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
-<rich:listShuttle sourceValue="#{bean.list}" var="list"
value="#{value.resultList}">
+<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>
+ <rich:column>
+ <h:outputText value="#{list.text}"/>
+ </rich:column>
</f:facet>
<f:facet name="target">
- <rich:column>
- <h:outputText value="#{list.text}"/>
- </rich:column>
- <rich:column>
- <h:outputText value="#{list.description}"/>
- </rich:column>
+ <rich:column>
+ <h:outputText value="#{item.name}" />
+ </rich:column>
+ <rich:column>
+ <h:outputText value="#{item.price}" />
+ </rich:column>
</f:facet>
<rich:listShuttle>
...]]></programlisting>
@@ -111,23 +117,29 @@
<property>"downControl" </property>
</emphasis>, <emphasis>
<property>"downControlDisabled"
</property>
- </emphasis> facets are used to replaces the default control with facets
content. </para>
+ </emphasis> facets are used to replaces the default control with facets
content.
+ </para>
+ <para>An <property>ordering controls set</property> could be
also defined with
+
<emphasis><property>"topControlLabel"</property></emphasis>,
<emphasis><property>"bottomControlLabel"</property></emphasis>,
+
<emphasis><property>"upControlLabel"</property></emphasis>,
<emphasis><property>"downControlLabel"</property></emphasis>attributes.
+ </para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
-<rich:orderingList value="#{demoBean.items}" var="item"
controlType="button">
+<rich:listShuttle var="item" sourceValue="#{bean.source}"
targetValue="#{bean.target}" sourceSelection="#{bean.sourceSelection}"
targetSelection="#{bean.targetSelection}">
+...
<f:facet name="topControl">
- <h:outputText value="Move to top">
+ <h:outputText value="Move to top" />
</f:facet>
<f:facet name="upControl">
- <h:outputText value="Move up">
+ <h:outputText value="Move up" />
</f:facet>
<f:facet name="downControl">
- <h:outputText value="Move down">
+ <h:outputText value="Move down" />
</f:facet>
<f:facet name="bottomControl">
- <h:outputText value="Move to bottom">
+ <h:outputText value="Move to bottom" />
</f:facet>
<rich:orderingList>
...
@@ -140,22 +152,34 @@
Every control has possibility to be disabled. </para>
<para>
<emphasis>
- <property>"copyCotrol" </property>
- </emphasis>, <emphasis>
+ <property>"copyControl" </property>
+ </emphasis>,
+ <!--<emphasis>
<property>"copy_disabled" </property>
- </emphasis>, <emphasis>
+ </emphasis>, -->
+ <emphasis>
<property>"removeControl" </property>
- </emphasis>, <emphasis>
+ </emphasis>,
+ <!--<emphasis>
<property>"remove_disabled" </property>
- </emphasis>, <emphasis>
+ </emphasis>, -->
+ <emphasis>
<property>"copyAllControl" </property>
- </emphasis>, <emphasis>
+ </emphasis>,
+ <!--<emphasis>
<property>"copyAll_disabled" </property>
- </emphasis>, <emphasis>
+ </emphasis>, -->
+ <emphasis>
<property>"removeAllControl" </property>
- </emphasis>, <emphasis>
+ </emphasis>
+ <!--<emphasis>
<property>"removeAll_disabled" </property>
- </emphasis> facets are used to replaces the default control with facets
content. </para>
+ </emphasis>--> facets are used to replaces the default control
with facets content.
+ </para>
+ <para>An <property>move/copy controls set</property> could be
also defined with
+
<emphasis><property>"copyControlLabel"</property></emphasis>,
<emphasis><property>"removeControlLabel"</property></emphasis>,
+
<emphasis><property>"copyAllControlLabel"</property></emphasis>,
<emphasis><property>"removeAllControlLabel"</property></emphasis>attributes.
+ </para>
<!-- attributes -->
<para> The <emphasis>
<property>"sourceValue" </property>
@@ -166,10 +190,11 @@
<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>
+ <!--para>Controls rendering is based on the <emphasis>
<property>"controlsType" </property>
</emphasis> attribute. Possible types are
<property>button</property> and
- <property>none</property>.</para>
+ <property>none</property>.</para-->
+
<!-- template wiil be done in 3.2.0 -->
<!--para>The <emphasis role="bold">
<property><rich:listShuttle></property>