From richfaces-svn-commits at lists.jboss.org Fri Aug 15 11:49:39 2008 Content-Type: multipart/mixed; boundary="===============8451578142287786801==" 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: r10120 - trunk/docs/userguide/en/src/main/docbook/included. Date: Fri, 15 Aug 2008 11:49:39 -0400 Message-ID: --===============8451578142287786801== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: atsebro Date: 2008-08-15 11:49:39 -0400 (Fri, 15 Aug 2008) New Revision: 10120 Modified: trunk/docs/userguide/en/src/main/docbook/included/columns.xml Log: RF-4102: Columns: use restriction. Adding the note to the end of the "Details of usage" section Modified: trunk/docs/userguide/en/src/main/docbook/included/columns.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/columns.xml 2008-08-1= 5 15:44:28 UTC (rev 10119) +++ trunk/docs/userguide/en/src/main/docbook/included/columns.xml 2008-08-1= 5 15:49:39 UTC (rev 10120) @@ -1,27 +1,27 @@
- - - rich:columns - columns - - - - Component identification parameters + + + rich:columns + columns + + +
+ Component identification parameters = - - - - Name - Value - - - - - component-type - org.richfaces.Column - - - - tag-class - - org.richfaces.taglib.ColumnsTagHandler - - - - -
-
- Creating the Component with a Page Tag - - To create the simplest variant on a page use the following - syntax: - - - Example: - - + tag-class + org.richfaces.ta= glib.ColumnsTagHandler + + + + + +
+ Creating the Component with a Page Tag + To create the simplest variant on a page use th= e following syntax: + + Example: + + = ...]]> -
-
- Creating the Component Dynamically Using Java - - Example: - - +
+ Creating the Component Dynamically Using Java</= title> + <para> + <emphasis role=3D"bold">Example:</emphasis> + </para> + <programlisting role=3D"JAVA"><![CDATA[import org.rich= faces.component.html.HtmlColumns; ... = HtmlColumns myColumns =3D new HtmlColumns(); ...]]></programlisting> - </section> - <section> - <title>Details of Usage - - The - - <rich:columns> - - component gets a list from data model and outputs - corresponding set of columns inside - - <rich:dataTable> - - on a page. It is possible to use - - "header" - - and - - "footer" - - facets with - - <rich:columns> - - component. - - - The - - "value" - - and - - "var" - - attributes are used to access the values of collection. - - The simple example is placed below. - - Example: - - +
+ Details of Usage + The + <rich:columns> + component gets a list from data = model and outputs + corresponding set of columns inside + <rich:dataTable> + on a page. It is possible to use= + "header" + and + "footer" + facets with + <rich:columns> + component. + The + "value" + and + "var" + attributes are used to access th= e values of collection. + The simple example is placed below. + + Example: + + @@ -123,46 +101,27 @@ = ...]]> - - The - - "columns" - - attribute defines the count of columns. - - - The - - "rows" - - attribute defines the number of rows to be displayed. If the - value of this attribute is zero, all remaining rows in the - table are displayed on a page. - - - The - - "begin" - - attribute contains the first iteration item. Note, that - iteration begins from zero. - - - The - - "end" - - attribute contains the last iteration item. - - - With the help of the attributes described below you can - customize the output, i.e. define which columns and how many - rows appear on a page. - - - Example: - - The + "columns" + attribute defines the count of c= olumns. + The + "rows" + attribute defines the number of = rows to be displayed. If + the value of this attribute is zero, all rem= aining rows in the table + are displayed on a page. + The + "begin" + attribute contains the first ite= ration item. Note, that + iteration begins from zero. + The + "end" + attribute contains the last iter= ation item. + With the help of the attributes described below= you can customize the + output, i.e. define which columns and how ma= ny rows appear on a page. + + Example: + + @@ -172,45 +131,31 @@ = ...]]> - - In the example below, columns from first to second and all - rows are shown in the - - <rich:dataTable> - - . - - The result is: -
- - Generated - <emphasis role=3D"bold"> - <property><rich:columns></property> - </emphasis> - with columns from first to second and all rows - - - - - - -
- - The - - <rich:columns> - - component does not prevent to use - - <rich:column> - - . In the following example one column renders in any way and - another columns could be picked from the model. - - - Example: - - In the example below, columns from first to sec= ond and all rows are shown + in the + <rich:dataTable> + . + The result is: +
+ Generated <emphasis role=3D"bold"> + <property><rich:colum= ns></property> + </emphasis> with columns from firs= t to second and all rows + + + + + +
+ The + <rich:columns> + component does not prevent to us= e + <rich:column> + . In the following example one c= olumn renders in any way + and another columns could be picked from the= model. + + Example: + + @@ -227,23 +172,17 @@ = ...]]> = - - In order to group columns with text information into one - row, use the - - "colspan" - - attribute, which is similar to an HTML one. In the following - example the third column contains 3 columns. In addition, - it's necessary to specify that the next column begins - from the first row with the help of the - breakBefore =3D "true" - . - - - Example: - - In order to group columns with text information= into one row, use the + "colspan" + attribute, which is similar to a= n HTML one. In the + following example the third column contains = 3 columns. In addition, + it's necessary to specify that the next= column begins from + the first row with the help of the bre= akBefore =3D + "true" . + + Example: + + @@ -261,7 +200,7 @@ ... ]]> = - = - - The same way is used for - columns - grouping with the - - "rowspan" - - attribute that is similar to an HTML. The only thing to add - in the example is an instruction to move onto the next row - for each next after the second column. - - - Example: - - The same way is used for columns grouping with the + "rowspan" + attribute that is similar to an = HTML. The only thing to + add in the example is an instruction to move= onto the next row for + each next after the second column. + + Example: + + = @@ -303,7 +236,7 @@ ... ]]> = - - - Information about sorting and filtering you can find - here - . - + + Note: + + The <rich:columns> tag is initialized during co= mponents tree building process. = + This process precedes page renderi= ng at "Render Response" JSF phase. = + To be rendered properly the compon= ent needs all it variables to be initialized while the components tree is b= eing building. = + A javax.servlet.jsp.JspT= agException occurs if <rich= :columns> uses variables passed from other compone= nts, if these variables are initialized during rendering. = + Thus, when <rich:columns> is asking for such va= riables they do not already exist. = + Use <c:forEach> JSP standard tag as workaround. = + Compare two examples below. + + + This code calls the exception: + + + + ... + + +... +]]> + + This code works properly: + + + + ... + + +... +]]> + + = + = + Information about sorting and filtering you can= find here . = -
+
= -
- Look-and-Feel Customization +
+ 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 - - <rich:columns> - - components at once: - - - - Redefine the corresponding skin parameters - - - - Add to your style sheets - - style classes - - used by a - - <rich:columns> - - component - - - -
-
- Skin Parameters Redefinition + 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 o= f all + <rich:columns> + components at once: + + + Redefine the corresponding s= kin parameters + + + Add to your style sheets + style classes<= /property> + used by a + <rich:colum= ns> + component + + +
+
+ Skin Parameters Redefinition = - - Skin parameters redefinition for - - <rich:columns> - - are the same as for the - - <rich:dataTable> - - component - . - -
-
- Definition of Custom Style Classes + Skin parameters redefinition for + <rich:columns> + are the same as for the + <rich:dataTable> + + component . +
+
+ Definition of Custom Style Classes = - - Custom style classes for - - <rich:columns> - - are the same as for the - - <rich:dataTable> - - component - . - + Custom style classes for + <rich:columns> + are the same as for the + <rich:dataTable> + + component . = = - - In order to redefine styles for all - - <rich:columns> - - components on a page using CSS, it's enough to create - classes with the same names (possible classes could be found - in the tables - above - ) and define necessary properties in them. - + In order to redefine styles for all + <rich:columns> + components on a page using CSS, = it's enough to + create classes with the same names (possible= classes could be found in + the tables above ) and define necessary + properties in them. = - - Example: - - + Example: + + = - This is a result: + This is a result: = -
- Redefinition styles with predefined classes - - - - - -
+
+ Redefinition styles with predefined c= lasses + + + + + +
= - - In the example column header cells color was changed. - + In the example column header cells color was ch= anged. = - - Also it's possible to change styles of particular - - <rich:columns> - - component. In this case you should create own style classes - and use them in corresponding - - <rich:columns> - - - styleClass - - attributes. An example is placed below: - + Also it's possible to change styles of par= ticular + <rich:columns> + component. In this case you shou= ld create own style + classes and use them in corresponding + <rich:columns> + + + styleClass + attributes. An example is placed= below: = - - Example: - - + Example: + + - - The - - "styleClass" - - attribute for - - <rich:columns> - - is defined as it's shown in the example below: - + The + "styleClass" + attribute for + <rich:columns> + is defined as it's shown in= the example below: = - - Example: - - + + Example: + + ]]> = - This is a result: + This is a result: = -
- - Redefinition styles with own classes and - <emphasis> - <property>styleClass</property> - </emphasis> - attributes - - - - - - -
+
+ Redefinition styles with own classes= and <emphasis> + <property>styleClass</pr= operty> + </emphasis> attributes + + + + + +
= - - As it could be seen on the picture above, the font style for - columns was changed. - -
+ As it could be seen on the picture above, the f= ont style for columns was + changed. +
= -
- Relevant Resources Links - - - Here - - you can found some additional information for - - <rich:columns> - - component usage. - -
-
\ No newline at end of file +
+ Relevant Resources Links + + Here you can found some= additional information + for + <rich:columns> + component usage. +
+
--===============8451578142287786801==--