[richfaces-svn-commits] JBoss Rich Faces SVN: r4407 - trunk/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Sat Dec 1 10:23:16 EST 2007
Author: artdaw
Date: 2007-12-01 10:23:16 -0500 (Sat, 01 Dec 2007)
New Revision: 4407
Modified:
trunk/docs/userguide/en/src/main/docbook/included/listShuttle.xml
Log:
RF-1174 - listShuttle. Fix Details of Usage
Modified: trunk/docs/userguide/en/src/main/docbook/included/listShuttle.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/listShuttle.xml 2007-12-01 14:30:57 UTC (rev 4406)
+++ trunk/docs/userguide/en/src/main/docbook/included/listShuttle.xml 2007-12-01 15:23:16 UTC (rev 4407)
@@ -9,7 +9,6 @@
<section>
<title>Creating the Component with a Page Tag</title>
<para>Here is a simple example as it could be used on a page: </para>
-
<para>
<emphasis role="bold">Example:</emphasis>
</para>
@@ -26,7 +25,6 @@
</section>
<section>
<title>Creating the Component Dynamically Using Java</title>
-
<para>
<emphasis role="bold">Example:</emphasis>
</para>
@@ -40,12 +38,12 @@
<para>The <emphasis role="bold">
<property><rich:listShuttle></property>
</emphasis> component consists of the following parts: <itemizedlist>
- <listitem>two item lists (source and target). List consists of items; each item has
+ <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 caption, header (sorted and non-sorted), footer elements</listitem>
- <listitem>copy/moving controls set, a set of controls, which performs moving/copying
+ <listitem>optional <property>caption</property>, <property>header</property> (sorted and non-sorted), <property>footer</property> elements</listitem>
+ <listitem><property>copy/moving controls set</property>, a set of controls, which performs moving/copying
items between lists</listitem>
- <listitem>optional ordering controls set, a set of controls that performs
+ <listitem><property>optional ordering controls set</property>, a set of controls that performs
reordering</listitem>
</itemizedlist>
</para>
@@ -78,46 +76,45 @@
</rich:column>
</f:facet>
<rich:listShuttle>
-
...]]></programlisting>
<!-- ADD SCREESHOT-->
<para>Captions could be added to a list only after it was defined as a <emphasis>
- <property>sourceCaption</property>
+ <property>"sourceCaption"</property>
</emphasis> and <emphasis>
- <property>targetCaption</property>
+ <property>"targetCaption"</property>
</emphasis> named facets inside the component or defined with the <emphasis>
- <property>sourceCaptionLabel</property>
+ <property>"sourceCaptionLabel"</property>
</emphasis> and <emphasis>
- <property>targetCaptionLabel</property>
+ <property>"targetCaptionLabel"</property>
</emphasis> attribute.</para>
<!-- ordering control set-->
<para>The <emphasis role="bold">
<property><rich:listShuttle></property>
- </emphasis> component provides the possibility to use <property> "ordering
- controls set" </property>, which performs reordering in the target item
- list. Every control has possibility to be disabled. </para>
+ </emphasis> component provides the possibility to use <property>ordering controls
+ set</property>, which performs reordering in the target item list. Every control has
+ possibility to be disabled. </para>
<para>
- <property>
- <emphasis>"topControl"</emphasis>
- </property>, <property>
- <emphasis>"topControlDisabled"</emphasis>
- </property>, <property>
- <emphasis>"bottomControl"</emphasis>
- </property>, <property>
- <emphasis>"bottomControlDisabled"</emphasis>
- </property>, <property>
- <emphasis>"upControl"</emphasis>
- </property>, <property>
- <emphasis>"upControlDisabled"</emphasis>
- </property>, <property>
- <emphasis>"downControl"</emphasis>
- </property>, <property>
- <emphasis>"downControlDisabled"</emphasis>
- </property> facets are used to replaces the default control with facets content. </para>
+ <emphasis>
+ <property>"topControl" </property>
+ </emphasis>, <emphasis>
+ <property>"topControlDisabled" </property>
+ </emphasis>, <emphasis>
+ <property>"bottomControl" </property>
+ </emphasis>, <emphasis>
+ <property>"bottomControlDisabled" </property>
+ </emphasis>, <emphasis>
+ <property>"upControl" </property>
+ </emphasis>, <emphasis>
+ <property>"upControlDisabled" </property>
+ </emphasis>, <emphasis>
+ <property>"downControl" </property>
+ </emphasis>, <emphasis>
+ <property>"downControlDisabled" </property>
+ </emphasis> facets are used to replaces the default control with facets content. </para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML"><![CDATA[...
<rich:orderingList value="#{demoBean.items}" var="item" controlType="button">
<f:facet name="topControl">
<h:outputText value="Move to top">
@@ -137,63 +134,64 @@
<!-- 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>
+ </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>
- <property>
- <emphasis>"copyCotrol"</emphasis>
- </property>, <property>
- <emphasis>"copy_disabled"</emphasis>
- </property>, <property>
- <emphasis>"removeControl"</emphasis>
- </property>, <property>
- <emphasis>"remove_disabled"</emphasis>
- </property>, <property>
- <emphasis>"copyAllControl"</emphasis>
- </property>, <property>
- <emphasis>"copyAll_disabled"</emphasis>
- </property>, <property>
- <emphasis>"removeAllControl"</emphasis>
- </property>, <property>
- <emphasis>"removeAll_disabled"</emphasis>
- </property> facets are used to replaces the default control with facets content. </para>
+ <emphasis>
+ <property>"copyCotrol" </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 are used to replaces the default control with facets content. </para>
<!-- attributes -->
- <para> The <property>
- <emphasis>"sourceValue"</emphasis>
- </property> attribute defines the collection to be shown in source list.</para>
- <para> The <property>
- <emphasis>"value"</emphasis>
- </property> attribute defines the collection to store the value from target list.</para>
- <para> The <property>
- <emphasis>"var"</emphasis>
- </property> could be shared between both collections to defined lists on the page.</para>
- <para>Controls rendering is based on the<property>
- <emphasis>"controlsType"</emphasis>
- </property> attribute. Possible types are button, link, none.</para> The position of the
- <property>ordering controls set</property> relatively to list should be customized with <property>
- <emphasis>"orderControlsVerticalAlign"</emphasis>
- </property> attribute. The position of the <property>move/copy controls set</property>
- relatively to lists should be customized with <property>
- <emphasis>"moveControlsVerticalAlign"</emphasis>
- </property> attribute.
+ <para> The
+ <emphasis><property>"sourceValue"
+ </property></emphasis> attribute defines the collection to be shown in source list.</para>
+ <para>The
+ <emphasis><property>"value"
+ </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 <property>none</property>.</para> The position of the
+ <property>ordering controls set</property> relatively to list should be customized with
+ <emphasis><property>"orderControlsVerticalAlign"
+ </property></emphasis> attribute. The position of the <property>move/copy controls set</property>
+ relatively to lists should be customized with
+ <emphasis><property>"moveControlsVerticalAlign"
+ </property></emphasis> attribute.
+
<!-- template -->
+
<para>The <emphasis role="bold">
<property><rich:listShuttle></property>
</emphasis> component provides the possibility to be customized using templating. The
customization could be performed by layout definition nested to component.</para>
<para>10 elements could be provided to be defined inside template (all standard controls
- should also possible to use inside): sourceList, targetList, CopyControl, removeCotrol,
- copyAllControl, removeAllControl, topcontrol, bottomControl, downCotrol, upControl.</para>
- <para>The markup defined in the initial picture could be defined as in the following example.</para>
+ should also possible to use inside): {sourceList}, {targetList}, {CopyControl}, {removeCotrol},
+ {copyAllControl}, {removeAllControl}, {topcontrol}, {bottomControl}, {downCotrol}, {upControl}.</para>
+ <para>The markup defined in the initial picture could be defined as in the following
+ example.</para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML"><![CDATA[...
<rich:listShuttle>
- <!-- All the columns-->
- ...
- <!-- All the columns-->
+...
<h:panelGrid columns="4">
<h:outputText value="{sourceList}"/>
<h:panelGroup>
@@ -211,11 +209,8 @@
</h:panelGroup>
</h:panelGrid>
</rich:listShuttle>
-
...
]]></programlisting>
-
- <para>Keyboard usage</para>
<table>
<title>Keyboard usage for elements selection</title>
<tgroup cols="2">
@@ -288,8 +283,7 @@
<title>JavaScript API</title>
<para> Controls are accessible for developer on client-side using controls attribute of
JavaScript component instance. The value of the attribute is an associative array of
- controls keyed by the following strings: "top",
- "up", "down", "bottom".</para>
+ controls keyed by the following strings: <property>top</property>, <property>up</property>, <property>down</property>, <property>bottom</property>.</para>
<table>
<title>JavaScript API</title>
<tgroup cols="3">
@@ -425,17 +419,8 @@
<para>On the screenshot there are classes names that define styles for component elements.</para>
- <!-- screenshot -->
+ <!-- ADD SCREENSHOT -->
- <figure>
- <title>Style classes</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="" scalefit="1"/>
- </imageobject>
- </mediaobject>
- </figure>
-
<!-- ADD ITEMS representations!!!-->
<table>
More information about the richfaces-svn-commits
mailing list