Author: SeanRogers Date: 2011-01-14 00:53:15 -0500 (Fri, 14 Jan 2011) New Revision: 21015 Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richdataScroller-The_richdataScroller_component.png Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml Log: Draft of dataScroller Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2011-01-14 02:24:51 UTC (rev 21014) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2011-01-14 05:53:15 UTC (rev 21015) @@ -593,42 +593,74 @@ </section> </section> - <!-- TODO not in M2 --> - <!-- + <!--<rich:dataScroller>--> <section id="sect-Component_Reference-Tables_and_grids-richdataScroller"> <title><sgmltag>&lt;rich:dataScroller&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.DataTable</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDataTable</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.DataTable</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.DataTableRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DataTableTag</classname> - </para> - </listitem> - </itemizedlist> <para> - Incomplete + The <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component is used for navigating through multiple pages of tables or grids. </para> + <figure id="figu-Component_Reference-richdataScroller-The_richdataScroller_component"> + <title>The <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richdataScroller-The_richdataScroller_component.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component with a <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component contained in the <literal>footer</literal> facet. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richdataScroller-Basic_usage"> + <title>Basic usage</title> + <para> + The <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> must be placed in the <literal>footer</literal> facet of the table or grid it needs to control. Alternatively, use the <varname>for</varname> attribute to bind the parent table or grid to the scroller. + </para> + <para> + The bound table or grid should also have the <varname>rows</varname> attribute defined to limit the number of rows per page. + </para> + </section> + + <section id="sect-Component_Reference-richdataScroller-Appearance"> + <title>Appearance</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 <varname>for</varname> attribute to bind the parent table or grid to the scroller. + </para> + </section> + + <section id="sect-Component_Reference-richdataScroller-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.DataScroller</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDataScroller</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.DataScroller</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.DataScrollerRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DataScrollerTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - --> <!--<rich:dataTable>--> <section id="sect-Component_Reference-Tables_and_grids-richdataTable"> Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richdataScroller-The_richdataScroller_component.png =================================================================== (Binary files differ) Property changes on: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richdataScroller-The_richdataScroller_component.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream