From richfaces-svn-commits at lists.jboss.org Thu Jan 20 01:59:28 2011
Content-Type: multipart/mixed; boundary="===============2938956272054664078=="
MIME-Version: 1.0
From: richfaces-svn-commits at lists.jboss.org
To: richfaces-svn-commits at lists.jboss.org
Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r21103 - in
 modules/docs/trunk/Component_Reference/src/main/docbook/en-US: extras and 1
 other directory.
Date: Thu, 20 Jan 2011 01:59:28 -0500
Message-ID: <201101200659.p0K6xSLx022671@svn01.web.mwc.hst.phx2.redhat.com>

--===============2938956272054664078==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: SeanRogers
Date: 2011-01-20 01:59:28 -0500 (Thu, 20 Jan 2011)
New Revision: 21103

Added:
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa=
m-Component_Reference-richdataScroller-pages_facet.xml_sample
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa=
m-Component_Reference-richdataScroller-richataScroller_example.xml_sample
Modified:
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo=
nent_Reference-Tables_and_grids.xml
Log:
rich:dataScroller docs

Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Tables_and_grids.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Tables_and_grids.xml	2011-01-19 23:20:06 UTC (rev 21102)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Tables_and_grids.xml	2011-01-20 06:59:28 UTC (rev 21103)
@@ -621,13 +621,54 @@
 			<para>
 				The bound table or grid should also have the <varname>rows</varname> a=
ttribute defined to limit the number of rows per page.
 			</para>
+			<para>
+				The <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component must be re-=
rendered whenever a filter changes on the bound table, so that the scroller=
 matches the current model for the table.
+			</para>
+			<example id=3D"exam-Component_Reference-richdataScroller-Basic_usage">
+			   <title>Basic usage</title>
+			   <programlisting language=3D"XML" role=3D"XML"><xi:include parse=3D"t=
ext" href=3D"extras/exam-Component_Reference-richdataScroller-Basic_usage.x=
ml_Sample" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></programlisting>
+			</example>
 		</section>
 		=

-		<section id=3D"sect-Component_Reference-richdataScroller-Appearance">
-			<title>Appearance</title>
+		<section id=3D"sect-Component_Reference-richdataScroller-Appearance_and_=
interactivity">
+			<title>Appearance and interactivity</title>
 			<para>
-				The <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> must be placed in the=
 footer of the table or grid it needs to control. Alternatively, use the <v=
arname>for</varname> attribute to bind the parent table or grid to the scro=
ller.
+				The <varname>page</varname> attribute is a value-binding attribute use=
d to define and save the current page number.
 			</para>
+			<para>
+				The <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component provides a =
range of controllers for scrolling through tables and grids:
+			</para>
+			<variablelist>
+				<varlistentry>
+					<term>Controls for scrolling by a specific amount</term>
+					<listitem>
+						<para>
+							The component includes controls for switching to the first page, th=
e last page, the next page, and the previous page, as well as controls for =
fast-forwarding or rewinding by a set amount. Use the <varname>fastStep</va=
rname> attribute to set the number of pages to skip when fast-forwarding or=
 rewinding.
+						</para>
+						<para>
+							The appearance of these controls can be customized using the follow=
ing facets: <literal>first</literal>, <literal>last</literal>, <literal>nex=
t</literal>, <literal>previous</literal>, <literal>fastforward</literal>, a=
nd <literal>rewind</literal>. Additionally, there are facets for the contro=
ls' disabled states: <literal>first_disabled</literal>, <literal>last_disab=
led</literal>, <literal>next_disabled</literal>, <literal>previous_disabled=
</literal>, <literal>fastforward_disabled</literal>, and <literal>rewind_di=
sabled</literal>.
+						</para>
+					</listitem>
+				</varlistentry>
+				<varlistentry>
+					<term>Page controls</term>
+					<listitem>
+						<para>
+							The component also features a series of numbered controls to jump t=
o a specific page. Use the <varname>maxPages</varname> attribute to limit t=
he number of page controls that appear. The current page control is highlig=
hted.
+						</para>
+					</listitem>
+				</varlistentry>
+			</variablelist>
+			<para>
+				The <varname>pageIndexVar</varname> and <varname>pagesVar</varname> at=
tributes are request-scope variables for the current page and the total num=
ber of pages. Use these attributes with the <literal>pages</literal> facet =
to provide information about the pages of the table, as shown in <xref link=
end=3D"exam-Component_Reference-richdataScroller-pages_facet" />.
+			</para>
+			<example id=3D"exam-Component_Reference-richdataScroller-pages_facet">
+				<title><literal>pages</literal> facet</title>
+				<programlisting language=3D"XML" role=3D"XML"><xi:include parse=3D"tex=
t" href=3D"extras/exam-Component_Reference-richdataScroller-pages_facet.xml=
_sample" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></programlisting>
+			</example>
+			<para>
+			   To add optional separators between controls, define the separators w=
ith the <literal>controlsSeparator</literal> facet.
+			</para>
 		</section>
 		=

 		<section id=3D"sect-Component_Reference-richdataScroller-Reference_data">
