From richfaces-svn-commits at lists.jboss.org Tue Nov 22 14:29:00 2011 Content-Type: multipart/mixed; boundary="===============7486056979924193430==" MIME-Version: 1.0 From: richfaces-svn-commits at lists.jboss.org To: richfaces-svn-commits at lists.jboss.org Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r22974 - modules/docs/trunk/Component_Reference/src/main/docbook/en-US. Date: Tue, 22 Nov 2011 14:28:59 -0500 Message-ID: <201111221928.pAMJSxE0010286@svn01.web.mwc.hst.phx2.redhat.com> --===============7486056979924193430== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: bleathem Date: 2011-11-22 14:28:59 -0500 (Tue, 22 Nov 2011) New Revision: 22974 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Actions.xml Log: Grammar cleanup of the push component documentation Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-Component_Reference-Actions.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Actions.xml 2011-11-22 15:00:50 UTC (rev 22973) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Actions.xml 2011-11-22 19:28:59 UTC (rev 22974) @@ -558,7 +558,7 @@ - JMS - RichFaces Push consumes= messages from enterprise messaging system and exposes them to client (tigh= tly couples with JMS runtime) = + JMS - RichFaces Push consumes= messages from enterprise messaging system and exposes them to client (tigh= tly coupled with JMS runtime) @@ -568,12 +568,12 @@ - Push CDI - uses CDI Events me= chanism to access TopicsContext + Push CDI - uses the CDI Event= mechanism to access TopicsContext - On the client side, push notification may be processed by = following ways: = + On the client side, push notifications may be processed in= the following ways: @@ -583,7 +583,7 @@ - Attaching behavior to dataavailable e= vent - any behavior may be attached (<a4j:ajax>, <= sgmltag><rich:componentControl>, etc.) = + Attaching a behavior to the dataavailable event - any behavior may be attached (<a4j:ajax>, <rich:componentControl>, etc.) @@ -592,42 +592,42 @@
Push Topics - No matter which type way of producing messages is chosen, = message is delivered to the client based on the topic name (with optional s= ubtopic). = + No matter which method of producing messages is chosen, th= e message is delivered to the client based on the topic name (with optional= subtopic). Examples of topic names might be someTopic or= subtopic(a)anotherTopic. - Push topic name format is very close to JMS topic names an= d thus enables seamless transport of JMS messages to RichFaces message queu= e. + The format for the name of the push topic is very close to= that of the JMS topic name and thus enables seamless transport of JMS mess= ages to the RichFaces message queue.
=
Handling a push notification - A push notification from server sent to the <a= 4j:push> component on client will cause it to trigger any even= t handlers defined using the dataavailable event handler= . = + A push notification sent from the server to the &= lt;a4j:push> component on the client will cause it to trigger = any event handlers defined using the dataavailable event= handler. - The <a4j:push> component should a= lso include the error event handler to inform the user w= hen an error has occurred with the push notifications. + The <a4j:push> component should a= lso include the onerror event handler to inform the user= when an error has occurred with the push notifications. - Topic name may be determined dynamically in runtime, using= Expression Language expressions. + The topic name may be determined dynamically at runtime, u= sing Expression Language expressions. Handling a push notification - The example uses the dataavailable = event attribute with JavaScript to update messages in a chat room. The event.rf.data parameter contains JMS message data serial= ized to JavaScript. + This example uses the dataavailable= event attribute with some JavaScript to update messages in a chat room. Th= e event.rf.data parameter contains JMS message data = serialized to JavaScript. - <a4j:push> can be used for both, = immediate processing of message (like in example above) or it can trigger p= artial page update. + <a4j:push> can be used for either= immediate processing of messages (like in the previous example) or it can = trigger partial page update (see the following example). Updating DOM for each push notification - The example uses the dataavailable = event handler to trigger AJAX request and partial page update. + This example uses the dataavailable= event handler to trigger an AJAX request and partial page update.
@@ -714,7 +714,7 @@ - The example demonstrates a simple use of the <a4j:push>= ; causing immediate update of page content. + This example demonstrates a simple use of the <a4j:push&g= t; causing immediate update of page content. @@ -722,30 +722,30 @@
Using Push without JMS - Since JMS coupling may be unwanted in certain cases, RichF= aces provides switch which turns off JMS integration: = + Since JMS coupling may be unwanted in certain cases, RichF= aces provides a switch to turn off the JMS integration: - This switch is important in situations when you want to us= e alternative situations of sending push notifications: Push CDI<= /emphasis> or TopicsContext programmatic interface. + This switch is necessary when you want to make use of the = alternative methods for sending push notifications: Push CDI or the TopicsContext programmatic interface.
=
Using TopicsContext to publish message - Alternative way of producing messages is using Topi= csContext interface directly as in following sample: + Alternative way of producing messages is using the = TopicsContext interface directly as in the following sample: - Sending message using TopicsContext involves = creating TopicKey instance (denominator of given message topic= ) and looking up for TopicsContext used for topic registration= and message publishing. + Sending a message using the TopicsContext inv= olves creating a TopicKey instance (denominator of given messa= ge topic) and looking up the TopicsContext used for topic regi= stration and message publishing. - Limitations for using <code>TopicsContext</code> in= terface + Limitations for using the <code>TopicsContext</code= > interface - For using TopicsContext is it necessary h= aving FacesContext instance available in current thread. + Using the TopicsContext requires the FacesContext instance to be available in the current thread. - The method TopicsContext.lookup() can be = called only in context of web application class loader (ServiceTracke= r needs to be accessible for given application). + The method TopicsContext.lookup() can be = called only in the context of a web application class loader (Service= Tracker needs to be accessible for given application).
@@ -753,20 +753,20 @@
Integrating Push with CDI events - Second alternative way of producing messages is using CDI = Events mechanism. + A second alternative way of producing messages is to use t= he CDI Event mechanism. - Push notifications can be produced by annotating CDI event= with @Push annotation, which specifies end-point (topic name). + Push notifications can be produced by annotating a CDI eve= nt injection point with the @Push annotation, which specifies = an end-point (topic name). - Payload of the message is the serialized object sent using= CDI event interface (Event.fire(T object)). + The payload of the message is the serialized object sent u= sing the CDI event interface (Event.fire(T object)). - For using CDI events for producing push notifications, sam= e limitations applies as for using = TopicsContext interface. + When using CDI events for producing push notifications, th= e same limitations apply as for using the= TopicsContext interface. - Associations for CDI events and their handlers are constru= cted in application deployment. Therefore topics can't be dynamically assoc= iated using Event.select(Annotation...) and @Push= CDI qualifier. = + Associations for CDI events and their handlers are constru= cted during application deployment. Therefore topics can't be dynamically a= ssociated using Event.select(Annotation...) and the @Pus= h CDI qualifier.
= --===============7486056979924193430==--