[richfaces-svn-commits] JBoss Rich Faces SVN: r2241 - in trunk/samples/richfaces-demo/src/main/webapp/richfaces: ajaxListener and 5 other directories.

Author: smukhina Date: 2007-08-14 06:57:02 -0400 (Tue, 14 Aug 2007) New Revision: 2241 Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/ajaxAttributes/usage.xhtml trunk/samples/richfaces-demo/src/main/webapp/richfaces/ajaxListener/usage.xhtml trunk/samples/richfaces-demo/src/main/webapp/richfaces/commandButton/usage.xhtml trunk/samples/richfaces-demo/src/main/webapp/richfaces/commandLink/usage.xhtml trunk/samples/richfaces-demo/src/main/webapp/richfaces/jsFunction/usage.xhtml trunk/samples/richfaces-demo/src/main/webapp/richfaces/poll/usage.xhtml trunk/samples/richfaces-demo/src/main/webapp/richfaces/support/usage.xhtml Log: http://jira.jboss.com/jira/browse/RF-524 Language correction in richfaces-demo for aj4 component 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-14 10:30:24 UTC (rev 2240) +++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/ajaxAttributes/usage.xhtml 2007-08-14 10:57:02 UTC (rev 2241) @@ -114,11 +114,11 @@ </p> <p> The next request posted in the same queue will wait until the previos one is not - processed and Ajax response is returned back if the eventsQueue attribute is defined. In + 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. + the several characters already before the previous Ajax Response is back. </p> <div class="esample"> <pre> @@ -131,7 +131,7 @@ 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 + <p><b>ignoreDupResponses</b> attributes orders to ignore the Ajax Response produced by the 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 unnecessary updates on the client side if the response loses the actuality. @@ -181,10 +181,10 @@ 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 a partual page - update. This is regular mode called "Ajax Request generates Ajax Response". In case of + <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. + starts to work in "Ajax request generates Non-Ajax Response" mode. This mode might be helpful in two major cases: </p> <ol> @@ -224,7 +224,7 @@ </p> <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 + Ajax Response is returned back and the DOM tree of the browser is updated. Richfaces 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 Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/ajaxListener/usage.xhtml =================================================================== --- trunk/samples/richfaces-demo/src/main/webapp/richfaces/ajaxListener/usage.xhtml 2007-08-14 10:30:24 UTC (rev 2240) +++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/ajaxListener/usage.xhtml 2007-08-14 10:57:02 UTC (rev 2241) @@ -12,13 +12,13 @@ Ajax Listener (a4j:ajaxListener). Ajax Listener is invoked before the Render Response phase. Instead of Action Listener of Value Change Listener which are not invoked when Validation of Update Model phases failed, Ajax Listener is guarantied to be invoked - for each Ajax response. Hence, it is a good place to update the list of re-rendered + for each Ajax Response. Hence, it is a good place to update the list of re-rendered components, for example. </p> <p> Ajax Listener is not invoked for a non-Ajax request and when RichFaces works in - "Ajax Request generates Non-Ajax Response" mode. Therefore, Ajax Listener invocation - is a good indicator that Ajax response is going to be processed. + "Ajax request generates Non-Ajax Response" mode. Therefore, Ajax Listener invocation + is a good indicator that Ajax Response is going to be processed. </p> <p> Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/commandButton/usage.xhtml =================================================================== --- trunk/samples/richfaces-demo/src/main/webapp/richfaces/commandButton/usage.xhtml 2007-08-14 10:30:24 UTC (rev 2240) +++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/commandButton/usage.xhtml 2007-08-14 10:57:02 UTC (rev 2241) @@ -10,9 +10,9 @@ <p> a4j:commandButton is similar to the standard h:commandButton, but produces an - Ajax request with further partial page update. 'reRender' attribute point to the + Ajax request with a further partial page update. 'reRender' attribute points to the component(s) that should be re-rendered in the component tree and updated - in the browser DOM after the ajax response is complete. + in the browser DOM after an Ajax Response is completed. </p> <p> Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/commandLink/usage.xhtml =================================================================== --- trunk/samples/richfaces-demo/src/main/webapp/richfaces/commandLink/usage.xhtml 2007-08-14 10:30:24 UTC (rev 2240) +++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/commandLink/usage.xhtml 2007-08-14 10:57:02 UTC (rev 2241) @@ -12,7 +12,7 @@ a4j:commandLink is similar to the standard h:commandLink, but produces an Ajax request with further partial page update. 'reRender' attribute point to the component(s) that should be re-rendered in the component tree and updated - in the browser DOM after the ajax response is complete. + in the browser DOM after the Ajax Response is complete. </p> <p> @@ -28,7 +28,7 @@ </ui:include> </div> <p> - For additional information about attributes of this compponent read + For additional information about attributes of this component read <h:outputLink value="#{facesContext.externalContext.requestContextPath}/richfaces/ajaxAttributes.jsf?c=ajaxattributes"> <h:outputText value="'Ajax Attribute' section" /> </h:outputLink>. Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/jsFunction/usage.xhtml =================================================================== --- trunk/samples/richfaces-demo/src/main/webapp/richfaces/jsFunction/usage.xhtml 2007-08-14 10:30:24 UTC (rev 2240) +++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/jsFunction/usage.xhtml 2007-08-14 10:57:02 UTC (rev 2241) @@ -8,10 +8,10 @@ <ui:composition template="/templates/component-sample.xhtml"> <ui:define name="sample"> - <p>a4j:jsFunction component is very similar to a4j:commandButton, but allows to peform - Ajax request from Javascript code directly. The component sends a request using - a standard JSF approach, so, the JSF form is required. The folowing example - shows how the part of the page is re-rendered when user hover over the names. + <p>a4j:jsFunction component is very similar to a4j:commandButton, but allows to perform + an Ajax request from a Javascript code directly. The component sends a request using + a standard JSF approach, so the JSF form is required. The following example + shows how the part of the page is re-rendered when a user hovers over the names. </p> @@ -27,7 +27,7 @@ <b>name</b> attribute defines the name of the function that will be generated. You can use it as a regular Javascript function name to invoke. a4j:actionparam is used to pass the function arguments (you can use f:param as well). The order and - the number of parameters correspond to the arguments of the called function. The + the number of parameters corresponds to the arguments of the called function. The value(s) of the a4j:actionparam will be replaced with the value of function arguments before the Ajax request is sent. To read more about a4j:action param visit <h:outputLink value="#{facesContext.externalContext.requestContextPath}/richfaces/actionparam.jsf?c=actionparam"> @@ -36,8 +36,8 @@ </p> <p> As for any other Ajax components, you can use <b>reRender</b> attribute to update the area(s) of the page - after Ajax response returns back. Also, you can use <b>data</b> attribute and <b>oncomplete</b> attribute to - take the data from the server and use them for Javascript call them. For additional information about + after an Ajax Response comes back. Also, you can use <b>data</b> attribute and <b>oncomplete</b> attribute to + take the data from the server and use them for Javascript to call them. For additional information about Javascript oriented and other important attributes of a4j:jsFunction read <h:outputLink value="#{facesContext.externalContext.requestContextPath}/richfaces/ajaxAttributes.jsf?c=ajaxattributes"> <h:outputText value="'Ajax Attribute' section" /> Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/poll/usage.xhtml =================================================================== --- trunk/samples/richfaces-demo/src/main/webapp/richfaces/poll/usage.xhtml 2007-08-14 10:30:24 UTC (rev 2240) +++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/poll/usage.xhtml 2007-08-14 10:57:02 UTC (rev 2241) @@ -9,11 +9,11 @@ <ui:define name="sample"> - <p>a4j:poll is one of the way how you can orginize the periodical polling of server data and - updating the page. a4j:poll is a standard RichFaces Ajax component. So, you can use the same + <p>a4j:poll is one of the way how you can organize the periodical polling of server data and + updating the page. a4j:poll is a standard RichFaces Ajax component. Thus, you can use the same approach as for a4j:commandButton for example. I.e. you can use action attribute to invoke the - actiom method and reRender attribute to update area(s) on the client when Ajax response returns - back. RichFaces use the standard form based request, so having the form around the + action method and reRender attribute to update area(s) on the client when Ajax Response returns + back. RichFaces uses the standard form based request, so the form around the a4j:poll component is required. </p> @@ -30,13 +30,13 @@ <p><b>interval</b> attribute defines the interval in ms between the previous response and the - next request. So, the total period between two request generated by a4j:poll is a sum of interval + next request. Hence, the total period between two requests generated by a4j:poll is a sum of interval and server response time. </p> <p> - <b>timeout</b> attribute defines the time in ms how long the client will wait for server response. - if Ajax response does not come during this period, the connection is aborted and the next + <b>timeout</b> attribute defines the time in ms for how long the the client will wait for the server response. + if Ajax Response does not come during this period, the connection is aborted and the next request is sent. By default, the timeout is not set. </p> @@ -45,12 +45,11 @@ to point to the bean property that will be the flag. Re-render the a4j:poll component itself to apply the current value. See the example how to accomplish this task. </p> - <p> a4j:poll sends requests in parallel with user activities. The intersections between a4j:poll Ajax requests and other Ajax requests are possible. This might causes unpredictable glitches. Especially, it is true for the earlier version of JSF implementations - when the parallel requests to the server was not expected. To avoid problem, try to follow + when the parallel requests to the server was not expected. To avoid the problem, try to follow very simple rules: </p> <ul> @@ -74,11 +73,11 @@ </li> <li>Use the eventsQueue with the same name as the name for other Ajax components. This allows to queue the Ajax request and avoid updating the server side data - and re-rendering the page area(s) in parallet; + and re-rendering the page area(s) in parallel; </li> <li>Set the reasonable interval. Note that each Ajax request restores the session - and component tree as well as processes the whole JSF lifecycle. Too often requests - just degrade the overall performance of application + and a component tree as well as processes the whole JSF lifecycle. Too often requests + just degrade the overall performance of an application </li> </ul> Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/support/usage.xhtml =================================================================== --- trunk/samples/richfaces-demo/src/main/webapp/richfaces/support/usage.xhtml 2007-08-14 10:30:24 UTC (rev 2240) +++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/support/usage.xhtml 2007-08-14 10:57:02 UTC (rev 2241) @@ -9,7 +9,7 @@ <ui:define name="sample"> <p> - a4j:support is a most important core component in the RichFaces library. It allows + a4j:support is the most important core component in the RichFaces library. It allows to add an Ajax capability to the existing non-ajax components. All other Ajax components are based on the same principles a4j:support has. </p> @@ -17,11 +17,11 @@ The key attributes are 'event' and 'reRender'. </p> <p> - <b>event</b> attribute defines the javascript event the ajax support will be attached at. + <b>event</b> attribute defines the javascript event the ajax support will be attached to. </p> <p> 'reRender' attribute points to the JSF component(s) that should be re-rendered on the server side - and updated on the client when ajax response comes back. + and updated on the client when an Ajax Response comes back. </p> <p> The following example shows how the outputText component value is changed while a user is @@ -51,8 +51,8 @@ <p> In case of attaching a4j:support to non-Ajax JSF command component, such as h:commandButton - or h:commandLink, it is important to set disableDefault equals true. Otherwise, non-ajax - request will be send just after ajax request and the page will be unexpectedly refreshed. + or h:commandLink, it is important to set disableDefault equals true. Otherwise, a non-ajax + request will be send just after an Ajax request and the page will be unexpectedly refreshed. </p> <p>