From richfaces-svn-commits at lists.jboss.org Fri Jan 8 02:02:14 2010 Content-Type: multipart/mixed; boundary="===============4286457316605678992==" 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: r16250 - in root/docs/trunk/Component_Reference/en-US: extras and 1 other directories. Date: Fri, 08 Jan 2010 02:02:14 -0500 Message-ID: <201001080702.o0872EqY028573@svn01.web.mwc.hst.phx2.redhat.com> --===============4286457316605678992== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: SeanRogers Date: 2010-01-08 02:02:13 -0500 (Fri, 08 Jan 2010) New Revision: 16250 Added: root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Referenc= e-richdataGrid-richdataGrid_example.xml_sample root/docs/trunk/Component_Reference/en-US/images/figu-Component_Referenc= e-richdataGrid-The_richdataGrid_component.png root/docs/trunk/Component_Reference/en-US/images/figu-Component_Referenc= e-richdataGrid-richdataGrid_example.png Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Commo= n_features.xml root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Table= s_and_grids.xml Log: Updated tables and grids Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Referenc= e-Common_features.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 --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Comm= on_features.xml 2010-01-06 22:39:57 UTC (rev 16249) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Comm= on_features.xml 2010-01-08 07:02:13 UTC (rev 16250) @@ -4,7 +4,7 @@ Common features - Incomplete + This chapter covers those attributes and features that are common to man= y of the components in the tag libraries.
Positioning in popup components Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Referenc= e-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 --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tabl= es_and_grids.xml 2010-01-06 22:39:57 UTC (rev 16249) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tabl= es_and_grids.xml 2010-01-08 07:02:13 UTC (rev 16250) @@ -8,6 +8,33 @@
rich:column + + + + component-type: org.richfaces.Column + + + + + component-class: org.richfaces.component.html.HtmlColumn + + + + + component-family: org.richfaces.Column + + + + + renderer-type: org.richfaces.renderkit.CellRenderer + + + + + tag-class: org.richfaces.taglib.ColumnTag + + + The <rich:column> component facilitates column= s in a table or other UIData component. It supports = merging columns and rows, sorting, filtering, and customized skinning. @@ -117,6 +144,33 @@ =
rich:columnGroup + + + + component-type: org.richfaces.ColumnGroup + + + + + component-class: org.richfaces.component.html.HtmlColumnGr= oup + + + + + component-family: org.richfaces.ColumnGroup + + + + + renderer-type: org.richfaces.ColumnGroupRenderer + + + + + tag-class: org.richfaces.taglib.ColumnGroupTag + + + The <rich:columnGroup> component combines mult= iple columns in a single row to organize complex parts of a table. The resu= lting effect is similar to using the breakBefore attribu= te of the <rich:column> component, but is clearer = and easier to follow in the source code. @@ -131,19 +185,19 @@ <f:facet name=3D"header"> <rich:columnGroup> <rich:column rowspan=3D"2"> - <h:outputText value=3D"State Flag"/> + <h:outputText value=3D"State Flag"/> </rich:column> <rich:column colspan=3D"3"> - <h:outputText value=3D"State Info"/> + <h:outputText value=3D"State Info"/> </rich:column> <rich:column breakBefore=3D"true"> - <h:outputText value=3D"State Name"/> + <h:outputText value=3D"State Name"/> </rich:column> <rich:column> - <h:outputText value=3D"State Capital"/> + <h:outputText value=3D"State Capital"/> </rich:column> <rich:column> - <h:outputText value=3D"Time Zone"/> + <h:outputText value=3D"Time Zone"/> </rich:column> </rich:columnGroup> </f:facet> @@ -174,8 +228,20 @@ =
rich:columns + + + + component-type: org.richfaces.Column + + + + + tag-class: org.richfaces.taglib.ColumnsTagHandler + + + - The <rich:columns> component allows for dynami= c sets of columns for tables. Columns and rows can be merged, and the look = and feel can be highly customized. The component gets a list from a data mo= del and creates a corresponding set of columns in a <rich:dataT= able> component. The <rich:columns> c= omponent also supports header and footer facets. + The <rich:columns> component allows for dynami= c sets of columns for tables. Columns and rows can be merged, and the look = and feel can be highly customized. The component gets a list from a data mo= del and creates a corresponding set of columns in a <rich:dataT= able> component. The <rich:columns> c= omponent also supports header and footer facets. Basic usage of the <rich:columns> component re= quires the value attribute, which points to the data mod= el; the var attribute, which holds the current variable = for the collection of data; and the index attribute, whi= ch holds the current counter. The id attribute is used f= or when the individuals rows require identifiers for Ajax events. @@ -197,25 +263,172 @@ - The columns attribute + The output can be customized to display specific columns and rows. The = columns attribute specifies the number of columns. The <= varname>rowspan attribute specifies the number of rows to display= ; if the attribute is set to 0, all remaining rows in th= e table are displayed. The begin and end attributes are used to specify the first and last zero-based iteration = items to display in the table. Columns can be adjusted using the c= olspan, rowspan, and breakBefore attributes the same as with the <rich:column> component. + The <rich:columns> component can be used along= side <rich:column> components. + + + Using <rich:columns> and <rich:column> together</tit= le> +<programlisting language=3D"XML" role=3D"XML"> +<rich:dataTable value=3D"#{dataTableScrollerBean.model}" var=3D"model" = width=3D"500px" rows=3D"5"> + <f:facet name=3D"header"> + <h:outputText value=3D"Cars Available"></h:outputText> + </f:facet> + <rich:columns value=3D"#{dataTableScrollerBean.columns}" var=3D"colum= ns" index=3D"ind"> + <f:facet name=3D"header"> + <h:outputText value=3D"#{columns.header}" /> + </f:facet> + <h:outputText value=3D"#{model[ind].model} " /> + </rich:columns> + <rich:column> + <f:facet name=3D"header"> + <h:outputText value=3D"Price" /> + </f:facet> + <h:outputText value=3D"Price" /> + </rich:column> + <rich:columns value=3D"#{dataTableScrollerBean.columns}" var=3D"colum= ns" index=3D"ind"> + <f:facet name=3D"header"> + <h:outputText value=3D"#{columns.header}" /> + </f:facet> + <h:outputText value=3D"#{model[ind].mileage}$" /> + </rich:columns> +</rich:dataTable> +</programlisting> + </example> + <para> For details on filtering and sorting columns, refer to <xref linkend=3D= "sect-Component_Reference-Tables_and_grids-Table_filtering" /> and <xref li= nkend=3D"sect-Component_Reference-Tables_and_grids-Table_sorting" />. </para> </section> = <section id=3D"sect-Component_Reference-Tables_and_grids-richdataFilterSl= ider"> <title>rich:dataFilterSlider + + + + component-type: org.richfaces.DataFilterSlider + + + + + component-class: org.richfaces.component.html.HtmlDataFilt= erSlider + + + + + component-family: org.richfaces.DataFilterSlider + + + + + renderer-type: org.richfaces.DataFilterSliderRenderer + + + + + tag-class: org.richfaces.taglib.dataFilterSliderTag + + + - The <rich:dataFilterSlider> components is a sl= ider control that can be used for filtering data in a table. + The <rich:dataFilterSlider> components is a sl= ider control that can be used for filtering data in a table. The range and = increment of the slider control are defined using the startRange, endRange, and increment att= ributes. + + The slider is bound to a UIData component specif= ied with the for attribute. The forValRef attribute refers to the value attribute used by the= target component, and the filterBy attribute specifies = which object member to filter according to the slider. + + + The handleValue attribute keeps the current handle p= osition on the slider control; filtering is based on this value. The storeResults attribute allows the <rich:dataFilter= Slider> component to keep the target UIData component in session. + + + The event defined with the submitOnSlide attribute i= s triggered when the handle value on the slider is changed. +
=
rich:dataGrid + + + + component-type: org.richfaces.DataGrid + + + + + component-class: org.richfaces.component.html.HtmlDataGrid= + + + + + component-family: org.richfaces.DataGrid + + + + + renderer-type: org.richfaces.DataGridRenderer + + + + + tag-class: org.richfaces.taglib.DataGridTag + + + - Incomplete + The <rich:dataGrid> component is used to arran= ge data objects in a grid. Values in the grid can be updated dynamically fr= om the data model, and Ajax updates can be limited to specific rows. The co= mponent supports header, footer, and = caption facets. +
+ The rich:dataGrid component + + + + + + + The rich:dataGrid component displaying four elements in two columns,= with a header facet, and footer face= t containing a data scroller component. + + + +
+ + The <rich:dataGrid> component requires the value attribute, which points to the data model, and the var attribute, which holds the current variable for the co= llection of data. The number of columns for the grid is specifed with the <= varname>columns attribute, and the number of elements to layout a= mong the columns is determined with the elements attribu= te. The first attribute references the zero-based elemen= t in the data model from which the grid starts. + + + rich:dataGrid example + + + +
+
+ rich:dataGrid example + + + + + + + The result of the <rich:dataGrid> example,= with the header facet, footer facet,= and first element annotated. + + + +
+
+ + + The <rich:dataGrid> component can be used with= the <rich:dataScroller> component to display mult= iple pages of grids. Refer to for details on the <rich:dat= aScroller> component. + + + As the component is based on the <a4j:repeat> = component, it can be partially updated with Ajax. The ajaxKeys attribute allows row keys to be defined, which are updated after an = Ajax request. + + + <varname>ajaxKeys</varname> example + +<rich:dataGrid value=3D"#{dataTableScrollerBean.allCars}" var=3D"car" a= jaxKeys=3D"#{listBean.list}" binding=3D"#{listBean.dataGrid}" id=3D"grid" e= lements=3D"4" columns=3D"2"> + ... +</rich:dataGrid> +... +<a4j:commandButton action=3D"#{listBean.action}" reRender=3D"grid" valu= e=3D"Submit"/> + +
=
Added: root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Refe= rence-richdataGrid-richdataGrid_example.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 --- root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Referen= ce-richdataGrid-richdataGrid_example.xml_sample (re= v 0) +++ root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Referen= ce-richdataGrid-richdataGrid_example.xml_sample 2010-01-08 07:02:13 UTC (re= v 16250) @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + + + Added: root/docs/trunk/Component_Reference/en-US/images/figu-Component_Refe= rence-richdataGrid-The_richdataGrid_component.png =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 (Binary files differ) Property changes on: root/docs/trunk/Component_Reference/en-US/images/figu-= Component_Reference-richdataGrid-The_richdataGrid_component.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: root/docs/trunk/Component_Reference/en-US/images/figu-Component_Refe= rence-richdataGrid-richdataGrid_example.png =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 (Binary files differ) Property changes on: root/docs/trunk/Component_Reference/en-US/images/figu-= Component_Reference-richdataGrid-richdataGrid_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream --===============4286457316605678992==--