[richfaces-svn-commits] JBoss Rich Faces SVN: r15884 - root/docs/trunk/Component_Reference/en-US.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Mon Nov 16 00:49:11 EST 2009
Author: SeanRogers
Date: 2009-11-16 00:49:10 -0500 (Mon, 16 Nov 2009)
New Revision: 15884
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/Menus_and_toolbars.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.xml
Modified: root/docs/trunk/Component_Reference/en-US/Actions.xml
===================================================================
--- root/docs/trunk/Component_Reference/en-US/Actions.xml 2009-11-16 00:00:24 UTC (rev 15883)
+++ root/docs/trunk/Component_Reference/en-US/Actions.xml 2009-11-16 05:49:10 UTC (rev 15884)
@@ -10,22 +10,98 @@
<section id="sect-Component_Reference-Actions-a4jactionParam">
<title>a4j:actionParam</title>
<para>
- Incomplete
+ The <classname><a4j:actionParam></classname> behavior combines the functionality of the JavaServer Faces (<acronym>JSF</acronym>) components <classname><f:param></classname> and <classname><f:actionListener></classname>.
</para>
+ <para>
+ Basic usage of the <classname><a4j:actionParam></classname> requires three main attributes:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <code>name</code>, for the name of the parameter;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <code>value</code>, for the initial value of the parameter; and
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <code>assignTo</code>, for defining the bean property. The property will be updated if the parent command component performs an action event during the <emphasis>Process Request</emphasis> phase.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ <xref linkend="exam-Component_Reference-a4jactionParam-a4jactionParam_example" /> shows a simple implementation along with the accompanying managed bean. When the <guibutton>Set name to Alex</guibutton> button is pressed, the application sets the <code>name</code> parameter of the bean to <literal>Alex</literal>, and displays the name in the output field.
+ </para>
+ <example id="exam-Component_Reference-a4jactionParam-a4jactionParam_example">
+ <title><a4j:actionParam> example</title>
+
+<programlisting language="xml">
+<h:form id="form">
+ <a4j:commandButton value="Set name to Alex" reRender="rep">
+ <a4j:actionparam name="username" value="Alex" assignTo="#{actionparamBean.name}"/>
+ </a4j:commandButton>
+ <h:outputText id="rep" value="Name: #{actionparamBean.name}"/>
+</h:form>
+</programlisting>
+
+<programlisting language="java">
+public class ActionparamBean {
+ private String name = "John";
+
+ public String getName() {
+ return name;
+ }
+
+ public void setName(String name) {
+ this.name = name;
+ }
+}
+</programlisting>
+ </example>
+ <para>
+ The <classname><a4j:actionParam></classname> behavior can be used with non-Ajax components in addition to Ajax components. In this way, data model values can be updated without an JavaScript code on the server side.
+ </para>
+ <para>
+ The <code>converter</code> attribute can be used to specify how to convert the value before it is submitted to the data model. The property is assigned the new value during the <emphasis>Update Model</emphasis> phase.
+ </para>
+ <note>
+ <title>Note</title>
+ <para>
+ If the validation of the form fails the <emphasis>Update Model</emphasis> phase will be skipped and the property will not be updated.
+ </para>
+ </note>
+ <para>
+ Variables from JavaScript functions can be used for the <code>value</code> attribute. In such an implementation, the <code>noEscape</code> attribute should be set to <literal>true</literal>. Using <code>noEscape="true"</code>, the <code>value</code> attribute can contain any JavaScript expression or JavaScript function invocation, and the result will be sent to the server as the <code>value</code> attribute.
+ </para>
</section>
<section id="sect-Component_Reference-Actions-a4jajax">
<title>a4j:ajax</title>
<para>
- Incomplete
+ The <classname><a4j:ajax></classname> component allows Ajax capability to be added to any non-Ajax component. It is placed as a direct child to the component that requires Ajax support. The <classname><a4j:ajax></classname> component uses the common attributes listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />.
</para>
+ <note>
+ <title>Note</title>
+ <para>
+ When attaching the <classname><a4j:ajax></classname> component to non-Ajax JavaServer Faces command components, such as <classname><h:commandButton></classname> and <classname><h:commandLink></classname>, it is important to set <code>disabledDefault="true"</code>. If this attribute is not set, a non-Ajax request is sent after the Ajax request and the page is refreshed unexpectedly.
+ </para>
+ </note>
</section>
<section id="sect-Component_Reference-Actions-a4jajaxListener">
<title>a4j:ajaxListener</title>
<para>
- Incomplete
+ The <classname><a4j:ajaxListener></classname> component adds an action listener to a parent component. It works similar to the JavaServer Faces <classname><f:actionListener></classname> or <classname><f:valueChangeListener></classname> components, except that the invocation of <classname><a4j:ajaxListener></classname> is not canceled if validation of the <emphasis>Update Model</emphasis> phase fails. The <classname><a4j:ajaxListener></classname> component is guaranteed to be invoked with each Ajax response.
</para>
+ <para>
+ Baasic usage requires only the <code>type</code> attribute, which defines the fully-qualified Java class name for the listener. This Java class should implement the <classname>org.ajax4jsf.event.AjaxListener</classname> interface, which is a base listener for all listeners and is capable of receiving Ajax events. The object from which the event originated could be accessed using the <methodname>java.util.EventObject.getSource()</methodname> method.
+ </para>
+ <para>
+ The <classname><a4j:ajaxListener></classname> component is not invoked for non-Ajax requests, or when the RichFaces works in the <emphasis>Ajax request generates non-Ajax response</emphasis> mode, so the <classname><a4j:ajaxListener></classname> invocation is a good indicator that an Ajax response is going to be processed.
+ </para>
</section>
<section id="sect-Component_Reference-Actions-a4jcommandButton">
@@ -130,8 +206,29 @@
<section id="sect-Component_Reference-Actions-a4jjsFunction">
<title>a4j:jsFunction</title>
<para>
- Incomplete
+ The <classname><a4j:jsFunction></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.
</para>
+ <para>
+ The <classname><a4j:jsFunction></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.
+ </para>
+ <example>
+ <title><a4j:jsFunction> example</title>
+<programlisting language="xml">
+<h:form>
+ ...
+ <a4j:jsFunction name="callScript" data="#{bean.someProperty1}" reRender="someComponent" oncomplete="myScript(data.subProperty1, data.subProperty2)">
+ <a4j:actionParam name="param_name" assignTo="#{bean.someProperty2}"/>
+ </a4j:jsFunction>
+ ...
+</h:form>
+</programlisting>
+ </example>
+ <para>
+ The <classname><a4j:jsFunction></classname> component allows the use of the <classname><a4j:actionParam></classname> component or the JavaServer Faces <classname><f:param></classname> component to pass any number of parameters for the JavaScript function.
+ </para>
+ <para>
+ The <classname><a4j:jsFunction></classname> component is similar to the <classname><a4j:commandButton></classname> component, but it can be activated from the JavaScript code. This allows some server-side functionality to be invoked and the returned data to subsequently be used in a JavaScript function invoked by the <code>oncomplete</code> event attribute. In this way, the <classname><a4j:jsFunction></classname> component can be used instead of the <classname><a4j:commandButton></classname> component.
+ </para>
</section>
<section id="sect-Component_Reference-Actions-a4jpoll">
Modified: root/docs/trunk/Component_Reference/en-US/Book_Info.xml
===================================================================
--- root/docs/trunk/Component_Reference/en-US/Book_Info.xml 2009-11-16 00:00:24 UTC (rev 15883)
+++ root/docs/trunk/Component_Reference/en-US/Book_Info.xml 2009-11-16 05:49:10 UTC (rev 15884)
@@ -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-16 00:00:24 UTC (rev 15883)
+++ root/docs/trunk/Component_Reference/en-US/Component_Reference.xml 2009-11-16 05:49:10 UTC (rev 15884)
@@ -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/Menus_and_toolbars.xml
===================================================================
--- root/docs/trunk/Component_Reference/en-US/Menus_and_toolbars.xml 2009-11-16 00:00:24 UTC (rev 15883)
+++ root/docs/trunk/Component_Reference/en-US/Menus_and_toolbars.xml 2009-11-16 05:49:10 UTC (rev 15884)
@@ -90,7 +90,7 @@
<title>Standard icons</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/panelMenuIcons.png" format="PNG" />
+ <imagedata fileref="images/figu-Component_Reference-richpanelMenuGroup-Standard_icons.png" format="PNG" />
</imageobject>
</mediaobject>
</figure>
@@ -125,7 +125,7 @@
<title>Standard icons</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/panelMenuIcons.png" format="PNG" />
+ <imagedata fileref="images/figu-Component_Reference-richpanelMenuItem-Standard_icons.png" format="PNG" />
</imageobject>
</mediaobject>
</figure>
Modified: root/docs/trunk/Component_Reference/en-US/Preface.xml
===================================================================
--- root/docs/trunk/Component_Reference/en-US/Preface.xml 2009-11-16 00:00:24 UTC (rev 15883)
+++ root/docs/trunk/Component_Reference/en-US/Preface.xml 2009-11-16 05:49:10 UTC (rev 15884)
@@ -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-16 00:00:24 UTC (rev 15883)
+++ root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml 2009-11-16 05:49:10 UTC (rev 15884)
@@ -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/licenses/fdl.txt</ulink>).
@@ -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>
More information about the richfaces-svn-commits
mailing list