[richfaces-svn-commits] JBoss Rich Faces SVN: r4510 - branches/3.1.x/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Wed Dec 5 12:37:40 EST 2007
Author: vkorluzhenko
Date: 2007-12-05 12:37:40 -0500 (Wed, 05 Dec 2007)
New Revision: 4510
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 - improved description
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-05 17:35:26 UTC (rev 4509)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.desc.xml 2007-12-05 17:37:40 UTC (rev 4510)
@@ -20,10 +20,10 @@
<section>
<title>Key Features</title>
<itemizedlist>
- <listitem>Skinnable <property>listShuttle</property> and child items</listitem>
- <listitem>Customizable component layout (captions, headers, list items and control sets)</listitem>
- <listitem>Disabled/enabled ordering controls</listitem>
- <listitem> Built-In Drag-and-Drop support</listitem>
+ <listitem>Highly customizable look and feel</listitem>
+ <listitem>Reordering and sorting possibilities for lists items</listitem>
+ <listitem>Multiple selection of lists items</listitem>
+ <!--listitem> Built-In Drag-and-Drop support</listitem-->
</itemizedlist>
</section>
</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-05 17:35:26 UTC (rev 4509)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml 2007-12-05 17:37:40 UTC (rev 4510)
@@ -38,13 +38,14 @@
<para>The <emphasis role="bold">
<property><rich:listShuttle></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>
- <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><property>optional ordering controls set</property>, a set of controls that performs
- reordering</listitem>
+ <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">
@@ -156,34 +157,28 @@
<property>"removeAll_disabled" </property>
</emphasis> facets are used to replaces the default control 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>"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">
+ <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>
+ <!-- template wiil be done in 3.2.0 -->
+ <!--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>
+ 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>
@@ -210,7 +205,7 @@
</h:panelGrid>
</rich:listShuttle>
...
-]]></programlisting>
+]]></programlisting-->
<table>
<title>Keyboard usage for elements selection</title>
<tgroup cols="2">
@@ -224,11 +219,12 @@
<!--Sorting API -->
<row>
<entry>CTRL+click</entry>
- <entry>Described in selection behaviour requirement</entry>
+ <entry>Inverts selection for an item</entry>
</row>
<row>
<entry>SHIFT+click</entry>
- <entry>Described in selection behaviour requirement</entry>
+ <entry>Selects all rows from active one to a clicked row if they differ,
+ else select the actve row. All other selections are cleared</entry>
</row>
<row>
<entry>CTRL+A</entry>
@@ -241,7 +237,7 @@
</row>
<row>
<entry>Up, Down arrows</entry>
- <entry>Change the active element to the next or previous in a list and make
+ <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
visible</entry>
</row>
@@ -281,9 +277,7 @@
</section>
<section>
<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: <property>top</property>, <property>up</property>, <property>down</property>, <property>bottom</property>.</para>
+
<table>
<title>JavaScript API</title>
<tgroup cols="3">
@@ -291,107 +285,87 @@
<row>
<entry>Function</entry>
<entry>Description</entry>
- <entry>Element</entry>
</row>
</thead>
<tbody>
<!--Sorting API -->
<row>
<entry>doSortAscending()</entry>
- <entry>Sort items in the list ascending</entry>
- <entry>Component</entry>
+ <entry>Sorts items in the list ascending</entry>
</row>
<row>
<entry>doSortDescending()</entry>
- <entry>Sort items in the list descending</entry>
- <entry>Component</entry>
+ <entry>Sorts items in the list descending</entry>
</row>
<row>
<entry>doSort()</entry>
- <entry>Invert current sorting</entry>
- <entry>Component</entry>
+ <entry>Inverts current sorting</entry>
</row>
<!--Controls common API -->
<row>
<entry>doHide()</entry>
- <entry>Hide ordering control</entry>
- <entry>Any Ordering control</entry>
+ <entry>Hides ordering control</entry>
</row>
<row>
<entry>doShow()</entry>
- <entry>Show ordering control</entry>
- <entry>Any Ordering control</entry>
+ <entry>Shows ordering control</entry>
</row>
<row>
<entry>isShown()</entry>
- <entry>Check if current control is shown</entry>
- <entry>Any Ordering control</entry>
+ <entry>Checks if current control is shown</entry>
</row>
<row>
<entry>doEnable()</entry>
- <entry>Enable ordering control</entry>
- <entry>Any Ordering control</entry>
+ <entry>Enables ordering control</entry>
</row>
<row>
<entry>doDisable()</entry>
- <entry>Disable ordering control</entry>
- <entry>Any Ordering control</entry>
+ <entry>Disables ordering control</entry>
</row>
<row>
<entry>isEnabled()</entry>
- <entry>Check if current control is enabled</entry>
- <entry>Any Ordering control</entry>
+ <entry>Checks if current control is enabled</entry>
</row>
<!--List managing API -->
<row>
<entry>moveUp()</entry>
- <entry>Move up selected item in the list</entry>
- <entry>Any Item</entry>
+ <entry>Moves up selected item in the list</entry>
</row>
<row>
<entry>moveDown()</entry>
- <entry>Move down selected item in the list</entry>
- <entry>Any Item</entry>
+ <entry>Moves down selected item in the list</entry>
</row>
<row>
<entry>moveTop()</entry>
- <entry>Move top selected item in the list</entry>
- <entry>Any Item</entry>
+ <entry>Moves top selected item in the list</entry>
</row>
<row>
<entry>moveBottom()</entry>
- <entry>Move bottom selected item in the list</entry>
- <entry>Any Item</entry>
+ <entry>Moves bottom selected item in the list</entry>
</row>
<row>
<entry>copy()</entry>
- <entry>Copy selected item from the source list to the target list</entry>
- <entry>Any Item</entry>
+ <entry>Copies selected item from the source list to the target list</entry>
</row>
<row>
<entry>remove()</entry>
- <entry>Remove selected item from the target list to the source list</entry>
- <entry>Any Item</entry>
+ <entry>Removes selected item from the target list to the source list</entry>
</row>
<row>
<entry>copyAll()</entry>
- <entry>Copy all items from the source list to the target list</entry>
- <entry>Any Item</entry>
+ <entry>Copies all items from the source list to the target list</entry>
</row>
<row>
<entry>removeAll()</entry>
- <entry>Remove all items from the target list to the source list</entry>
- <entry>Any Item</entry>
+ <entry>Removes all items from the target list to the source list</entry>
</row>
<row>
<entry>getSelection()</entry>
- <entry>Return currently selected item</entry>
- <entry>Any Item</entry>
+ <entry>Returns currently selected item</entry>
</row>
<row>
<entry>getItems()</entry>
- <entry>Return the collection of all items</entry>
- <entry>Any Item</entry>
+ <entry>Returns the collection of all items</entry>
</row>
</tbody>
</tgroup>
More information about the richfaces-svn-commits
mailing list