[richfaces-svn-commits] JBoss Rich Faces SVN: r2510 - in trunk/docs/userguide/en/src/main: resources/images and 1 other directory.

richfaces-svn-commits at lists.jboss.org richfaces-svn-commits at lists.jboss.org
Mon Aug 27 11:15:07 EDT 2007 

Author: vkukharchuk
Date: 2007-08-27 11:15:07 -0400 (Mon, 27 Aug 2007)
New Revision: 2510

Added:
   trunk/docs/userguide/en/src/main/resources/images/scrollable-dt1.png
Modified:
   trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.desc.xml
   trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml
Log:
http://jira.jboss.com/jira/browse/RF-447

Modified: trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.desc.xml	2007-08-27 14:27:47 UTC (rev 2509)
+++ trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.desc.xml	2007-08-27 15:15:07 UTC (rev 2510)
@@ -1,35 +1,38 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <section>
-<sectioninfo>
-<keywordset>
-    <keyword>scrollableDataTable</keyword>
-</keywordset>
-</sectioninfo>
-<section>
-<title>Description</title>
-    <para>The <emphasis role="bold">
-        <property>&lt;rich:scrollableDataTable&gt;</property>
-    </emphasis> component is used to represent the tabular data.</para>
-    <figure>
-        <title>&lt;rich:scrollableDataTable&gt; component</title>
+    <sectioninfo>
+        <keywordset>
+            <keyword>scrollableDataTable</keyword>
+        </keywordset>
+    </sectioninfo>
+    <section>
+        <title>Description</title>
+        <para>
+		The <property>&lt;rich:scrollableDataTable&gt;</property> component is used for the table-like component creation.
+		The component just adds the set of additional features described below in comparison with the standard table.
+		</para>
+		
+		<figure>
+        <title>ScrollableDataTable component</title>
       <mediaobject> 
         <imageobject>
-            <imagedata fileref="images/scrollableDataTable.png"/>
+            <imagedata fileref="images/scrollable-dt1.png"/>
         </imageobject>
     </mediaobject>
     </figure>
+		
+    </section>	
+    <section>
+        <title>Key Features</title>
+        <itemizedlist>
+			<listitem>Highly customizable look and feel</listitem>
+			<listitem>Variable content of the table cells</listitem>
+			<listitem>Dynamically fetching the rows from the server when the table is scrolled up and down</listitem>
+			<listitem>Resizing columns by mouse dragging the column bar</listitem>
+			<listitem>Sorting column by clicking the header</listitem>
+			<listitem>Fixed one or more left columns when table is scrolled horizontally</listitem>
+			<listitem>One and multi-selection rows mode</listitem>
+			<listitem>Built-it drag-n-drop support</listitem>
+        </itemizedlist>
     </section>
-    <section>
-    <title>Key Features</title>
-    <itemizedlist>
-        <listitem>Highly customizable look and feel</listitem>
-        <listitem>Variable content of the table cells</listitem>
-        <listitem>Dynamically fetching the rows from the server when the table is scrolled up and down</listitem>
-        <listitem>Resizing columns by mouse dragging the column bar</listitem>
-        <listitem>Sorting column by clicking the header</listitem>
-        <listitem>Fixed one or more left columns when table is scrolled horizontally</listitem>
-        <listitem>One and multi-selection rows mode</listitem>
-        <listitem>Built-it drag-n-drop support</listitem>
-    </itemizedlist>
 </section>
-</section>
\ No newline at end of file

Modified: trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml	2007-08-27 14:27:47 UTC (rev 2509)
+++ trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml	2007-08-27 15:15:07 UTC (rev 2510)
@@ -67,6 +67,70 @@
 ...
 ]]></programlisting>
   </section>
+  
+   <section>
+    <title>Details of Usage</title>
+	<para>
+	The component represents on a page as a scrollable table with some fixed (non-scrollable) rows (header, footer) and columns.
+	Columns of the table are optionally resizable. Resizing is available using "drag and drop" of the column vertical borders.
+	There is possibility to expand or collapse the columns through JS API on the client side.
+	User can define the number of the fixed columns  from the left side using attribute <emphasis><property>&quot;frozenColCount&quot;</property></emphasis> that will not be scrolled
+	via horizontal scroll.
+	</para>
+
+	<para>
+	It's possible to select the whole row with onclick on the row or some set of rows. Selection is optional and availability of such feature
+	is defined on the component.
+	There are two ways to select a few rows:
+	<itemizedlist>
+			<listitem>Just clicking the columns one by one.</listitem>
+			<listitem>Clicking some row with the SHIFT button hold.
+	In this case all the rows starting from last selected up to clicked should be selected.</listitem>
+	</itemizedlist>
+	</para>
+	
+	<para>
+	The columns provides the possibility of expanding/collapsing on the client side through the next JS API:
+	
+	<itemizedlist>
+			<listitem>doCollapse(columnId) - Performs the collapse action for the column with the corresponding id</listitem>
+	</itemizedlist>
+
+	It's possible to sort the table content after clicks on the header. The feature is optional.
+	Every column should be pointed to the comparator method that will be used for sorting the table.
+	
+	In case the <property>&lt;rich:scrollableDataTable&gt;</property> is already sorted by some
+	column and the header of this column has been clicked again - the sorting will be
+	reversed.
+	</para>
+	
+<para>
+      <emphasis role="bold">Those a the typical variants of using:</emphasis>
+</para>
+    <programlisting role="XML"><![CDATA[...
+<rich:scrollableDataTable value="#{modelBuilder.model}" var="issues"
+			frozenColCount="1"
+			first="0"
+			rows="40" 
+			width="300px"
+			height="396px">
+		
+	<rich:column width="100px">
+		<f:facet name="header" >
+			<h:outputText value="State"/>
+		</f:facet>
+		<h:outputText value="#{issues.cell1}"/>
+		<f:facet name="footer">
+			<h:outputText value="State"/>
+		</f:facet>
+	</rich:column>		
+	<!--...//Set of columns and header/footer facets-->
+</rich:scrollableDataTable>
+...
+]]></programlisting>
+	
+   </section>  
+   
   <!--section>
     <title>Details of Usage</title>
     <para>The <property>table</property> component is very similar to the custom JSF dataTable one,

Added: trunk/docs/userguide/en/src/main/resources/images/scrollable-dt1.png
===================================================================
(Binary files differ)


Property changes on: trunk/docs/userguide/en/src/main/resources/images/scrollable-dt1.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

More information about the richfaces-svn-commits mailing list