From richfaces-svn-commits at lists.jboss.org Wed Aug 27 13:08:00 2008 Content-Type: multipart/mixed; boundary="===============2318462004683262745==" 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: r10211 - trunk/docs/userguide/en/src/main/docbook/included. Date: Wed, 27 Aug 2008 13:08:00 -0400 Message-ID: --===============2318462004683262745== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: atsebro Date: 2008-08-27 13:07:59 -0400 (Wed, 27 Aug 2008) New Revision: 10211 Modified: trunk/docs/userguide/en/src/main/docbook/included/extendedDataTable.desc= .xml trunk/docs/userguide/en/src/main/docbook/included/extendedDataTable.xml Log: RF-4131:extendedDataTable-Documenting Modified: trunk/docs/userguide/en/src/main/docbook/included/extendedDataTab= le.desc.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 --- trunk/docs/userguide/en/src/main/docbook/included/extendedDataTable.des= c.xml 2008-08-27 16:51:11 UTC (rev 10210) +++ trunk/docs/userguide/en/src/main/docbook/included/extendedDataTable.des= c.xml 2008-08-27 17:07:59 UTC (rev 10211) @@ -7,34 +7,63 @@ > =
- - - &extDataTable; - - -
- Description - The component for tables extending standard component - <rich:dataTable> - . -
- <emphasis role=3D"bold"><property><&extDataTable;>= ;</property></emphasis> component - - - - - -
-
-
- Key Features - - Possibility to scroll data - Possibility to add an attribute to set the kin= d of selection (none, single line or multiple lines) - Possibility to change the sequence of the disp= layed columns by dragging the column-header to another position - Possibility to show or hide columns by selecti= ng or deselecting them in a context menu - Possibility to save the current settings (visi= ble columns, column width, sequence of the columns) to be reused the next t= ime the page will be shown - Possibility to combine rows to groups - -
-
\ No newline at end of file + + + &extDataTable; + + +
+ Description + + Note: + The component is released with "Previe= w" marker + + The component for tables extending standard comp= onent + <rich:dataTable> + . +
+ <emphasis role=3D"bold"> + <property><&extDataTa= ble;></property> + </emphasis> component + + + + + +
+
+
+ Key Features + + + Possibility to scroll data + + + Possibility to add an attrib= ute to set the kind of + selection (none, single = line or multiple + lines) + + + Possibility to change the se= quence of the displayed + columns by dragging the = column-header to another + position + + + Possibility to show or hide = columns by selecting or + deselecting them in a co= ntext menu + + + Possibility to save the curr= ent settings (visible + columns, column width, s= equence of the columns) to + be reused the next time = the page will be + shown + + + Possibility to combine rows = to groups + + +
+ Modified: trunk/docs/userguide/en/src/main/docbook/included/extendedDataTab= le.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 --- trunk/docs/userguide/en/src/main/docbook/included/extendedDataTable.xml= 2008-08-27 16:51:11 UTC (rev 10210) +++ trunk/docs/userguide/en/src/main/docbook/included/extendedDataTable.xml= 2008-08-27 17:07:59 UTC (rev 10211) @@ -6,56 +6,56 @@ > =
- - - table - &extDataTable; - HtmlDataTable - - + + + table + &extDataTable; + HtmlDataTable + + = - - Component identification parameters - - - - Name - Value - - - - - component-type - org.richfaces.ExtendedDataTable - - - component-class - org.richfaces.component.html.HtmlExtendedDataTable - - - component-family - org.richfaces.ExtendedDataTable - - - renderer-type - org.richfaces.ExtendedDataTableRenderer - - - tag-class - org.richfaces.taglib.ExtendedDataTableTag - - - -
- = -
- Creating the Component with a Page Tag - Here is a simple example as it could be used on a page: + + Component identification parameters + + + + Name + Value + + + + + component-type + org.richfaces.Ext= endedDataTable + + + component-class + org.richfaces.com= ponent.html.HtmlExtendedDataTable + + + component-family<= /entry> + org.richfaces.Ext= endedDataTable + + + renderer-type + org.richfaces.Ext= endedDataTableRenderer + + + tag-class + org.richfaces.tag= lib.ExtendedDataTableTag + + + +
= - - Example: - - + Creating the Component with a Page Tag + Here is a simple example as it could be used on = a page: + + + Example: + + ... @@ -63,39 +63,42 @@ ... ]]> -
-
- Creating the Component Dynamically from Java +
+
+ Creating the Component Dynamically from Java</t= itle> = - <para> - <emphasis role=3D"bold">Example:</emphasis> - </para> - <programlisting role=3D"JAVA"><![CDATA[import org.richfaces.component.ht= ml.HtmlExtendedDataTable; + <para> + <emphasis role=3D"bold">Example:</emphasis> + </para> + <programlisting role=3D"JAVA"><![CDATA[import org.rich= faces.component.html.HtmlExtendedDataTable; ... HtmlExtendedDataTable myTable =3D new HtmlExtendedDataTable(); ... ]]></programlisting> - </section> - <section> - <title>Details of Usage - The - <&extDataTable;> - component is similar to the - <rich:dataTable> - . The data in component is scrollable. You can also set the t= ype of selection ( - "none", - - "single" - or - "multi" - lines). Selection of multiple lines is possible using Shift = and Ctrl keys. - = - Here is an example: +
+
+ Details of Usage + The + <&extDataTable;> + component is similar to the + <rich:dataTable> + . The data in component is scroll= able. You can also set the + type of selection ( + "none", + + + "single" + or + "multi" + lines). Selection of multiple li= nes is possible using + Shift and Ctrl keys. = - - Example: - - Here is an example: + + + Example: + + = -
- <emphasis role=3D"bold"> - <property><&extDataTable;></property> - </emphasis> component with selected multiple lines - - - - - -
- Information about sorting and filtering can be found here. - = - In the example = - "selection" - attribute contains object with selected rows. = - - = - Note: - Attribute - "height" - is mandatory. The default value is - "500px" - . - - = - - Menu on the right side of the column header is used to perform action: s= orting, grouping, hiding columns. - - = - This is an example: - = -
- Column menu - - - - - -
- = - - After selecting a "Group by this column" option, you can see the data gr= ouped. You can collapse and expand groups by clicking on a group header. - - = - This is an example: - = -
- <emphasis role=3D"bold"> - <property><&extDataTable;></property> - </emphasis> component with grouped data - - - - - -
- = - - The - "label" - attribute in - <rich:column> - sets the name of the column, which is used when dragging col= umns (in drag window) and in context menu, in "Columns" submenu. - - = - - Example: - - + <emphasis role=3D"bold"> + <property><&extDataTa= ble;></property> + </emphasis> component with selecte= d multiple lines + + + + + + + Information about sorting and filtering can be f= ound here. + + In the example + "selection" + attribute contains object with s= elected rows. + + + Note: + Attribute + "height&q= uot; + is mandatory. The defau= lt value is + "500px&qu= ot; + . + + + Menu on the right side of the column header is = used to perform action: + sorting, grouping, hiding columns. + + This is an example: + +
+ Column menu + + + + + +
+ + After selecting a "Group by this column" option= , you can see the data + grouped. You can collapse and expand groups = by clicking on a group + header. + + This is an example: + +
+ <emphasis role=3D"bold"> + <property><&extDataTa= ble;></property> + </emphasis> component with grouped= data + + + + + +
+ + The + "label" + attribute in + <rich:column> + sets the name of the column, whi= ch is used when dragging + columns (in drag window) and in context menu= , in "Columns" submenu. + + + Example: + + ]]> - = -
- <emphasis role=3D"bold"> - <property><&extDataTable;></property> - </emphasis> component with Drag&Drop column 'Name' - - - - - -
- = - - In the component - <&extDataTable;> - columns can hidden: - - = -
- <emphasis role=3D"bold"> - <property><&extDataTable;></property> - </emphasis> component with hidden column 'Id' and 'Group' - - - - - -
- = - = - - "tableState" - attribute can be used to bind state of the table (column wi= dth, column position, visible, sequence, grouping...) = - to a backing-bean string property, for a later used. This state can be f= or example saved to a database, and it is different = - form standard JSF state saving mechanisms. + --> + + "tableState" + attribute can be used to bind st= ate of the table (column + width, column position, visible, sequence, g= rouping...) to a + backing-bean string property, for a later us= ed. This state can be for + example saved to a database, and it is diffe= rent form standard JSF + state saving mechanisms. = - - Example: - + + Example: + = - - = - = -
-
- Look-and-Feel Customization = - For skinnability implementation, the components use a - style class redefinition method. - Default style classes are mapped on - skin parameters. - = - There are two ways to redefine the appearance of all - <&extDataTable;> - components at once: +
+
+ Look-and-Feel Customization = - - - Redefine the corresponding skin parameters - + For skinnability implementation, the components = use a + style class redefinition= method. + Default style classes are mapped= on + skin parameters. + = - - Add to your style sheets - style classes - used by a - <&extDataTable;> - component - - -
+ There are two ways to redefine the appearance of= all + <&extDataTable;> + components at once: = -
- Skin Parameters Redefinition + + + Redefine the corresponding s= kin parameters + = - - Skin parameters redefinition for a table - - - - Skin parameters - CSS properties - - - - - tableBackgroundColor - background-color - - - -
+ + Add to your style sheets + style classes<= /property> + used by a + <&extDataTa= ble;> + component + + +
= - - Skin parameters redefinition for a header - - - - Skin parameters - CSS properties - - - - - headerBackgroundColor - background-color - - - -
+
+ Skin Parameters Redefinition = - - Skin parameters redefinition for a footer - - - - Skin parameters - CSS properties - - - - - tableFooterBackgroundColor - background-color - - - -
+ + Skin parameters redefinition for a ta= ble + + + + Skin parameters + CSS properties + + + + + tableBackgroundCo= lor + background-color<= /entry> + + + +
= - - Skin parameters redefinition for a column header - - - - Skin parameters - CSS properties - - - - - additionalBackgroundColor - background-color - - - -
+ + Skin parameters redefinition for a he= ader + + + + Skin parameters + CSS properties + + + + + headerBackgroundC= olor + background-color<= /entry> + + + +
= - - Skin parameters redefinition for a column footer - - - - Skin parameters - CSS properties - - - - - tableSubfooterBackgroundColor - background-color - - - -
+ + Skin parameters redefinition for a fo= oter + + + + Skin parameters + CSS properties + + + + + tableFooterBackgr= oundColor + background-color<= /entry> + + + +
= - - Skin parameters redefinition for cells - - - - Skin parameters - CSS properties - - - - - generalSizeFont - font-size - - - generalTextColor - color - - - generalFamilyFont - font-family - - - -
+ + Skin parameters redefinition for a co= lumn header + + + + Skin parameters + CSS properties + + + + + additionalBackgro= undColor + background-color<= /entry> + + + +
= -
+ + Skin parameters redefinition for a co= lumn footer + + + + Skin parameters + CSS properties + + + + + tableSubfooterBac= kgroundColor + background-color<= /entry> + + + +
= -
- Definition of Custom Style Classes + + Skin parameters redefinition for cell= s + + + + Skin parameters + CSS properties + + + + + generalSizeFont + font-size + + + generalTextColor<= /entry> + color + + + generalFamilyFont= + font-family + + + +
= - On the screenshot there are classes names that define styles for c= omponent elements. +
= -
- <emphasis role=3D"bold"><property><&extDataTable;></propert= y></emphasis> class names - - - - - -
+
+ Definition of Custom Style Classes = - - Classes names that define a whole component appearance - - - - Class name - Description - - - - - rich-extdt - Defines styles for all table - - - rich-extdt-caption - Defines styles for a "caption" facet element - - - -
+ On the screenshot there are classes names that d= efine styles for component + elements. = - - Classes names that define header and footer elements - - - - Class name - Description - - - +
+ <emphasis role=3D"bold"> + <property><&extDataTa= ble;></property> + </emphasis> class names + + + + + +
= - - rich-extdt-header - Defines styles for a table header row - +
+ Classes names that define a whole com= ponent appearance + + + + Class name + Description + + + + + rich-extdt + Defines styles fo= r all + table + + + rich-extdt-captio= n + Defines styles fo= r a + "caption" + facet element + + + +
= - - rich-extdt-header-continue - Defines styles for all header lines after the first - - - rich-extdt-subheader - Defines styles for a column header - + + Classes names that define header and = footer elements + + + + Class name + Description + + + = - - rich-extdt-footer - Defines styles for a footer row - + + rich-extdt-header= + Defines styles fo= r a table header + row + = - - rich-extdt-footer-continue - Defines styles for all footer lines after the first - - - rich-extdt-subfooter - Defines styles for a column footer - - - -
+ + rich-extdt-header= -continue + Defines styles fo= r all header + lines after the first + + + rich-extdt-subhea= der + Defines styles fo= r a column + header + = - - Classes names that define rows and cells of a table - - - - Class name - Description - - - - - rich-extdt-headercell - Defines styles for a header cell - + + rich-extdt-footer= + Defines styles fo= r a footer + row + = - - rich-extdt-subheadercell - Defines styles for a column header cell - - - rich-extdt-cell - Defines styles for a table cell - - - rich-extdt-row - Defines styles for a table row - - - rich-extdt-firstrow - Defines styles for a table start row - + + rich-extdt-footer= -continue + Defines styles fo= r all footer + lines after the first + + + rich-extdt-subfoo= ter + Defines styles fo= r a column + footer + + + +
= - - rich-extdt-footercell - Defines styles for a footer cell - + + Classes names that define rows and ce= lls of a table + + + + Class name + Description + + + + + rich-extdt-header= cell + Defines styles fo= r a header + cell + = - - rich-extdt-subfootercell - Defines styles for a column footer cell - - - -
+ + rich-extdt-subhea= dercell + Defines styles fo= r a column + header cell + + + rich-extdt-cell + Defines styles fo= r a table + cell + + + rich-extdt-row + Defines styles fo= r a table + row + + + rich-extdt-firstr= ow + Defines styles fo= r a table start + row + = - An example of use the styles for component - <&extDataTable;> - is similar to = - - <rich:dataTable> - - - = -
+ + rich-extdt-footer= cell + Defines styles fo= r a footer + cell + + + + rich-extdt-subfoo= tercell + Defines styles fo= r a column + footer cell + + + + + + An example of use the styles for component + <&extDataTable;> + is similar to + <rich:dataTable> + + + +
--===============2318462004683262745==--