[richfaces-svn-commits] JBoss Rich Faces SVN: r18497 - branches/development/docs/Component_Reference/src/main/docbook/en-US.

Author: SeanRogers Date: 2010-08-09 00:18:49 -0400 (Mon, 09 Aug 2010) New Revision: 18497 Modified: branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Layout_and_appearance.xml Log: rich:jQuery started Modified: branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Layout_and_appearance.xml =================================================================== --- branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Layout_and_appearance.xml 2010-08-06 18:49:36 UTC (rev 18496) +++ branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Layout_and_appearance.xml 2010-08-09 04:18:49 UTC (rev 18497) @@ -57,8 +57,40 @@ The <sgmltag>&lt;rich:jQuery&gt;</sgmltag> component applies styles and custom behavior to both <acronym>JSF</acronym> (JavaServer Faces) objects and regular <acronym>DOM</acronym> (Document Object Model) objects. It uses the <phrase>jQuery</phrase> JavaScript framework to add functionality without conflicting with the <filename>prototype.js</filename> library. </para> <para> - + The query triggered by the <sgmltag>&lt;rich:jQuery&gt;</sgmltag> component is specified using the <varname>query</varname> attribute. Any objects or lists of objects used in the query are specified using the <varname>selector</varname> attribute. The <varname>selector</varname> attribute uses syntax defined by the <orgname>World Wide Web Consortium (<acronym>W3C</acronym>)</orgname> for the <acronym>CSS</acronym> rule selector. </para> + <para> + The query can be triggered in three different ways. Use the <varname>timing</varname> attribute to specify the point at which the query is triggered: + </para> + <variablelist> + <varlistentry> + <term><literal>immediate</literal></term> + <listitem> + <para> + The query is triggered immediately. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>onload</literal></term> + <listitem> + <para> + The query is triggered when the document is loaded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>onJScall</literal></term> + <listitem> + <para> + The query is triggered when a JavaScript function is invoked. The JavaScript function is specified using the <varname>name</varname> attribute. + </para> + <para> + If the <varname>name</varname> attribute is included when the <varname>timing</varname> attribute is set to either <literal>immediate</literal> or <literal>onload</literal>, the query can be triggered using the JavaScript function <emphasis>in addition</emphasis> to the specified trigger timing. + </para> + </listitem> + </varlistentry> + </variablelist> </section> <!-- TODO not in M2 -->