[richfaces-svn-commits] JBoss Rich Faces SVN: r2105 - trunk/docs/userguide/en/src/main/docbook/included.

[richfaces-svn-commits at lists.jboss.org]

Author: vkorluzhenko
Date: 2007-08-07 11:45:17 -0400 (Tue, 07 Aug 2007)
New Revision: 2105

Modified:
   trunk/docs/userguide/en/src/main/docbook/included/datascroller.xml
Log:
http://jira.jboss.com/jira/browse/RF-412

Modified: trunk/docs/userguide/en/src/main/docbook/included/datascroller.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/datascroller.xml	2007-08-07 15:31:17 UTC (rev 2104)
+++ trunk/docs/userguide/en/src/main/docbook/included/datascroller.xml	2007-08-07 15:45:17 UTC (rev 2105)
@@ -90,9 +90,24 @@
     <para>Component provides two controllers groups for switching:</para>
     <itemizedlist>
       <listitem>Page numbers for switching onto a particular page</listitem>
-      <listitem>The controls of fast switching: &quot;first&quot;, &quot;last&quot;,
-        &quot;next&quot;, &quot;previous&quot;, &quot;fastforward&quot;,
-        &quot;fastrewind&quot;</listitem>
+      <listitem>The controls of fast switching: <emphasis>
+          <property>&quot;first&quot;,</property>
+        </emphasis>
+        <emphasis>
+          <property>&quot;last&quot;,</property>
+        </emphasis>
+        <emphasis>
+          <property>&quot;next&quot;,</property>
+        </emphasis>
+        <emphasis>
+          <property>&quot;previous&quot;,</property>
+        </emphasis>
+        <emphasis>
+          <property>&quot;fastforward&quot;,</property>
+        </emphasis>
+        <emphasis>
+          <property>&quot;fastrewind&quot;</property>
+        </emphasis></listitem>
     </itemizedlist>
     <para>The controls of fast switching are created adding the facets component with the
       corresponding name:</para>
@@ -111,10 +126,24 @@
     </rich:Datascroller>
 ...
 ]]></programlisting>
-    <para> There are also facets used to create the disabled states:
-      &quot;first_disabled&quot;, &quot;last_disabled&quot;,
-      &quot;next_disabled&quot;, &quot;previous_disabled&quot;,
-      &quot;fastforward_disabled&quot;, &quot;fastrewind_disabled&quot;. </para>
+    <para> There are also facets used to create the disabled states: <emphasis>
+        <property>&quot;first_disabled&quot;,</property>
+      </emphasis>
+      <emphasis>
+        <property>&quot;last_disabled&quot;,</property>
+      </emphasis>
+      <emphasis>
+        <property>&quot;next_disabled&quot;,</property>
+      </emphasis>
+      <emphasis>
+        <property>&quot;previous_disabled&quot;,</property>
+      </emphasis>
+      <emphasis>
+        <property>&quot;fastforward_disabled&quot;,</property>
+      </emphasis>
+      <emphasis>
+        <property>&quot;fastrewind_disabled&quot;</property>
+      </emphasis>. </para>
     <figure>
       <title>Datascroller controls</title>
       <mediaobject>
@@ -124,12 +153,45 @@
       </mediaobject>
     </figure>
     <para>The screenshot shows one controller from each group.</para>
-    <para>For the
-        <property>&quot;fastforward&quot;</property>/<property>&quot;rewind&quot;</property>
-      controls customization the additional <emphasis>
+    <para>For the <emphasis>
+        <property>&quot;fastforward&quot;</property>
+      </emphasis>/<emphasis>
+        <property>&quot;rewind&quot;</property>
+      </emphasis> controls customization the additional <emphasis>
         <property>&quot;fastStep&quot;</property>
       </emphasis> attribute is used. The attribute indicates pages quantity to switch onto when fast
       scrolling is used. </para>
+    <para>The <emphasis>
+        <property>&quot;pageIndexVar&quot;</property>
+      </emphasis> and <emphasis>
+        <property>&quot;pagesVar&quot;</property>
+      </emphasis> attributes provide an ability to show the current page and the number of pages in
+      the dataScroller. These attributes are used for definition the names of variables, that wiil
+      be used in the facet with name<emphasis>
+        <property>&quot;pages&quot;</property>
+      </emphasis>. An example can be found below: </para>
+    <para>
+      <emphasis role="bold">Example:</emphasis>
+    </para>
+    <programlisting role="XML"><![CDATA[ ...
+      <h:form>
+            <rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5">
+                  <rich:column>
+                         <h:outputText value="#{cap.name}"></h:outputText>
+                  </rich:column>
+                  <f:facet name="footer">
+                        <rich:datascroller pageIndexVar="pageIndex" pagesVar="pages">
+                                <f:facet name="pages">
+                                      <h:outputText value="#{pageIndex} / #{pages}"></h:outputText>
+                                </f:facet>
+                        </rich:datascroller>
+                  </f:facet>
+            </rich:dataTable>
+      </h:form>
+...
+]]></programlisting>
+
+
   </section>
   <section>
     <title>Look-and-Feel Customization</title>