[richfaces-svn-commits] JBoss Rich Faces SVN: r16328 - root/docs/trunk/Component_Reference/en-US.

Author: SeanRogers Date: 2010-01-18 21:07:44 -0500 (Mon, 18 Jan 2010) New Revision: 16328 Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Common_Ajax_attributes.xml root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Selection_and_ordering.xml root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tables_and_grids.xml Log: Completed Common Ajax Attributes, worked on Tables and Selection chapters Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Common_Ajax_attributes.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Common_Ajax_attributes.xml 2010-01-19 01:54:06 UTC (rev 16327) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Common_Ajax_attributes.xml 2010-01-19 02:07:44 UTC (rev 16328) @@ -178,42 +178,48 @@ <section id="sect-Component_Reference-Events_and_JavaScript_interactions-onsubmit"> <title><varname>onsubmit</varname></title> <para> - The <varname>onsubmit</varname> attribute will invoke the JavaScript code before the Ajax request is sent. The request is canceled if the JavaScript code defined for <varname>onsubmit</varname> returns <literal>false</literal>. + The <varname>onsubmit</varname> attribute invokes the JavaScript code <emphasis>before</emphasis> the Ajax request is sent. The request is canceled if the JavaScript code defined for <varname>onsubmit</varname> returns <literal>false</literal>. </para> </section> - <section id="sect-Component_Reference-Events_and_JavaScript_interactions-onclick"> - <title><varname>onclick</varname></title> + <section id="sect-Component_Reference-Events_and_JavaScript_interactions-onbegin"> + <title><varname>onbegin</varname></title> <para> - The <varname>onclick</varname> attribute functions similarly to the <varname>onsubmit</varname> attribute for those components that can be clicked, such as <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> and <sgmltag>&lt;a4j:commandLink&gt;</sgmltag>. It invokes the defined JavaScript before the Ajax request, and the request will be canceled if the defined code returns <literal>false</literal>. + The <varname>onbegin</varname> attribute invokes the JavaScript code <emphasis>after</emphasis> the Ajax request is sent. </para> </section> - <section id="sect-Component_Reference-Events_and_JavaScript_interactions-oncomplete"> - <title><varname>oncomplete</varname></title> + <section id="sect-Component_Reference-Events_and_JavaScript_interactions-onclick"> + <title><varname>onclick</varname></title> <para> - The <varname>oncomplete</varname> attribute invokes the JavaScript code after the Ajax response has been returned and the <acronym>DOM</acronym> tree of the browser has been updated. The code is registered for further invocation of the <acronym>XMLHTTP</acronym> request object before an Ajax request is sent. As such, using <acronym>JSF</acronym> Expression Language (<acronym>EL</acronym>) value binding means the code will not be changed during processing of the request on the server. Additionally the <varname>oncomplete</varname> attribute cannot use the <literal>this</literal> keyword as it will not point to the component from which the Ajax request was initiated. + The <varname>onclick</varname> attribute functions similarly to the <varname>onsubmit</varname> attribute for those components that can be clicked, such as <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> and <sgmltag>&lt;a4j:commandLink&gt;</sgmltag>. It invokes the defined JavaScript before the Ajax request, and the request will be canceled if the defined code returns <literal>false</literal>. </para> </section> - <section id="sect-Component_Reference-Events_and_JavaScript_interactions-onbegin"> - <title><varname>onbegin</varname></title> + <section id="sect-Component_Reference-Events_and_JavaScript_interactions-onsuccess"> + <title><varname>onsuccess</varname></title> <para> - Incomplete + The <varname>onsuccess</varname> attribute invokes the JavaScript code after the Ajax response has been returned but <emphasis>before</emphasis> the <acronym>DOM</acronym> tree of the browser has been updated. </para> </section> - <section id="sect-Component_Reference-Events_and_JavaScript_interactions-onsuccess"> - <title><varname>onsuccess</varname></title> + <section id="sect-Component_Reference-Events_and_JavaScript_interactions-oncomplete"> + <title><varname>oncomplete</varname></title> <para> - Incomplete + The <varname>oncomplete</varname> attribute invokes the JavaScript code after the Ajax response has been returned <emphasis>and</emphasis> the <acronym>DOM</acronym> tree of the browser has been updated. </para> + <note> + <title>Reference consistency</title> + <para> + The code is registered for further invocation of the <acronym>XMLHTTP</acronym> request object before an Ajax request is sent. As such, using <acronym>JSF</acronym> Expression Language (<acronym>EL</acronym>) value binding means the code will not be changed during processing of the request on the server. Additionally the <varname>oncomplete</varname> attribute cannot use the <literal>this</literal> keyword as it will not point to the component from which the Ajax request was initiated. + </para> + </note> </section> <section id="sect-Component_Reference-Events_and_JavaScript_interactions-onerror"> <title><varname>onerror</varname></title> <para> - Incomplete + The <varname>onerror</varname> attribute invokes the JavaScript code when an error has occurred during Ajax communications. </para> </section> Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Selection_and_ordering.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Selection_and_ordering.xml 2010-01-19 01:54:06 UTC (rev 16327) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Selection_and_ordering.xml 2010-01-19 02:07:44 UTC (rev 16328) @@ -4,14 +4,17 @@ <chapter id="chap-Component_Reference-Selection_and_ordering"> <title>Selection and ordering</title> <para> - Incomplete + This chapter describes those components used for the selection and ordering of objects in lists. </para> <section id="sect-Component_Reference-Trees-richlistShuttle"> <title>rich:listShuttle</title> <para> - Incomplete + The <sgmltag>&lt;rich:listShuttle&gt;</sgmltag> component is used for moving select items from one list into another. Items can optionally be re-ordered. It supports selection of multiple items, keyboard usage, and a customizable look and feel. </para> + <para> + + </para> </section> <section id="sect-Component_Reference-Trees-richorderingList"> Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tables_and_grids.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-01-19 01:54:06 UTC (rev 16327) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-01-19 02:07:44 UTC (rev 16328) @@ -39,7 +39,7 @@ The <sgmltag>&lt;rich:column&gt;</sgmltag> component facilitates columns in a table or other <classname>UIData</classname> component. It supports merging columns and rows, sorting, filtering, and customized skinning. </para> <para> - In general usage, the the <sgmltag>&lt;rich:column&gt;</sgmltag> component is used in the same was as the JavaServer Faces (<acronym>JSF</acronym>) <sgmltag>&lt;h:column&gt;</sgmltag> component. It requires no extra attributes for basic usage, as shown in <xref linkend="exam-Component_Reference-richcolumn-Basic_column_example" /> and the resulting <xref linkend="figu-Component_Reference-richcolumn-Basic_column_example" />. + In general usage, the <sgmltag>&lt;rich:column&gt;</sgmltag> component is used in the same was as the JavaServer Faces (<acronym>JSF</acronym>) <sgmltag>&lt;h:column&gt;</sgmltag> component. It requires no extra attributes for basic usage, as shown in <xref linkend="exam-Component_Reference-richcolumn-Basic_column_example" /> and the resulting <xref linkend="figu-Component_Reference-richcolumn-Basic_column_example" />. </para> <example id="exam-Component_Reference-richcolumn-Basic_column_example"> <title>Basic column example</title> @@ -74,7 +74,7 @@ </mediaobject> </figure> <para> - Columns can be merged by using the <varname>colspan</varname> attribute to specify how many normal columns to span. The <varname>colspan</varname> attribute is used in conjunction with the <varname>breakBefore</varname> attribute on the next column to determine how the merged columns are laid out. <xref linkend="exam-Component_Reference-richcolumn-Column_spanning_example" /> and the resulting <xref linkend="figu-Component_Reference-richcolumn-Column_spanning_example" /> show the first column spanning a width of three columns, with the others broken on to the following line. + Columns can be merged by using the <varname>colspan</varname> attribute to specify how many normal columns to span. The <varname>colspan</varname> attribute is used in conjunction with the <varname>breakBefore</varname> attribute on the next column to determine how the merged columns are laid out. <xref linkend="exam-Component_Reference-richcolumn-Column_spanning_example" /> and the resulting <xref linkend="figu-Component_Reference-richcolumn-Column_spanning_example" /> show the first column spanning a width of three columns, with the others broken onto the following line. </para> <example id="exam-Component_Reference-richcolumn-Column_spanning_example"> <title>Column spanning example</title> @@ -301,6 +301,13 @@ </para> </section> + <section id="sect-Component_Reference-Trees-richdataDefinitionList"> + <title>rich:dataDefinitionList</title> + <para> + Incomplete + </para> + </section> + <section id="sect-Component_Reference-Tables_and_grids-richdataFilterSlider"> <title>rich:dataFilterSlider</title> <itemizedlist> @@ -431,6 +438,20 @@ </example> </section> + <section id="sect-Component_Reference-Trees-richdataList"> + <title>rich:dataList</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Trees-richdataOrderedList"> + <title>rich:dataOrderedList</title> + <para> + Incomplete + </para> + </section> + <section id="sect-Component_Reference-Tables_and_grids-richdataScroller"> <title>rich:dataScroller</title> <para> @@ -448,7 +469,7 @@ <section id="sect-Component_Reference-Tables_and_grids-richextendedDataTable"> <title>rich:extendedDataTable</title> <para> - Incomplete + * Combined with rich:scrollableDataTable </para> </section> @@ -459,13 +480,6 @@ </para> </section> - <section id="sect-Component_Reference-Tables_and_grids-richscrollableDataTable"> - <title>rich:scrollableDataTable</title> - <para> - Incomplete - </para> - </section> - <section id="sect-Component_Reference-Tables_and_grids-richsubTable"> <title>rich:subTable</title> <para>