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

Author: SeanRogers Date: 2009-11-17 18:57:00 -0500 (Tue, 17 Nov 2009) New Revision: 15906 Modified: root/docs/trunk/Component_Reference/en-US/Actions.xml root/docs/trunk/Component_Reference/en-US/Book_Info.xml root/docs/trunk/Component_Reference/en-US/Component_Reference.xml root/docs/trunk/Component_Reference/en-US/Preface.xml root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml Log: Worked on Actions Modified: root/docs/trunk/Component_Reference/en-US/Actions.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/Actions.xml 2009-11-17 23:32:18 UTC (rev 15905) +++ root/docs/trunk/Component_Reference/en-US/Actions.xml 2009-11-17 23:57:00 UTC (rev 15906) @@ -37,28 +37,11 @@ </para> <example id="exam-Component_Reference-a4jactionParam-a4jactionParam_example"> <title>&lt;a4j:actionParam&gt; example</title> - <programlisting language="xml"> -&lt;h:form id="form"&gt; - &lt;a4j:commandButton value="Set name to Alex" reRender="rep"&gt; - &lt;a4j:actionparam name="username" value="Alex" assignTo="#{actionparamBean.name}"/&gt; - &lt;/a4j:commandButton&gt; - &lt;h:outputText id="rep" value="Name: #{actionparamBean.name}"/&gt; -&lt;/h:form&gt; +<xi:include parse="text" href="extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </programlisting> - <programlisting language="java"> -public class ActionparamBean { - private String name = "John"; - - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } -} +<xi:include parse="text" href="extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.js" xmlns:xi="http://www.w3.org/2001/XInclude" /> </programlisting> </example> <para> @@ -204,23 +187,18 @@ </section> <section id="sect-Component_Reference-Actions-a4jjsFunction"> - <title>a4j:jsFunction</title> + <title>&lt;a4j:jsFunction&gt;</title> <para> - The <classname>&lt;a4j:jsFunction&gt;</classname> component allows Ajax requests to be performed directly from JavaScript code, and server-side data to be invoked and returned in a <acronym>JSON</acronym> format to use in client-side JavaScript calls. + The <classname>&lt;a4j:jsFunction&gt;</classname> component allows Ajax requests to be performed directly from JavaScript code, and server-side data to be invoked and returned in JavaScript Object Notation (<acronym>JSON</acronym>) format to use in client-side JavaScript calls. </para> <para> - The <classname>&lt;a4j:jsFunction&gt;</classname> component has all the common Ajax action attributes as listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />; the <code>action</code> and <code>actionListener</code> attributes can be invoked and parts of the page can be re-rendered after a successful call to the JavaScript function. The example shows how an Ajax request can be initiated from the JavaScript and a partial page update performed. The JavaScript function can be invoked with the data returned by the Ajax response. + The <classname>&lt;a4j:jsFunction&gt;</classname> component has all the common Ajax action attributes as listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />; the <code>action</code> and <code>actionListener</code> attributes can be invoked and parts of the page can be re-rendered after a successful call to the JavaScript function. <xref linkend="exam-Component_Reference-a4jjsFunction-a4jjsFunction_example" /> shows how an Ajax request can be initiated from the JavaScript and a partial page update performed. The JavaScript function can be invoked with the data returned by the Ajax response. </para> - <example> + <example id="exam-Component_Reference-a4jjsFunction-a4jjsFunction_example"> <title>&lt;a4j:jsFunction&gt; example</title> + <programlisting language="xml"> -&lt;h:form&gt; - ... - &lt;a4j:jsFunction name="callScript" data="#{bean.someProperty1}" reRender="someComponent" oncomplete="myScript(data.subProperty1, data.subProperty2)"&gt; - &lt;a4j:actionParam name="param_name" assignTo="#{bean.someProperty2}"/&gt; - &lt;/a4j:jsFunction&gt; - ... -&lt;/h:form&gt; +<xi:include href="extras/exam-Component_Reference-a4jjsFunction-a4jjsFunction_example.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> </programlisting> </example> <para> @@ -232,14 +210,17 @@ </section> <section id="sect-Component_Reference-Actions-a4jpoll"> - <title>a4j:poll</title> + <title>&lt;a4j:poll&gt;</title> <para> - Incomplete + The <classname>&lt;a4j:poll&gt;</classname> component allows periodical sending of Ajax requests to the server. It is used for repeatedly updating a page at specific time intervals. </para> + <para> + The <code>interval</code> attribute specifies the time in milliseconds to between requests. The default for this value is 1000 ms (1 second). + </para> </section> <section id="sect-Component_Reference-Actions-a4jpush"> - <title>a4j:push</title> + <title>&lt;a4j:push&gt;</title> <para> Incomplete </para> Modified: root/docs/trunk/Component_Reference/en-US/Book_Info.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/Book_Info.xml 2009-11-17 23:32:18 UTC (rev 15905) +++ root/docs/trunk/Component_Reference/en-US/Book_Info.xml 2009-11-17 23:57:00 UTC (rev 15906) @@ -27,7 +27,7 @@ <year>&YEAR;</year> <holder>&HOLDER;</holder> </copyright> - <!-- FOR PUBLICAN --><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR JDOCBOOK: --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <!-- FOR PUBLICAN --><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR JDOCBOOK: --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> </xi:fallback> </xi:include> <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> Modified: root/docs/trunk/Component_Reference/en-US/Component_Reference.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/Component_Reference.xml 2009-11-17 23:32:18 UTC (rev 15905) +++ root/docs/trunk/Component_Reference/en-US/Component_Reference.xml 2009-11-17 23:57:00 UTC (rev 15906) @@ -4,9 +4,9 @@ <book status="draft"> <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <!-- + <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - --><xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + --><xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="Common_Ajax_attributes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="Common_features.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <part id="part-Component_Reference-a4j_tag_library"> Modified: root/docs/trunk/Component_Reference/en-US/Preface.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/Preface.xml 2009-11-17 23:32:18 UTC (rev 15905) +++ root/docs/trunk/Component_Reference/en-US/Preface.xml 2009-11-17 23:57:00 UTC (rev 15906) @@ -4,10 +4,10 @@ <preface id="pref-Component_Reference-Preface"> <title>Preface</title> - <!-- FOR JDOCBOOK --><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR PUBLICAN --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <!-- FOR JDOCBOOK --><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR PUBLICAN --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> </xi:fallback> </xi:include> - <!-- PUBLICAN'S ORIGINAL XINCLUDES --><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR JDOCBOOK --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <!-- PUBLICAN'S ORIGINAL XINCLUDES --><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR JDOCBOOK --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> </xi:fallback> </xi:include> </xi:fallback> Modified: root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml 2009-11-17 23:32:18 UTC (rev 15905) +++ root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml 2009-11-17 23:57:00 UTC (rev 15906) @@ -28,7 +28,7 @@ <year>2009</year> <holder>Red Hat</holder> </copyright> - <!-- FOR PUBLICAN --> + <!-- FOR PUBLICAN --> <legalnotice xml:base="Common_Content/Legal_Notice.xml"> <para> Copyright <trademark class="copyright"></trademark> 2009 Red Hat This material may only be distributed subject to the terms and conditions set forth in the GNU Free Documentation License (GFDL), V1.2 or later (the latest version is presently available at <ulink url="http://www.gnu.org/licenses/fdl.txt">http://www.gnu.org...>). @@ -46,7 +46,7 @@ </author> </authorgroup> </bookinfo> - <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> --> + <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> --> <chapter id="chap-Component_Reference-Introduction" lang="en-US"> <title>Introduction</title> <para>