[richfaces-svn-commits] JBoss Rich Faces SVN: r2100 - trunk/samples/richfaces-demo/src/main/webapp/richfaces/ajaxAttributes.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Tue Aug 7 09:59:14 EDT 2007
Author: smukhina
Date: 2007-08-07 09:59:14 -0400 (Tue, 07 Aug 2007)
New Revision: 2100
Modified:
trunk/samples/richfaces-demo/src/main/webapp/richfaces/ajaxAttributes/usage.xhtml
Log:
http://jira.jboss.com/jira/browse/RF-524
Language correction in richfaces-demo for aj4 components
Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/ajaxAttributes/usage.xhtml
===================================================================
--- trunk/samples/richfaces-demo/src/main/webapp/richfaces/ajaxAttributes/usage.xhtml 2007-08-07 13:40:39 UTC (rev 2099)
+++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/ajaxAttributes/usage.xhtml 2007-08-07 13:59:14 UTC (rev 2100)
@@ -8,22 +8,22 @@
<ui:composition template="/templates/component-sample.xhtml">
<ui:define name="sample">
- <p>This section overview the attributes that are common for the Ajax components
+ <p>This section overviews the attributes that are common for Ajax components
such as a4j:support, a4j:commandButton, a4j:jsFunction, a4j:poll, a4j:push and so
- on. Also, most RichFaces components with built-in Ajax support have those
- attribute for the similar purpose.
+ on. Also, most RichFaces components with built-in Ajax support have these
+ attributes for a similar purpose.
</p>
<p>
- Attributes of Ajax component is a way how RichFaces exposes its features.
- Most of the attributes have an default value. So, you can start working with RichFaces
- without knowing the usage of those attribute. However, using them allows to
- tune the required Ajax behavoir very smoothly.
+ Ajax components attributes help RichFaces to expose its features.
+ Most of the attributes have default values. Thus, you can start working with RichFaces
+ without knowing the usage of these attribute. However, their usage allows to
+ tune the required Ajax behavior very smoothly.
</p>
<h1 class="hsample">Re-Rendering</h1>
<p>
- <b>reRender</b> is a key attribute. It allows to point to the area(s) on the page that
+ <b>reRender</b> is a key attribute. It allows to point to the area(s) on a page that
should be updated as a response on Ajax interaction. The value of the reRender
- attribute is an id of the the JSF component or the id list. This is a simple example:
+ attribute is an id of the JSF component or an id list. This is a simple example:
</p>
<div class="esample">
@@ -40,10 +40,10 @@
<p>
reRender uses <a target="_blank" href="http://java.sun.com/javaee/javaserverfaces/1.2_MR1/docs/api/javax/faces/component/UIComponent.html#findComponent(java.lang.String)">
UIComponent.findComponent()</a> algorithm (with some additional exceptions)
- to find the component in the component tree. As you see, the algorithm presume
- several steps. Each other step is used if the previous step is not succeseful.
- Therefore, from your side, you can shortcut the way how fast the component is
- found if you mentioned it more precisely. The following example show the difference
+ to find the component in the component tree. As you see, the algorithm presumes
+ several steps. Each other step is used if the previous step is not successful.
+ Therefore, you can define how fast the component is
+ found mentioning it more precisely. The following example shows the difference
in approaches (both buttons will work successfully):
</p>
<div class="esample">
@@ -69,25 +69,25 @@
</div>
<p>
- You can use JSF EL expression as a value of the reRender attribute. It might be property of
+ You can use JSF EL expression as a value of the reRender attribute. It might be a property of
types Set, Collection, Array or simple String. The EL for reRender is resolved right before the
- Render Response phase. So, you can calculate what should be re-rendered on any previous
+ Render Response phase. Hence, you can calculate what should be re-rendered on any previous
phase during the Ajax request processing.
</p>
<p>Most common problem with using reRender is pointing it to the component that has a
'rendered' attribute. Note, that JSF does not mark the place in the browser DOM where the outcome
of the component should be placed in case the 'rendered' condition returns false. Therefore,
- after the component becomes rendered during the Ajax request, RichFaces deliveres the rendered
- code to the client, but does not update the page, because the place for update is inknown.
- You need to point to one of the parent component that has no 'rendered' attribute. As an
+ after the component becomes rendered during the Ajax request, RichFaces delivers the rendered
+ code to the client, but does not update a page, because the place for update is unknown.
+ You need to point to one of the parent components that has no 'rendered' attribute. As an
alternative, you can wrap the component with a4j:outputPanel layout="none".
</p>
<p>
- <b>ajaxRendered</b> attribute of the a4j:outputPanel set to true allows to define the
- area of the page that will be re-rendered even it is not pointed in the reRender attribute
- explicitly. It might be useful if you have a zone on the page that should be updated as a
- response on any Ajax request. For example, the following code allows to output the error
- messages independently what Ajax request causes the Validation phase failed.
+ <b>ajaxRendered</b> attribute of the a4j:outputPanel set to true allows to define the
+ area of the page that will be re-rendered even if it is not pointed in the reRender attribute
+ explicitly. It might be useful if you have an area on a page that should be updated as a
+ response on any Ajax request. For example, the following code allows to output error
+ messages regardless of what Ajax request causes the Validation phase failed.
</p>
<div class="esample">
<pre>
@@ -97,27 +97,27 @@
</pre>
</div>
<p>
- <b>limitToList</b> attribute allows to dismiss the behaviour of the a4j:outputPanel's ajaxRendered
+ <b>limitToList</b> attribute allows to dismiss the behavior of the a4j:outputPanel ajaxRendered
attribute. limitToList = "false" means to update only the area(s) that mentioned in the
reRender attribute explicitly. All output panels with ajaxRendered="true" will be ignored.
</p>
<h1 class="hsample">Queue and Traffic Flood Protection</h1>
<p>
- <b>eventsQueue</b> attribute defines the name of the queue that will be used to order upcomming Ajax
+ <b>eventsQueue</b> attribute defines the name of the queue that will be used to order upcoming Ajax
requests. By default, RichFaces does not queue Ajax requests. If events are produced
- simultaneously, they will come to the server simultaniously. JSF implementations
- (especially, the very first ones) doe not guaranty that the request comes first will be
- served or pass the JSF lifecycle first. The order how the server side data
- will be modified in case of simultanious request might be unpredictable.
- Using eventsQueue attribute allows to avoid possible mess. Define the queue name explicitly,
- if you expect an intensive Ajax traffic in your application.
+ simultaneously, they will come to the server simultaneously. JSF implementations
+ (especially, the very first ones) does not guaranty that the request that comes first will be
+ served or passed into the JSF lifecycle first. The order how the server side data
+ will be modified in case of simultaneous request might be unpredictable.
+ Usage of eventsQueue attribute allows to avoid possible mess. Define the queue name explicitly,
+ if you expect intensive Ajax traffic in your application.
</p>
<p>
The next request posted in the same queue will wait until the previos one is not
- processed and Ajax response returns back if the eventsQueue attribute is defined. In
- addition, Richfaces starts to remove from the queue the 'similar' requests. 'Similar' are
- the requests that produced by the same event. For example, you have the following code,
- only the newest request will be sent to the server if user types very fast and typed
+ processed and Ajax response is returned back if the eventsQueue attribute is defined. In
+ addition, Richfaces starts to remove from the queue 'similar' requests. 'Similar' requests are
+ the requests produced by the same event. For example, according to the following code,
+ only the newest request will be sent to the server if a user types very fast and has typed
the several characters already before the previous Ajax response is back.
</p>
<div class="esample">
@@ -128,62 +128,62 @@
</pre>
</div>
<p><b>requestDelay</b> attribute defines the time (in ms.) that request will be wait in
- the queue before it is ready to be sent. When the delay time is over, the request will be
- sent to the server or removed if the newest 'similar' request is in queue already .
+ the queue before it is ready to send. When the delay time is over, the request will be
+ sent to the server or removed if the newest 'similar' request is in a queue already .
</p>
<p><b>ignoreDupResponses</b> attributes orders to ignore the Ajax response produced by the
- request if the newest 'similar' request is in the queue already. ignoreDupResponses="true"
+ request if the newest 'similar' request is in a queue already. ignoreDupResponses="true"
does not cancel the request while it is processed on the server, but just allows to
- avoid unnssesary updates on the client side if the response loses the actuality.
+ avoid unnecessary updates on the client side if the response loses the actuality.
</p>
- <p>Defining the eventsQueue along with requestDelay allows to protect against unnssesary
- traffic flood and syncronizes the order of Ajax requests. If you have several source of
+ <p>Defining the eventsQueue along with requestDelay allows to protect against unnecessary
+ traffic flood and synchronizes Ajax requests order. If you have several sources of
Ajax requests, you can define the same queue name there. This might be very helpful if
you have Ajax components that invoke request asynchronously from the ones produced by
events from users. For example a4j:poll or a4j:push. In case the requests from such
- components modify the same data, the syncronization might be very helpful.</p>
+ components modify the same data, the synchronization might be very helpful.</p>
<h1 class="hsample">Data Processing Options</h1>
- <p>RichFaces uses form based appoach for sending Ajax request. This means each time, when
- user click an Ajax button or a4j:poll produces asynchronous request, the data from the closest
- JSF form is submitted behalf of XMLHTTPRequest object. The form data contains the values
+ <p>RichFaces uses form based approach for Ajax request sending. This means each time, when a
+ user click an Ajax button or a4j:poll produces an asynchronous request, the data from the closest
+ JSF form is submitted with the XMLHTTPRequest object. The form data contains the values
from the form input element and auxiliary information such as state saving data</p>
<p>
- <b>ajaxSingle</b> attribute when it equals true directs to include only the value of
+ When <b>ajaxSingle</b> attribute is equal true, it orders to include only a value of the
current component (along with f:param or a4j:action param values if any) to the request
- map. In case of a4j:support, it will be the value of the parent component.
+ map. In case of a4j:support, it will be a value of the parent component.
</p>
- <p> Note, that ajaxSingle="true" reduces the upcomming traffic, but does not
- prevent decoding other input components on the server side. Some JSF component,
- such as h:selectOneMenu do recognize the missing in the request map value as
- a null value and try to pass the validation process with failed result. So,
- use a4j:region to limit the part of the component tree that will be processed
- on the server side when it needs.
+ <p> Note, that ajaxSingle="true" reduces the upcoming traffic, but does not
+ prevent decoding other input components on the server side. Some JSF components,
+ such as h:selectOneMenu do recognize the missing data in the request map value as
+ a null value and try to pass the validation process with a failed result. Thus,
+ use a4j:region to limit a part of the component tree that will be processed
+ on the server side when it is required.
</p>
- <p><b>immediate</b> attribute has the same purpose as for any other non-JSF component.
- The default ActionListener should be executed immediately (i.e. during Apply Request
- Values phase of the request processing lifecycle), rather than waiting until the
- Invoke Application phase. Using immediate="true" is one of the way how to have the one
- data model values updated when the other cannot be updated because of problem with
+ <p><b>immediate</b> attribute has the same purpose as any other non-JSF component.
+ The default ActionListener should be executed immediately (i.e. during the Apply Request
+ Values phase of a request processing lifecycle), rather than waiting until the
+ Invoke Application phase. Using immediate="true" is one of the ways to have some
+ data model values updated when other cannot be updated because of a problem with
passing the Validation phase successfully. This might be important inside the
h:dataTable like components where using a4j:region is impossible due to the
h:dataTable component architecture.
</p>
<p><b>bypassUpdates</b> attribute allows to bypass the Update Model phase. It
- might be useful if you need to check the user input against the available validator,
- but not to update the model with those data. Note, that the a action will be invoked
+ might be useful if you need to check user input against the available validator,
+ but not to update the model with those data. Note, that an action will be invoked
at the end of the Validation phase only if the Validation phase is passed successfully.
The listeners of the Application phase will not be invoked in any case.
</p>
<h1 class="hsample">Action and Navigation</h1>
<p>Ajax component is similar to any other non-Ajax JSF component like h:commandButton. It
- allows to submit the form. You can use action and actionListener attribute to invoke
+ allows to submit the form. You can use action and actionListener attribute to invoke
the action method and define the action event.
</p>
<p>
- <b>action</b> method must return null if you want to have an Ajax response with partual page
- update. This is regular mode that names: "Ajax Request generates Ajax Response". In case of
- action does not return null, but the action outcome that match one of the navigation rule, RichFaces
+ <b>action</b> method must return null if you want to have an Ajax response with a partual page
+ update. This is regular mode called "Ajax Request generates Ajax Response". In case of
+ action does not return null, but the action outcome that matches one of navigation rules, RichFaces
starts to work in "Ajax Request generates Non-Ajax Response" mode.
This mode might be helpful in two major cases:
</p>
@@ -197,26 +197,26 @@
page update will be performed.
</li>
<li>If you want to involve the server side validators and navigate to the next page only if
- the Validation phase is passed succesefully, you can replace h:commandButton with a4j:commandButton
- and point to the action method that navigate to the next page. In case of Validation process failed,
- the partial page update will occure and user will see the error message. Otherwize, the application
- proceeds to the next page. Be sure, you define <redirect /%gt; option for the navigation rule to
- avoid the memory leaks.
+ the Validation phase is passed successfully, you can replace h:commandButton with a4j:commandButton
+ and point to the action method that navigates to the next page. If Validation process fails,
+ the partial page update will occur and a user will see an error message. Otherwize, the application
+ proceeds to the next page. Make sure, you define <redirect /%gt; option for the navigation rule to
+ avoid memory leaks.
</li>
</ol>
<h1 class="hsample">Javascript Interactions</h1>
<p>
- RichFaces allows to write Ajax-enabled JSF application without using Javascript hard.
+ RichFaces allows writing Ajax-enabled JSF application without writing any Javascript code.
However, you can still invoke the javascript code if you need. There are several ajax
attributes that helps to do it.
</p>
<p>
- <b>onsubmit</b> attribute allows to invoke javascript code before the Ajax request is
+ <b>onsubmit</b> attribute allows to invoke javascript code before an Ajax request is
sent. If 'onsubmit' returns false, the Ajax request is canceled. The code of 'onsubmit'
- is inserter before the RichFaces Ajax call. So, the 'onsubmit' should not has a 'return'
- statment is you want the Ajax request to be send. if you are going to invoke a javscript
- function that return true or false, use the conditional statment to return something only
- in you need to cancel the request. For example, onsubmit="if (mynosendfunct()==false){return false}".
+ is inserted before the RichFaces Ajax call. Hence, the 'onsubmit' should not has a 'return'
+ statement if you want the Ajax request to be sent. If you are going to invoke a javscript
+ function that returns true or false, use the conditional statement to return something only
+ when you need to cancel the request. For example, onsubmit="if (mynosendfunct()==false){return false}".
</p>
<p>
<b>onclick</b> attribute is similar to the 'onsubmit', but for clickable components such
@@ -225,14 +225,14 @@
<p>
<b>oncomplete</b> attribute allows to invoke the javascript code right after the
Ajax response is returned back and the DOM tree of the browser is updated. Richfaces
- register the code for further invocation to XMLHTTP request object before the Ajax
- request is send. This means the code will not be changed during processing
+ registers the code for further invocation of XMLHTTP request object before an Ajax
+ request is sent. This means the code will not be changed during processing of
the request on the server if you use JSF EL value binding. Also, you cannot use
'this' inside the code, because it will not point the component where Ajax request
was initiated.
</p>
<p>
- <b>data</b> attribute allows to get the additional data from the server during the
+ <b>data</b> attribute allows to get the additional data from the server during an
Ajax call. You can use JSF EL to point the property of the managed bean and its value
will be serialized in JSON format and be available on the client side. You can refer
to it using the 'data' variable. For example:
@@ -243,8 +243,8 @@
</pre>
</div>
<p>
- Richfaces allows to serialize into JSON format not only primitive types, but complex
- type including arrays and collections. The beans should be serializable to be refered
+ Richfaces allows to serialize not only primitive types into JSON format, but also complex
+ types including arrays and collections. The beans should be serializable to be refered
with 'data'.
</p>
More information about the richfaces-svn-commits
mailing list