@@ -1042,20 +1083,20 @@
 	<section id=3D"sect-Component_Reference-Tables_and_grids-richlist">
 		<title><sgmltag>&lt;rich:list&gt;</sgmltag></title>
 		<para>
-			The <sgmltag>&lt;rich:list&gt;</sgmltag> component renders a list of it=
ems. The list can be an numerically ordered list, an unordered bullet-point=
 list, or a data definition list. The component uses a data model for manag=
ing the list items, which can be updated dynamically.
+			The <sgmltag>&lt;rich:list&gt;</sgmltag> component renders a list of it=
ems. The list can be an numerically ordered list, an un-ordered bullet-poin=
t list, or a data definition list. The component uses a data model for mana=
ging the list items, which can be updated dynamically.
 		</para>
 		=

 		<section id=3D"sect-Component_Reference-richlist-Basic_usage">
 			<title>Basic usage</title>
 			<para>
-				The <varname>var</varname> attribute names a variable for iterating th=
rough the items in the data model. The items to iterate through are determi=
ned with the <varname>value</varname> attribute by using EL (Expression Lan=
ugage).
+				The <varname>var</varname> attribute names a variable for iterating th=
rough the items in the data model. The items to iterate through are determi=
ned with the <varname>value</varname> attribute by using EL (Expression Lan=
guage).
 			</para>
 		</section>
 		=

 		<section id=3D"sect-Component_Reference-richlist-Type_of_list">
 			<title>Type of list</title>
 			<para>
-				By default, the list is displayed as an unordered bullet-point list. T=
he <varname>type</varname> attribute is used to specify different list type=
s:
+				By default, the list is displayed as an un-ordered bullet-point list. =
The <varname>type</varname> attribute is used to specify different list typ=
es:
 			</para>
 			<variablelist>
 				<varlistentry>

Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras=
/exam-Component_Reference-richdataScroller-pages_facet.xml_sample
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex=
am-Component_Reference-richdataScroller-pages_facet.xml_sample	            =
            (rev 0)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex=
am-Component_Reference-richdataScroller-pages_facet.xml_sample	2011-01-20 0=
6:59:28 UTC (rev 21103)
@@ -0,0 +1,11 @@
+<rich:dataTable value=3D"#{capitalsBean.capitals}" var=3D"cap" rows=3D"5">
+   <!-- table content -->
+   ...
+   <f:facet name=3D"footer">
+      <rich:datascroller pageIndexVar=3D"pageIndex" pagesVar=3D"pages">
+         <f:facet name=3D"pages">
+            <h:outputText value=3D"#{pageIndex} / #{pages}" />
+         </f:facet>
+      </rich:datascroller>
+   </f:facet>
+</rich:dataTable>

Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras=
/exam-Component_Reference-richdataScroller-richataScroller_example.xml_samp=
le
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex=
am-Component_Reference-richdataScroller-richataScroller_example.xml_sample	=
                        (rev 0)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex=
am-Component_Reference-richdataScroller-richataScroller_example.xml_sample	=
2011-01-20 06:59:28 UTC (rev 21103)
@@ -0,0 +1,12 @@
+<rich:dataTable id=3D"table" value=3D"#{capitalsBean.capitals}" var=3D"cap=
" rows=3D"5">
+   <!-- table content -->
+   ...
+</rich:dataTable>
+<rich:datascroller for=3D"table" maxPages=3D"5">
+   <f:facet name=3D"first">
+      <h:outputText value=3D"First" />
+   </f:facet>
+   <f:facet name=3D"last">
+      <h:outputText value=3D"Last" />
+   </f:facet>
+</rich:datascroller>


--===============2938956272054664078==--