From richfaces-svn-commits at lists.jboss.org Mon Jun 30 04:01:17 2008 Content-Type: multipart/mixed; boundary="===============7570801593009379745==" 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: r9293 - trunk/docs/userguide/en/src/main/docbook/included. Date: Mon, 30 Jun 2008 04:00:12 -0400 Message-ID: --===============7570801593009379745== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: pkawiak Date: 2008-06-30 04:00:12 -0400 (Mon, 30 Jun 2008) New Revision: 9293 Added: trunk/docs/userguide/en/src/main/docbook/included/extendedDataTable.desc= .xml trunk/docs/userguide/en/src/main/docbook/included/extendedDataTable.xml Log: Documentation xml's commit Added: trunk/docs/userguide/en/src/main/docbook/included/extendedDataTable.= 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 (rev 0) +++ trunk/docs/userguide/en/src/main/docbook/included/extendedDataTable.des= c.xml 2008-06-30 08:00:12 UTC (rev 9293) @@ -0,0 +1,40 @@ + + + +] +> + +
+ + + &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 Added: trunk/docs/userguide/en/src/main/docbook/included/extendedDataTable.= 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= (rev 0) +++ trunk/docs/userguide/en/src/main/docbook/included/extendedDataTable.xml= 2008-06-30 08:00:12 UTC (rev 9293) @@ -0,0 +1,574 @@ + + +] +> + +
+ + + 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: + + + Example: + + + + ... + + +... +]]> +
+
+ Creating the Component Dynamically from Java + + + Example: + + +
+
+ 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: + + + 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. = + + = + + 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><&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. + + + 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: + + + + Redefine the corresponding skin parameters + + + + Add to your style sheets + style classes + used by a + <&extDataTable;> + component + + +
+ +
+ Skin Parameters Redefinition + + + Skin parameters redefinition for a table + + + + Skin parameters + CSS properties + + + + + tableBackgroundColor + background-color + + + +
+ + + Skin parameters redefinition for a header + + + + Skin parameters + CSS properties + + + + + headerBackgroundColor + background-color + + + +
+ + + Skin parameters redefinition for a footer + + + + Skin parameters + CSS properties + + + + + tableFooterBackgroundColor + background-color + + + +
+ + + Skin parameters redefinition for a column header + + + + Skin parameters + CSS properties + + + + + additionalBackgroundColor + background-color + + + +
+ + + Skin parameters redefinition for a column footer + + + + Skin parameters + CSS properties + + + + + tableSubfooterBackgroundColor + background-color + + + +
+ + + Skin parameters redefinition for cells + + + + Skin parameters + CSS properties + + + + + generalSizeFont + font-size + + + generalTextColor + color + + + generalFamilyFont + font-family + + + +
+ +
+ +
+ Definition of Custom Style Classes + + 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 + + + + + +
+ + + 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 + + + +
+ + + Classes names that define header and footer elements + + + + Class name + Description + + + + + + rich-extdt-header + Defines styles for a table header row + + + + rich-extdt-header-continue + Defines styles for all header lines after the first + + + rich-extdt-subheader + Defines styles for a column header + + + + rich-extdt-footer + Defines styles for a footer row + + + + rich-extdt-footer-continue + Defines styles for all footer lines after the first + + + rich-extdt-subfooter + Defines styles for a column footer + + + +
+ + + Classes names that define rows and cells of a table + + + + Class name + Description + + + + + rich-extdt-headercell + Defines styles for a header cell + + + + 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-footercell + Defines styles for a footer cell + + + + rich-extdt-subfootercell + Defines styles for a column footer cell + + + +
+ + An example of use the styles for component + <&extDataTable;> + is similar to = + + <rich:dataTable> + + + = +
+
--===============7570801593009379745==--