March 2011 - richfaces-svn-commits

JBoss Rich Faces SVN: r22300 - in modules/docs/trunk/Component_Reference/src/main/docbook/en-US: extras and 1 other directory.

by richfaces-svn-commits＠lists.jboss.org

Author: SeanRogers Date: 2011-03-24 02:34:34 -0400 (Thu, 24 Mar 2011) New Revision: 22300 Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jparam-Passing_client-side_parameters.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jparam-a4jparam_example.java modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jparam-a4jparam_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jpush-Basic_usage.java Removed: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.js modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.xml_sample Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Functions.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Validation.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jjsFunction-a4jjsFunction_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-1.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richgraphValidator-Basic_usage.js Log: Revised according to part 1 of engineering review: RFPL-1380 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml 2011-03-24 01:53:32 UTC (rev 22299) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml 2011-03-24 06:34:34 UTC (rev 22300) @@ -11,7 +11,9 @@ <part id="part-Component_Reference-Ajax_control_components"> <title>Ajax control components</title> <xi:include href="chap-Component_Reference-Actions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +  <xi:include href="chap-Component_Reference-Containers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Validation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Processing_management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2011-03-24 01:53:32 UTC (rev 22299) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2011-03-24 06:34:34 UTC (rev 22300) @@ -10,18 +10,30 @@ <section id="sect-Component_Reference-Actions-a4jajax"> <title><sgmltag><a4j:ajax></sgmltag></title> <para> - The <sgmltag><a4j:ajax></sgmltag> 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 <sgmltag><a4j:ajax></sgmltag> component uses the common attributes listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />. + The <sgmltag><a4j:ajax></sgmltag> behavior allows Ajax capability to be added to a non-Ajax component. The non-Ajax component must implement the <interfacename>ClientBehaviorHolder</interfacename> interface for all the event attributes that support behavior rendering. </para> - <note> - <title>Attaching JavaScript functions</title> + + <section id="sect-Component_Reference-a4jajax-Basic_usage"> + <title>Basic usage</title> <para> - When attaching the <sgmltag><a4j:ajax></sgmltag> component to non-Ajax JavaServer Faces command components, such as <sgmltag><h:commandButton></sgmltag> and <sgmltag><h:commandLink></sgmltag>, 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. + The <sgmltag><a4j:ajax></sgmltag> behavior is placed as a direct child to the component that requires Ajax support. </para> - </note> - <example id="exam-Component_Reference-a4jajax-a4jajax_example"> - <title><sgmltag><a4j:ajax></sgmltag> example</title> - <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jajax-a4jajax_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </example> + <para> + Point the <varname>event</varname> attribute to the standard JSF event that triggers the behavior. If the <varname>event</varname> attribute is not defined, the behavior is triggered on the event that normally provides interaction behavior for the parent component. + </para> +  + <example id="exam-Component_Reference-a4jajax-a4jajax_example"> + <title><sgmltag><a4j:ajax></sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jajax-a4jajax_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> <section id="sect-Component_Reference-a4jajax-Reference_data"> <title>Reference data</title> @@ -50,51 +62,53 @@ </section> </section> - <section id="sect-Component_Reference-Actions-a4jactionParam"> - <title><sgmltag><a4j:actionParam></sgmltag></title> + <section id="sect-Component_Reference-Actions-a4jparam"> + <title><sgmltag><a4j:param></sgmltag></title> <para> - The <sgmltag><a4j:actionParam></sgmltag> behavior combines the functionality of the JavaServer Faces (<acronym>JSF</acronym>) components <sgmltag><f:param></sgmltag> and <sgmltag><f:actionListener></sgmltag>. + The <sgmltag><a4j:param></sgmltag> behavior combines the functionality of the JavaServer Faces (<acronym>JSF</acronym>) components <sgmltag><f:param></sgmltag> and <sgmltag><f:actionListener></sgmltag>. </para> - <section id="sect-Component_Reference-a4jactionParam-Basic_usage"> + <section id="sect-Component_Reference-a4jparam-Basic_usage"> <title>Basic usage</title> <para> - Basic usage of the <sgmltag><a4j:actionParam></sgmltag> requires three main attributes: + Basic usage of the <sgmltag><a4j:param></sgmltag> requires three main attributes: </para> <itemizedlist> +  <listitem> <para> - <varname>value</varname>, for the initial value of the parameter; and + The <varname>value</varname> attribute is the initial value of the parameter. </para> </listitem> <listitem> <para> - <varname>assignTo</varname>, 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. + The <varname>assignTo</varname> attribute defines the bean property. The property is 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. + <xref linkend="exam-Component_Reference-a4jparam-a4jparam_example" /> shows a simple implementation along with the accompanying managed bean. </para> - <example id="exam-Component_Reference-a4jactionParam-a4jactionParam_example"> - <title><sgmltag><a4j:actionParam></sgmltag> example</title> - <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <programlisting language="Java" role="JAVA"><xi:include href="extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.js" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <example id="exam-Component_Reference-a4jparam-a4jparam_example"> + <title><sgmltag><a4j:param></sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jparam-a4jparam_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <programlisting language="Java" role="JAVA"><xi:include href="extras/exam-Component_Reference-a4jparam-a4jparam_example.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> When the <guibutton>Set name to Alex</guibutton> button is pressed, the application sets the <varname>name</varname> parameter of the bean to <literal>Alex</literal>, and displays the name in the output field. </para> </example> </section> - <section id="sect-Component_Reference-a4jactionParam-Interoperability"> + <section id="sect-Component_Reference-a4jparam-Interoperability"> <title>Interoperability</title> <para> - The <sgmltag><a4j:actionParam></sgmltag> 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. + The <sgmltag><a4j:param></sgmltag> tag can be used with non-Ajax components in addition to Ajax components. This includes components which are working through the <code>GET</code> request, such as the <sgmltag><h:link></sgmltag> and <sgmltag><h:button></sgmltag> components. In this way, data model values can also be updated without any Java code on the server side. </para> <para> The <varname>converter</varname> 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. @@ -105,22 +119,33 @@ 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> + </section> + + <section id="sect-Component_Reference-a4jparam-Passing_client-side_parameters"> + <title>Passing client-side parameters</title> <para> Variables from JavaScript functions can be used for the <varname>value</varname> attribute. In such an implementation, the <varname>noEscape</varname> attribute should be set to <literal>true</literal>. Using <code>noEscape="true"</code>, the <varname>value</varname> attribute can contain any JavaScript expression or JavaScript function invocation, and the result will be sent to the server as the <varname>value</varname> attribute. </para> + <example id="exam-Component_Reference-a4jparam-Passing_client-side_parameters"> + <title>Passing client-side parameters</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-a4jparam-Passing_client-side_parameters.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + The command button triggers the <sgmltag><a4j:param></sgmltag> behaviors and renders the output text. The <sgmltag><a4j:param></sgmltag> behaviors pass client-side parameters for the screen width and height through the backing bean. These parameters are then used to populate the output text values. + </para> + </example> </section> - <section id="sect-Component_Reference-a4jactionParam-Reference_data"> + <section id="sect-Component_Reference-a4jparam-Reference_data"> <title>Reference data</title> <itemizedlist> <listitem> <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.ActionParameter</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.parameter</classname> </para> </listitem> <listitem> <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HTMLActionParameter</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HTMLParameter</classname> </para> </listitem> </itemizedlist> @@ -164,7 +189,7 @@ <section id="sect-Component_Reference-Actions-a4jcommandButton"> <title><sgmltag><a4j:commandButton></sgmltag></title> <para> - The <sgmltag><a4j:commandButton></sgmltag> is similar to the JavaServer Faces (<acronym>JSF</acronym>) component <sgmltag><h:commandButton></sgmltag>, but additionally includes Ajax support. When the command button is clicked it submits an Ajax form, and when a response is received the command button can be dynamically rendered. + The <sgmltag><a4j:commandButton></sgmltag> component is similar to the JavaServer Faces (<acronym>JSF</acronym>) <sgmltag><h:commandButton></sgmltag> component, but additionally includes Ajax support. </para> <figure id="figu-Component_Reference-a4jcommandButton-a4jcommandButton"> <title><sgmltag><a4j:commandButton></sgmltag></title> @@ -179,18 +204,29 @@ </textobject> </mediaobject> </figure> + <note> + <title>The <sgmltag><a4j:commandButton></sgmltag> component executes the complete form</title> + <para> + Button controls are typically used to perform complete form submissions for data storing. As a consequence, the <sgmltag><a4j:commandButton></sgmltag> component has the <code>execute="@form"</code> setting by default. To limit rendering to a different scope, redefine the <varname>execute</varname> attribute. + </para> + </note> <section id="sect-Component_Reference-a4jcommandButton-Basic_usage"> <title>Basic usage</title> <para> - The <sgmltag><a4j:commandButton></sgmltag> requires only the <varname>value</varname> and <varname>render</varname> attributes to function. The <varname>value</varname> attribute specifies the text of the button and the <varname>render</varname> attribute specifies which areas are to be updated. The <sgmltag><a4j:commandButton></sgmltag> uses the <varname>click</varname> event instead of the <varname>submit</varname> event, but otherwise uses all common Ajax attributes as listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />. + The <sgmltag><a4j:commandButton></sgmltag> requires only the <varname>value</varname> attribute to function. Use the <varname>value</varname> attribute to specify the text of the button. </para> + <para> + By default, the <sgmltag><a4j:commandButton></sgmltag> uses the <varname>click</varname> event instead of the <varname>submit</varname> event. + </para> +  </section> <section id="sect-Component_Reference-a4jcommandButton-Reference_data"> @@ -224,7 +260,7 @@ <section id="sect-Component_Reference-Actions-a4jcommandLink"> <title><sgmltag><a4j:commandLink></sgmltag></title> <para> - The <sgmltag><a4j:commandLink></sgmltag> is similar to the JavaServer Faces (<acronym>JSF</acronym>) component <sgmltag><h:commandLink></sgmltag>, but additionally includes Ajax support. When the command link is clicked it generates an Ajax form submit, and when a response is received the command link can be dynamically rendered. + The <sgmltag><a4j:commandLink></sgmltag> component is similar to the JavaServer Faces (<acronym>JSF</acronym>) <sgmltag><h:commandLink></sgmltag> component, except that it includes plugged-in Ajax behavior. </para> <figure id="figu-Component_Reference-a4jcommandLink-a4jcommandLink"> <title><sgmltag><a4j:commandLink></sgmltag></title> @@ -239,12 +275,21 @@ </textobject> </mediaobject> </figure> + <note> + <title>The <sgmltag><a4j:commandLink></sgmltag> component executes the complete form</title> + <para> + Link controls are typically used to perform complete form submissions for data storing. As a consequence, the <sgmltag><a4j:commandLink></sgmltag> component has the <code>execute="@form"</code> setting by default. To limit rendering to a different scope, redefine the <varname>execute</varname> attribute. + </para> + </note> <section id="sect-Component_Reference-a4jcommandLink-Basic_usage"> <title>Basic usage</title> <para> - The <sgmltag><a4j:commandLink></sgmltag> requires only the <varname>value</varname> and <varname>render</varname> attributes to function. The <varname>value</varname> attribute specifies the text of the link and the <varname>render</varname> attribute specifies which areas are to be updated. The <sgmltag><a4j:commandLink></sgmltag> uses the <varname>click</varname> event instead of the <varname>submit</varname> event, but otherwise uses all common Ajax attributes as listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />. + The <sgmltag><a4j:commandLink></sgmltag> requires only the <varname>value</varname> attribute to function. Use the <varname>value</varname> attribute to specify the text of the link. </para> + <para> + The <sgmltag><a4j:commandLink></sgmltag> uses the <varname>click</varname> event instead of the <varname>submit</varname> event. + </para> </section> <section id="sect-Component_Reference-a4jcommandLink-Reference_data"> @@ -274,133 +319,6 @@ </section> </section> - <section id="sect-Component_Reference-Actions-richcomponentControl"> - <title><sgmltag><rich:componentControl></sgmltag></title> - <para> - The <sgmltag><rich:componentControl></sgmltag> allows JavaScript API functions to be called on components after defined events. Initialization variants and activation events can be customized, and parameters can be passed to the target component. - </para> - - <section id="sect-Component_Reference-richcomponentControl-Basic_usage"> - <title>Basic usage</title> - <para> - The <varname>event</varname>, <varname>for</varname>, and <varname>operation</varname> attributes are all that is required to attach JavaScript functions to the parent component. The <varname>event</varname> attribute specifies the event that triggers the JavaScript API function call. The <varname>for</varname> attribute defines the target component, and the <varname>operation</varname> attribute specifies the JavaScript function to perform. - </para> - <example id="exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage"> - <title><sgmltag><rich:componentControl></sgmltag> basic usage</title> - <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - The example contains a single command button, which when clicked shows the modal panel with the identifier <literal>ccModalPanelID</literal>. - </para> - </example> - </section> - - <section id="sect-Component_Reference-richcomponentControl-Attaching_to_a_component"> - <title>Attaching to a component</title> - <para> - The <varname>attachTo</varname> attribute can be used to attach the event to a component other than the parent component. If no <varname>attachTo</varname> attribute is supplied, the <sgmltag><rich:componentControl></sgmltag> component's parent is used, as in <xref linkend="exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage" />. - </para> - <example id="exam-Component_Reference-richcomponentControl-Attaching_richcomponentControl_to_a_component"> - <title>Attaching <sgmltag><rich:componentControl></sgmltag> to a component</title> - <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcomponentControl-Attaching_richcomponentControl_to_a_component.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - In the example, the <literal>click</literal> event of the component with the identifier <literal>ccCalendarID</literal> will trigger the <literal>Expand</literal> operation for the component with the identifier <literal>doExpandCalendarID</literal>. - </para> - </example> - </section> - - <section id="sect-Component_Reference-richcomponentControl-Parameters_and_JavaScript"> - <title>Parameters and JavaScript</title> - <para> - The operation can receive parameters either through the <varname>params</varname> attribute, or by using <sgmltag><f:param></sgmltag> elements. - </para> - <example id="exam-Component_Reference-richcomponentControl-Using_parameters"> - <title>Using parameters</title> - <variablelist> - <varlistentry> - <term>The <varname>params</varname> attribute</term> - <listitem> - <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcomponentControl-Using_parameters-0.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </listitem> - </varlistentry> - <varlistentry> - <term><sgmltag><f:param></sgmltag> elements</term> - <listitem> - <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcomponentControl-Using_parameters-1.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </listitem> - </varlistentry> - </variablelist> - </example> - <para> - The <varname>name</varname> attribute can be used to define a normal JavaScript function that triggers the specified operation on the target component. - </para> - </section> - - - <section id="sect-Component_Reference-richcomponentControl-Timing"> - <title>Timing</title> - <para> - The <varname>attachTiming</varname> attribute can determine the page loading phase during which the <sgmltag><rich:componentControl></sgmltag> is attached to the source component: - </para> - <variablelist> - <varlistentry> - <term><literal>immediate</literal></term> - <listitem> - <para> - attached during execution of the script. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>available</literal></term> - <listitem> - <para> - attached after the target component is initialized. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>load</literal></term> - <listitem> - <para> - attached after the page is loaded. - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="sect-Component_Reference-richcomponentControl-Reference_data"> - <title>Reference data</title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.ComponentControl</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlComponentControl</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.ComponentControl</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.ComponentControlRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ComponentControlTag</classname> - </para> - </listitem> - </itemizedlist> - </section> - </section> -   <para> - The <sgmltag><a4j:push></sgmltag> component performs real-time updates on the client side from events raised at the server side. The events are pushed out to the client through the Java Message Service (<acronym>JMS</acronym>). When the <sgmltag><a4j:push></sgmltag> component is triggered by a server event, it can in turn cause Ajax updates and changes. + The <sgmltag><a4j:push></sgmltag> component performs real-time updates on the client side from events raised at the server side. The events are pushed out to the client through the Java Message Service (<acronym>JMS</acronym>). When the <sgmltag><a4j:push></sgmltag> component is triggered by a server event, it can in turn cause Ajax updates and changes. </para> + <para> + The <sgmltag><a4j:push></sgmltag> component uses the Comet model for pushing data to the client. + </para> <section id="sect-Component_Reference-a4jpush-Basic_usage"> <title>Basic usage</title> <para> - RichFaces requires the use of the <filename>jquery-atmosphere.js</filename> client plug-in for push functionality. The plug-in is added automatically by the push component renderer, but needs to additionally be added as a build dependency to your project. + RichFaces requires the use of the <filename>jquery-atmosphere.js</filename> client plug-in for push functionality. Add the server-side Atmosphere framework as a build dependency to your project. </para> <para> - The JMS instance on the back-end must be configured to work with your <sgmltag><a4j:push></sgmltag> components. Create topics on the JMS server for the push functionality to check for new messages. Refer to <citetitle>JMS Documentation</citetitle> for details on configuring JMS. + The JMS instance on the back-end must be configured to work with your <sgmltag><a4j:push></sgmltag> components. Refer to the <citetitle>JBoss Application Server Administration Console Guide</citetitle> for details on managing JBoss Application Server through the Administration Console. </para> + <example id="exam-Component_Reference-a4jpush-JMS_server_configuration"> + <title>JMS server configuration</title> + <para> + This example describes the JMS server configuration required for a simple chat room. The chat room requires topics on the JMS server for the push functionality to check for new messages. Create a new JMS topic using the following settings: + </para> + <itemizedlist> + <listitem> + <para> + <guilabel>Name:</guilabel> chat + </para> + </listitem> + <listitem> + <para> + <guilabel>JNDI name:</guilabel> /topic/chat + </para> + </listitem> + <listitem> + <para> + Use the default settings for other options. + </para> + </listitem> + </itemizedlist> + <para> + Add a single role for the topic in the same form using the following settings: + </para> + <itemizedlist> + <listitem> + <para> + <guilabel>Name:</guilabel> guest + </para> + </listitem> + <listitem> + <para> + <guilabel>Send:</guilabel> true + </para> + </listitem> + <listitem> + <para> + <guilabel>Consume:</guilabel> true + </para> + </listitem> + <listitem> + <para> + <guilabel>Create subscriber:</guilabel> true + </para> + </listitem> + <listitem> + <para> + <guilabel>Delete subscriber:</guilabel> true + </para> + </listitem> + <listitem> + <para> + <guilabel>Create durable subscriber:</guilabel> true + </para> + </listitem> + <listitem> + <para> + <guilabel>Delete durable subscriber:</guilabel> true + </para> + </listitem> + </itemizedlist> + </example> <para> - Use the <sgmltag><a4j:push></sgmltag> component's <varname>address</varname> attribute to reference the topic on the JMS server that contains the pushed messages. + Ensure the <guilabel>Create durable subscriber</guilabel> and <guilabel>Delete durable subscriber</guilabel> options are set to <guilabel>true</guilabel> for push functionality. Durable subscriptions receive all events, including those events which were sent while the push component was not connected. </para> <para> - The <sgmltag><a4j:push></sgmltag> component should also include the <varname>onerror</varname> event attribute to inform the user when an error has occurred with the push notifications. + Refer to <citetitle>JMS Documentation</citetitle> for details on configuring the JMS Server. </para> + <para> + With the JMS server configured, use the <sgmltag><a4j:push></sgmltag> component's <varname>address</varname> attribute to reference the topic on the JMS server that contains the pushed messages. + </para> <example id="exam-Component_Reference-a4jpush-Basic_usage"> <title>Basic usage</title> <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-a4jpush-Basic_usage.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <programlisting language="Java" role="JAVA"><xi:include parse="text" href="extras/exam-Component_Reference-a4jpush-Basic_usage.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> - The example demonstrates a simple use of the <sgmltag><a4j:push></sgmltag> component to manage a list of users in a chat room. The <sgmltag><a4j:push></sgmltag> component refers to the <code>#{chatBean.listSubtopic}@chat</code> address, which has been created on the JMS server. When a new message arrives, the <sgmltag><a4j:ajax></sgmltag> behavior causes the user list to update. If an error occurs, the user is alerted. + The example demonstrates a simple use of the <sgmltag><a4j:push></sgmltag> component to manage a list of users in a chat room. The <sgmltag><a4j:push></sgmltag> component refers to the <code>#{chatBean.listSubtopic}@chat</code> address, which has been created on the JMS server. It then uses the sub-topics to separate messages across different topics. </para> + <para> + When a new message arrives, the <sgmltag><a4j:ajax></sgmltag> behavior causes the user list to update. If an error occurs, the user is alerted. + </para> </example> </section> <section id="sect-Component_Reference-a4jpush-Handling_a_push_notification"> <title>Handling a push notification</title> <para> - A push notification sent to the <sgmltag><a4j:push></sgmltag> behavior will cause it to trigger any <sgmltag><a4j:ajax></sgmltag> components attached as sub-elements. Alternatively, use the <varname>ondataavailable</varname> event attribute to define a handler. + A push notification sent to the <sgmltag><a4j:push></sgmltag> behavior will cause it to trigger any event handlers defined using the <varname>ondataavailable</varname> event attribute. </para> + <para> + The <sgmltag><a4j:push></sgmltag> component should also include the <varname>onerror</varname> event attribute to inform the user when an error has occurred with the push notifications. + </para> <example id="exam-Component_Reference-a4jpush-Handling_a_push_notification"> <title>Handling a push notification</title> <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-a4jpush-Handling_a_push_notification.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> - The example uses the <varname>dataavailable</varname> event attribute with JavaScript to update messages in a chat room. + The example uses the <varname>dataavailable</varname> event attribute with JavaScript to update messages in a chat room. The <parameter>event.rf.data</parameter> parameter contains JMS message data serialized to JavaScript. </para> </example> </section> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml 2011-03-24 01:53:32 UTC (rev 22299) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml 2011-03-24 06:34:34 UTC (rev 22300) @@ -56,7 +56,8 @@ </important> </section> --> - + +  <section id="sect-Component_Reference-Containers-a4joutputPanel"> <title><sgmltag><a4j:outputPanel></sgmltag></title> @@ -118,6 +120,13 @@ The <sgmltag><a4j:outputPanel></sgmltag> component is used to group together components in to update them as a whole, rather than having to specify the components individually. </para> + <section id="sect-Component_Reference-a4joutputPanel-Aiding_complex_Ajax_rendering"> + <title>Aiding complex Ajax rendering</title> + <para> + Use the <sgmltag><a4j:outputPanel></sgmltag> component to wrap behaviors when using complex Ajax rendering. Parent components may not render correctly when attached behaviors trigger updates. Point the behaviors to the wrapping <sgmltag><a4j:outputPanel></sgmltag> component instead of the parent components. The <sgmltag><a4j:outputPanel></sgmltag> component is properly encoded to ensure the wrapped components are correctly rendered. + </para> + </section> + <section id="sect-Component_Reference-a4joutputPanel-Panel_appearance"> <title>Panel appearance</title> <para> @@ -134,11 +143,13 @@ <code>layout="block"</code> will render the component as a pair of <sgmltag><div></sgmltag> tags containing the child components, which will use any defined <sgmltag><div></sgmltag> element styles. </para> </listitem> +  </itemizedlist> <para> Setting <code>ajaxRendered="true"</code> will cause the <sgmltag><a4j:outputPanel></sgmltag> to be updated with each Ajax response for the page, even when not listed explicitly by the requesting component. This can in turn be overridden by specific attributes on any requesting components. @@ -233,10 +244,10 @@ <section id="sect-Component_Reference-Containers-a4jregion"> <title><sgmltag><a4j:region></sgmltag></title> <para> - The <sgmltag><a4j:region></sgmltag> component specifies a part of the document object model (<acronym>DOM</acronym>) tree to be processed on the server. The processing includes data handling during decoding, conversion, validation, and model updating. When not using <sgmltag><a4j:region></sgmltag>, the entire view functions as a region. + The <sgmltag><a4j:region></sgmltag> component specifies a part of the JSF component tree to be processed on the server. The region causes all the <classname>a4j</classname> and <classname>rich</classname> Ajax controls to execute: decoding, validating, and updating the model. The region causes these components to execute even if not explicitly declared. As such, processing areas can more easily be marked using a declarative approach. </para> <para> - The whole form is still submitted to the server, but only the specified region is processed. Regions can be nested, in which case only the immediate region of the component initiating the request will be processed. + Regions can be nested, in which case only the parent region of the component initiating the request will be processed. </para> <section id="sect-Component_Reference-a4jregion-Reference_data"> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Functions.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Functions.xml 2011-03-24 01:53:32 UTC (rev 22299) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Functions.xml 2011-03-24 06:34:34 UTC (rev 22300) @@ -6,6 +6,89 @@ <para> Read this chapter for details on special functions for use with particular components. Using JavaServer Faces Expression Language (<acronym>JSF</acronym> <acronym>EL</acronym>), these functions can be accessed through the <varname>data</varname> attribute of components. Refer to <xref linkend="sect-Component_Reference-Events_and_JavaScript_interactions-data" /> for details on the <varname>data</varname> attribute. </para> + + <section id="sect-Component_Reference-Functions-richcomponentControl"> + <title><sgmltag><rich:componentControl></sgmltag></title> + <para> + The <sgmltag><rich:componentControl></sgmltag> behavior allows JavaScript API functions to be called on target components. The functions are called after defined events are triggered on the component to with the <sgmltag><rich:componentControl></sgmltag> behavior is attached. Initialization variants and activation events can be customized, and parameters can be passed to the target component. + </para> + + <section id="sect-Component_Reference-richcomponentControl-Basic_usage"> + <title>Basic usage</title> + <para> + The <varname>operation</varname> attribute is required to attach JavaScript functions to the parent component, along with either the <varname>target</varname> or <varname>selector</varname> attributes. Use the <varname>operation</varname> attribute to specify the JavaScript API function to perform. Use the <varname>target</varname> attribute to define the <varname>id</varname> identifier of the target component, or use the <varname>selector</varname> attribute to define a number of target components through the use of valid jQuery selectors. + </para> + <para> + Use the <varname>event</varname> attribute to specify the event that triggers the JavaScript API function call if it is different from the default triggering event for the parent component. + </para> + <example id="exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage"> + <title><sgmltag><rich:componentControl></sgmltag> basic usage</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + The example contains a single command button, which when clicked shows the modal panel with the identifier <literal>ccModalPanelID</literal>. + </para> + </example> + </section> + +  + + <section id="sect-Component_Reference-richcomponentControl-Passing_parameters_to_API_methods"> + <title>Passing parameters to API methods</title> + <para> + The operation can receive parameters through nested <sgmltag><f:param></sgmltag> elements. + </para> + <example id="exam-Component_Reference-richcomponentControl-Using_parameters"> + <title>Using parameters</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcomponentControl-Using_parameters-1.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-richcomponentControl-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.ComponentControl</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlComponentControl</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.ComponentControl</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.ComponentControlRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ComponentControlTag</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> + <section id="sect-Component_Reference-Functions-richclientId"> <title><function>rich:clientId</function></title> <para> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Validation.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Validation.xml 2011-03-24 01:53:32 UTC (rev 22299) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Validation.xml 2011-03-24 06:34:34 UTC (rev 22300) @@ -32,14 +32,11 @@ <section id="sect-Component_Reference-richvalidator-Basic_usage"> <title>Basic usage</title> <para> - The <sgmltag><rich:validator></sgmltag> behavior is added as a child element to any input control. The value of the input control must reference a managed bean. The <sgmltag><rich:validator></sgmltag> behavior validates the content of the input control on the client-side based on registered server-side validators included in the managed bean. + The <sgmltag><rich:validator></sgmltag> behavior is added as a child element to any input control. The value of the input control must reference a managed bean. The content of the input control validates on the client-side based on registered server-side validators included in the managed bean. </para> <example id="exam-Component_Reference-richvalidator-Basic_usage"> <title>Basic usage</title> <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richvalidator-Basic_usage.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - The <sgmltag><rich:validator></sgmltag> behavior is added to an <sgmltag><h:inputText></sgmltag> control. The validator uses the registered server-side validators included in the managed bean referenced by the input control. - </para> </example> <note> <title>JSF validation tags</title> @@ -136,6 +133,9 @@ <para> The <sgmltag><rich:graphValidator></sgmltag> component performs a <methodname>clone()</methodname> method on the referenced bean instance during the validation phase. The cloned object is validated and triggers any required validation messages. As such, the model object remains clean, and the lifecycle is interrupted properly after the <emphasis>Process Validations</emphasis> phase. </para> + <para> + Ensure the referenced object implements the <interfacename>Cloneable</interfacename> interface, and allows a deep clone if required. + </para> </note> <section id="sect-Component_Reference-richgraphValidator-Basic_usage"> Deleted: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.js =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.js 2011-03-24 01:53:32 UTC (rev 22299) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.js 2011-03-24 06:34:34 UTC (rev 22300) @@ -1,11 +0,0 @@ -public class ActionparamBean { - private String name = "John"; - - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } -} Deleted: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.xml_sample =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.xml_sample 2011-03-24 01:53:32 UTC (rev 22299) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.xml_sample 2011-03-24 06:34:34 UTC (rev 22300) @@ -1,6 +0,0 @@ -<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> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jjsFunction-a4jjsFunction_example.xml_sample =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jjsFunction-a4jjsFunction_example.xml_sample 2011-03-24 01:53:32 UTC (rev 22299) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jjsFunction-a4jjsFunction_example.xml_sample 2011-03-24 06:34:34 UTC (rev 22300) @@ -1,7 +1,28 @@ +<table width="400"> + <tbody> + <tr> + <td> + <span onmouseover="updateName('Kate')" + onmouseout="updateName('')">Kate</span> + </td> + <td> + <span onmouseover="updateName('John')" + onmouseout="updateName('')">John</span> + </td> + <td> + <span onmouseover="updateName('Alex')" + onmouseout="updateName('')">Alex</span> + </td> + </tr> + <tr> + <td colspan="3"> + Name: <b><h:outputText id="showname" value="#{functionBean.text}" /></b> + </td> + </tr> + </tbody> +</table> <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> - ... + <a4j:jsFunction name="updateName" render="showname"> + <a4j:param name="name" assignTo="#{functionBean.text}"/> + </a4j:jsFunction> </h:form> Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jparam-Passing_client-side_parameters.xml_sample =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jparam-Passing_client-side_parameters.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jparam-Passing_client-side_parameters.xml_sample 2011-03-24 06:34:34 UTC (rev 22300) @@ -0,0 +1,15 @@ +<h:form> + <a4j:commandButton value="Show Screen Size" render="infoPanel"> + <a4j:param name="w" value="screen.width" + assignTo="#{paramBean.screenWidth}" noEscape="true" /> + <a4j:param name="h" value="screen.height" + assignTo="#{paramBean.screenHeight}" noEscape="true" /> + </a4j:commandButton> + + <h:panelGrid columns="2" id="infoPanel"> + <h:outputText value="Width:" /> + <h:outputText value="#{paramBean.screenWidth}" /> + <h:outputText value="Height:" /> + <h:outputText value="#{paramBean.screenHeight}" /> + </h:panelGrid> +</h:form> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jparam-a4jparam_example.java (from rev 22292, modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.js) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jparam-a4jparam_example.java (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jparam-a4jparam_example.java 2011-03-24 06:34:34 UTC (rev 22300) @@ -0,0 +1,11 @@ +public class ParamBean { + private String name = "John"; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } +} Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jparam-a4jparam_example.xml_sample (from rev 22292, modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jparam-a4jparam_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jparam-a4jparam_example.xml_sample 2011-03-24 06:34:34 UTC (rev 22300) @@ -0,0 +1,6 @@ +<h:form id="form"> + <a4j:commandButton value="Set name to Alex" reRender="rep"> + <a4j:param name="username" value="Alex" assignTo="#{paramBean.name}"/> + </a4j:commandButton> + <h:outputText id="rep" value="Name: #{paramBean.name}"/> +</h:form> Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jpush-Basic_usage.java =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jpush-Basic_usage.java (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jpush-Basic_usage.java 2011-03-24 06:34:34 UTC (rev 22300) @@ -0,0 +1,24 @@ +public String getListSubtopic() { + return this.getUserName() + SUBTOPIC_SEPARATOR + channelName + "List"; +} + +@Override +protected void onUserList(String channel, User[] users) { + try { + getTopicsContext().publish(new TopicKey("chat", getListSubtopic()), null); + } catch (MessageException e) { + LOGGER.error(e.getMessage(), e); + } +} + +@Override +protected void onJoin(String channel, String sender, String login, String hostname) { + try { + getTopicsContext().publish(new TopicKey("chat", getListSubtopic()), null); + Message messageObject = new Message("joined channel", sender, + DateFormat.getInstance().format(new Date())); + getTopicsContext().publish(new TopicKey("chat", getMessagesSubtopic()), messageObject); + } catch (MessageException e) { + LOGGER.error(e.getMessage(), e); + } +} Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-1.xml_sample =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-1.xml_sample 2011-03-24 01:53:32 UTC (rev 22299) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-1.xml_sample 2011-03-24 06:34:34 UTC (rev 22300) @@ -1,3 +1,3 @@ -<rich:componentControl event="rowclick" for="menu" operation="show"> - <f:param value="#{car.model}" name="model"/> +<rich:componentControl event="click" target="modalPanel" operation="show"> + <f:param value="width" name="500"/> </rich:componentControl> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage.xml_sample =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage.xml_sample 2011-03-24 01:53:32 UTC (rev 22299) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage.xml_sample 2011-03-24 06:34:34 UTC (rev 22300) @@ -1,4 +1,4 @@ <h:commandButton value="Show Modal Panel">  - <rich:componentControl for="ccModalPanelID" event="click" operation="show"/> + <rich:componentControl target="ccModalPanelID" event="click" operation="show"/> </h:commandButton> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richgraphValidator-Basic_usage.js =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richgraphValidator-Basic_usage.js 2011-03-24 01:53:32 UTC (rev 22299) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richgraphValidator-Basic_usage.js 2011-03-24 06:34:34 UTC (rev 22300) @@ -1,6 +1,6 @@ @ManagedBean @RequestScoped -public class UserBean { +public class UserBean implements Cloneable { @Size(min = 5, max = 15, message="Wrong size for password") private String password;

13 years, 1 month

1
0
0 / 0

JBoss Rich Faces SVN: r22299 - modules/docs/trunk/Developer_Guide/src/main/docbook/en-US.

by richfaces-svn-commits＠lists.jboss.org

Author: SeanRogers Date: 2011-03-23 21:53:32 -0400 (Wed, 23 Mar 2011) New Revision: 22299 Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Introduction.xml modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-RichFaces_overview.xml modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Skinning_and_theming.xml Log: Updates based on QE review RFPL-1384 Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml 2011-03-24 00:54:09 UTC (rev 22298) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml 2011-03-24 01:53:32 UTC (rev 22299) @@ -138,7 +138,7 @@ <step id="step-Developer_Guide-Creating_a_project-Create_a_new_project"> <title>Create a new project</title> <para> - Create a new project based on the JSF 2 environment using the RichFaces 4 template. In <productname>JBoss Tools</productname>, select <menuchoice><guimenu>File</guimenu><guimenu>New</guimenu><guimenuitem>JSF Project</guimenuitem></menuchoice> from the menu. Name the project, select <guilabel>JSF 2 + RichFaces 4</guilabel> from the <guilabel>JSF Environment</guilabel> drop-down box, and click the <guibutton>Finish</guibutton> button to create the project. + Create a new project based on the JSF 2 environment using the RichFaces 4 template. In <productname>JBoss Tools</productname>, select <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem><guimenuitem>JSF Project</guimenuitem></menuchoice> from the menu. Name the project, select <guilabel>JSF 2</guilabel> from the <guilabel>JSF Environment</guilabel> drop-down box, and click the <guibutton>Finish</guibutton> button to create the project. </para> <para> If necessary, update the JSF 2 JAR files to the latest versions. @@ -147,7 +147,7 @@ <step id="step-Developer_Guide-Creating_a_project-Add_the_RichFaces_libraries_to_the_project"> <title>Add the RichFaces libraries to the project</title> <para> - Add <filename>core-ui.jar</filename>, <filename>richfaces-api.jar</filename>, and <filename>richfaces-impl.jar</filename> into your project by copying them from the location where you unzipped the RichFaces archive to the <filename>WebContent/WEB-INF/lib/</filename> directory of your project in <application>JBoss Tools</application>. + Add <filename>richfaces-core-api.jar</filename>, <filename>richfaces-core-impl.jar</filename>, <filename>richfaces-components-api.jar</filename>, and <filename>richfaces-components-ui.jar</filename> into your project. Copy them from the location where you unzipped the RichFaces archive to the <filename>WebContent/WEB-INF/lib/</filename> directory of your project in <application>JBoss Tools</application>. </para> </step> <step id="step-Developer_Guide-Creating_a_project-Reference_the_tag_libraries"> @@ -164,8 +164,10 @@ </procedure> <para> - You are now ready to begin constructing your RichFaces applications. RichFaces components can be dragged and dropped into your application's XHTML pages from the RichFaces palette in <productname>JBoss Tools</productname>, shown in <xref linkend="figu-Developer_Guide-Creating_a_project-RichFaces_palette_in_JBoss_Tools" /> + You are now ready to begin constructing your RichFaces applications. RichFaces components can be dragged and dropped into your application's XHTML pages from the RichFaces palette in <productname>JBoss Tools</productname>. +  </para> +  </section> <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Creating_a_project_with_Maven"> @@ -201,7 +204,7 @@ A Maven archetype is a template for creating projects. <productname>Maven</productname> uses an archetype to generate a directory structure and files for a particular project, as well as creating <filename>pom.xml</filename> files that contain build instructions. </para> <para> - The RichFaces Component Development Kit includes a Maven archetype named <filename>richfaces-archetype-simpleapp</filename> for generating the basic structure and requirements for a RichFaces application project. Maven can obtain the archetype from the JBoss repository at <filename>https://repository.jboss.org/nexus/content/groups/public/</filename>. The archetype is also included with the RichFaces source code in the <filename>archetypes</filename> directory. Follow the procedure in this section to generate a new Maven-based RichFaces project using the archetype. + The RichFaces Component Development Kit includes a Maven archetype named <filename>richfaces-archetype-simpleapp</filename> for generating the basic structure and requirements for a RichFaces application project. Maven can obtain the archetype from the JBoss repository at <ulink url="https://repository.jboss.org/nexus/content/groups/public/">https://repository.jboss.org/nexus/content/groups/public/</ulink>. The archetype is also included with the RichFaces source code in the <filename>archetypes</filename> directory. Follow the procedure in this section to generate a new Maven-based RichFaces project using the archetype. </para> <procedure> <step id="step-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories"> @@ -260,6 +263,7 @@ </para> <screen><replaceable>new_project</replaceable> ├── <filename>pom.xml</filename> + ├── <filename>readme.txt</filename> └── <filename>src</filename> └── <filename>main</filename> ├── <filename>java</filename> Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Introduction.xml =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Introduction.xml 2011-03-24 00:54:09 UTC (rev 22298) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Introduction.xml 2011-03-24 01:53:32 UTC (rev 22299) @@ -24,7 +24,7 @@ </listitem> <listitem> <para> - Generate binary resources on the fly. Extensions to JSF 2 resource handlind facilities can generate images, sounds, <application>Microsoft Excel</application> spreadsheets, and more during run-time. + Generate binary resources on the fly. Extensions to JSF 2 resource-handling facilities can generate images, sounds, <application>Microsoft Excel</application> spreadsheets, and more during run-time. </para> </listitem> <listitem> Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-RichFaces_overview.xml =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-RichFaces_overview.xml 2011-03-24 00:54:09 UTC (rev 22298) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-RichFaces_overview.xml 2011-03-24 01:53:32 UTC (rev 22299) @@ -70,7 +70,7 @@ </listitem> <listitem> <para> - <productname>Google Chrome</productname> + <productname>Google Chrome 1.0</productname> and higher </para> </listitem> <listitem> @@ -88,7 +88,7 @@ </listitem> <listitem> <para> - <productname>Google Chrome</productname> + <productname>Google Chrome 1.0</productname> and higher </para> </listitem> <listitem> @@ -106,7 +106,7 @@ </listitem> <listitem> <para> - <productname>Google Chrome</productname> + <productname>Google Chrome 1.0</productname> and higher </para> </listitem> <listitem> Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Skinning_and_theming.xml =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Skinning_and_theming.xml 2011-03-24 00:54:09 UTC (rev 22298) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Skinning_and_theming.xml 2011-03-24 01:53:32 UTC (rev 22299) @@ -92,7 +92,7 @@ To add one of these skins to your application, add the <literal>org.richfaces.SKIN</literal> context parameter to the <filename>web.xml</filename> configuration file: </para> <programlisting><context-param> - <param-name>org.richfaces.SKIN</param-name> + <param-name>org.richfaces.skin</param-name> <param-value><replaceable>skin_name</replaceable></param-value> </context-param></programlisting> </section> @@ -132,294 +132,222 @@ <section id="sect-Developer_Guide-Skinning_overview-Skin_parameter_tables"> <title>Skin parameter tables</title> <para> - <xref linkend="tabl-Developer_Guide-Skin_parameter_tables_in_RichFaces-Parameter_settings_for_the_blueSky_skin" /> lists the default values for the parameter settings in the <literal>blueSky</literal> skin. These values are all listed in the <filename>buleSky.skin.properties</filename> file, which can be customized and extended as described in <xref linkend="sect-Developer_Guide-Skinning_and_theming-Customizing_skins" />. + <xref linkend="tabl-Developer_Guide-Skin_parameter_tables_in_RichFaces-Parameter_settings_for_the_blueSky_skin" /> lists the default values for the parameter settings in the <literal>blueSky</literal> skin. These values are all listed in the <filename>blueSky.skin.properties</filename> file, which can be customized and extended as described in <xref linkend="sect-Developer_Guide-Skinning_and_theming-Customizing_skins" />. </para> <table id="tabl-Developer_Guide-Skin_parameter_tables_in_RichFaces-Parameter_settings_for_the_blueSky_skin"> <title>Parameter settings for the <literal>blueSky</literal> skin</title> <tgroup cols="2"> <thead> <row> - <entry> - Parameter name - </entry> - <entry> - Default value - </entry> + <entry>Parameter name</entry> + <entry>Default value</entry> </row> </thead> <tbody> <row> - <entry><parameter> - headerBackgroundColor - </parameter></entry> - <entry><literal> - #BED6F8 - </literal></entry> + <entry><parameter>headerBackgroundColor</parameter></entry> + <entry><literal>#BED6F8</literal></entry> </row> <row> - <entry><parameter> - headerGradientColor - </parameter></entry> - <entry><literal> - #F2F7FF - </literal></entry> + <entry><parameter>headerGradientColor</parameter></entry> + <entry><literal>#F2F7FF</literal></entry> </row> <row> - <entry><parameter> - headTextColor - </parameter></entry> - <entry><literal> - #000000 - </literal></entry> + <entry><parameter>headTextColor</parameter></entry> + <entry><literal>#000000</literal></entry> </row> <row> - <entry><parameter> - headerWeightFont - </parameter></entry> - <entry><literal> - bold - </literal></entry> + <entry><parameter>headerWeightFont</parameter></entry> + <entry><literal>bold</literal></entry> </row> <row> - <entry><parameter> - generalBackgroundColor - </parameter></entry> - <entry><literal> - #FFFFFF - </literal></entry> + <entry><parameter>generalBackgroundColor</parameter></entry> + <entry><literal>#FFFFFF</literal></entry> </row> <row> - <entry><parameter> - generalTextColor - </parameter></entry> - <entry><literal> - #000000 - </literal></entry> + <entry><parameter>generalTextColor</parameter></entry> + <entry><literal>#000000</literal></entry> </row> <row> - <entry><parameter> - generalSizeFont - </parameter></entry> - <entry><literal> - 11px - </literal></entry> + <entry><parameter>generalSizeFont</parameter></entry> + <entry><literal>11px</literal></entry> </row> <row> - <entry><parameter> - generalFamilyFont - </parameter></entry> - <entry><literal> - Arial, Verdana, sans-serif - </literal></entry> + <entry><parameter>generalFamilyFont</parameter></entry> + <entry><literal>Arial, Verdana, sans-serif</literal></entry> </row> <row> - <entry><parameter> - controlTextColor - </parameter></entry> - <entry><literal> - #000000 - </literal></entry> + <entry><parameter>controlTextColor</parameter></entry> + <entry><literal>#000000</literal></entry> </row> <row> - <entry><parameter> - controlBackgroundColor - </parameter></entry> - <entry><literal> - #ffffff - </literal></entry> + <entry><parameter>controlBackgroundColor</parameter></entry> + <entry><literal>#FFFFFF</literal></entry> </row> <row> - <entry><parameter> - additionalBackgroundColor - </parameter></entry> - <entry><literal> - #ECF4FE - </literal></entry> + <entry><parameter>additionalBackgroundColor</parameter></entry> + <entry><literal>#ECF4FE</literal></entry> </row> <row> - <entry><parameter> - shadowBackgroundColor - </parameter></entry> - <entry><literal> - #000000 - </literal></entry> + <entry><parameter>shadowBackgroundColor</parameter></entry> + <entry><literal>#000000</literal></entry> </row> <row> - <entry><parameter> - shadowOpacity - </parameter></entry> - <entry><literal> - 1 - </literal></entry> + <entry><parameter>shadowOpacity</parameter></entry> + <entry><literal>1</literal></entry> </row> <row> - <entry><parameter> - panelBorderColor - </parameter></entry> - <entry><literal> - #BED6F8 - </literal></entry> + <entry><parameter>panelBorderColor</parameter></entry> + <entry><literal>#BED6F8</literal></entry> </row> <row> - <entry><parameter> - subBorderColor - </parameter></entry> - <entry><literal> - #ffffff - </literal></entry> + <entry><parameter>subBorderColor</parameter></entry> + <entry><literal>#FFFFFF</literal></entry> </row> <row> - <entry><parameter> - tabBackgroundColor - </parameter></entry> - <entry><literal> - #C6DEFF - </literal></entry> + <entry><parameter>calendarWeekBackgroundColor</parameter></entry> + <entry><literal>#F5F5F5</literal></entry> </row> <row> - <entry><parameter> - tabDisabledTextColor - </parameter></entry> - <entry><literal> - #8DB7F3 - </literal></entry> + <entry><parameter>calendarHolidaysBackgroundColor</parameter></entry> + <entry><literal>#FFEBDA</literal></entry> </row> <row> - <entry><parameter> - trimColor - </parameter></entry> - <entry><literal> - #D6E6FB - </literal></entry> + <entry><parameter>calendarHolidaysTextColor</parameter></entry> + <entry><literal>#FF7800</literal></entry> </row> <row> - <entry><parameter> - tipBackgroundColor - </parameter></entry> - <entry><literal> - #FAE6B0 - </literal></entry> + <entry><parameter>calendarCurrentBackgroundColor</parameter></entry> + <entry><literal>#FF7800</literal></entry> </row> <row> - <entry><parameter> - tipBorderColor - </parameter></entry> - <entry><literal> - #E5973E - </literal></entry> + <entry><parameter>calendarCurrentTextColor</parameter></entry> + <entry><literal>#FFEBDA</literal></entry> </row> <row> - <entry><parameter> - selectControlColor - </parameter></entry> - <entry><literal> - #E79A00 - </literal></entry> + <entry><parameter>calendarSpecBackgroundColor</parameter></entry> + <entry><literal>#E4F5E2</literal></entry> </row> <row> - <entry><parameter> - generalLinkColor - </parameter></entry> - <entry><literal> - #0078D0 - </literal></entry> + <entry><parameter>calendarSpecTextColor</parameter></entry> + <entry><literal>#000000</literal></entry> </row> <row> - <entry><parameter> - hoverLinkColor - </parameter></entry> - <entry><literal> - #0090FF - </literal></entry> + <entry><parameter>editorBackgroundColor</parameter></entry> + <entry><literal>#F1F1F1</literal></entry> </row> <row> - <entry><parameter> - visitedLinkColor - </parameter></entry> - <entry><literal> - #0090FF - </literal></entry> + <entry><parameter>editBackgroundColor</parameter></entry> + <entry><literal>#FEFFDA</literal></entry> </row> <row> - <entry><parameter> - headerSizeFont - </parameter></entry> - <entry><literal> - 11px - </literal></entry> + <entry><parameter>errorColor</parameter></entry> + <entry><literal>#FF0000</literal></entry> </row> <row> - <entry><parameter> - headerFamilyFont - </parameter></entry> - <entry><literal> - Arial, Verdana, sans-serif - </literal></entry> + <entry><parameter>gradientType</parameter></entry> + <entry><literal>plain</literal></entry> </row> <row> - <entry><parameter> - tabSizeFont - </parameter></entry> - <entry><literal> - 11px - </literal></entry> + <entry><parameter>tabBackgroundColor</parameter></entry> + <entry><literal>#C6DEFF</literal></entry> </row> <row> - <entry><parameter> - tabFamilyFont - </parameter></entry> - <entry><literal> - Arial, Verdana, sans-serif - </literal></entry> + <entry><parameter>tabDisabledTextColor</parameter></entry> + <entry><literal>#8DB7F3</literal></entry> </row> <row> - <entry><parameter> - buttonSizeFont - </parameter></entry> - <entry><literal> - 11px - </literal></entry> + <entry><parameter>tableHeaderBackgroundColor</parameter></entry> + <entry><literal>#D6E6FB</literal></entry> </row> <row> - <entry><parameter> - buttonFamilyFont - </parameter></entry> - <entry><literal> - Arial, Verdana, sans-serif - </literal></entry> + <entry><parameter>tableSubHeaderBackgroundColor</parameter></entry> + <entry><literal>#ECF4FE</literal></entry> </row> <row> - <entry><parameter> - tableBackgroundColor - </parameter></entry> - <entry><literal> - #FFFFFF - </literal></entry> + <entry><parameter>tableBorderWidth</parameter></entry> + <entry><literal>1px</literal></entry> </row> <row> - <entry><parameter> - tableFooterBackgroundColor - </parameter></entry> - <entry><literal> - #cccccc - </literal></entry> + <entry><parameter>tableHeaderTextColor</parameter></entry> + <entry><literal>#0B356C</literal></entry> </row> <row> - <entry><parameter> - tableSubfooterBackgroundColor - </parameter></entry> - <entry><literal> - #f1f1f1 - </literal></entry> + <entry><parameter>trimColor</parameter></entry> + <entry><literal>#D6E6FB</literal></entry> </row> <row> - <entry><parameter> - tableBorderColor - </parameter></entry> - <entry><literal> - #C0C0C0 - </literal></entry> + <entry><parameter>tipBackgroundColor</parameter></entry> + <entry><literal>#FAE6B0</literal></entry> </row> + <row> + <entry><parameter>tipBorderColor</parameter></entry> + <entry><literal>#E5973E</literal></entry> + </row> + <row> + <entry><parameter>selectControlColor</parameter></entry> + <entry><literal>#E79A00</literal></entry> + </row> + <row> + <entry><parameter>generalLinkColor</parameter></entry> + <entry><literal>#0078D0</literal></entry> + </row> + <row> + <entry><parameter>hoverLinkColor</parameter></entry> + <entry><literal>#0090FF</literal></entry> + </row> + <row> + <entry><parameter>visitedLinkColor</parameter></entry> + <entry><literal>#0090FF</literal></entry> + </row> + <row> + <entry><parameter>headerSizeFont</parameter></entry> + <entry><literal>11px</literal></entry> + </row> + <row> + <entry><parameter>headerFamilyFont</parameter></entry> + <entry><literal>Arial, Verdana, sans-serif</literal></entry> + </row> + <row> + <entry><parameter>tabSizeFont</parameter></entry> + <entry><literal>11px</literal></entry> + </row> + <row> + <entry><parameter>tabFamilyFont</parameter></entry> + <entry><literal>Arial, Verdana, sans-serif</literal></entry> + </row> + <row> + <entry><parameter>buttonSizeFont</parameter></entry> + <entry><literal>11px</literal></entry> + </row> + <row> + <entry><parameter>buttonFamilyFont</parameter></entry> + <entry><literal>Arial, Verdana, sans-serif</literal></entry> + </row> + <row> + <entry><parameter>tableBackgroundColor</parameter></entry> + <entry><literal>#FFFFFF</literal></entry> + </row> + <row> + <entry><parameter>tableFooterBackgroundColor</parameter></entry> + <entry><literal>#CCCCCC</literal></entry> + </row> + <row> + <entry><parameter>tableSubfooterBackgroundColor</parameter></entry> + <entry><literal>#F1F1F1</literal></entry> + </row> + <row> + <entry><parameter>tableBorderColor</parameter></entry> + <entry><literal>#C0C0C0</literal></entry> + </row> + <row> + <entry><parameter>warningColor</parameter></entry> + <entry><literal>#FFE6E6</literal></entry> + </row> + <row> + <entry><parameter>warningBackgroundColor</parameter></entry> + <entry><literal>#FF0000</literal></entry> + </row> </tbody> </tgroup> </table> @@ -587,7 +515,7 @@ <para> This example takes the <literal>blueSky</literal> skin as a base and only changes the <varname>generalSizeFont</varname> parameter. </para> - <programlisting>baseSkin=blueSky + <programlisting>baseSkin=blueSky generalSizeFont=12pt</programlisting> </example> </step> @@ -596,7 +524,7 @@ <step> <title>Reference the skin definition</title> <para>Add a skin definition <sgmltag><context-param></sgmltag> to the <filename>web.xml</filename> settings file of your application:</para> - <programlisting><context-param> + <programlisting language="XML" role="XML"><context-param> <param-name>org.richfaces.skin</param-name> <param-value><replaceable>new_skin_name</replaceable></param-value> </context-param></programlisting> @@ -626,7 +554,7 @@ <para> Alternatively, use <acronym>EL</acronym> (Expression Language) to reference the skin bean from the <filename>web.xml</filename> settings file. </para> -<programlisting language="XML" role="XML"><context-param> + <programlisting language="XML" role="XML"><context-param> <param-name>org.richfaces.skin</param-name> <param-value>#{skinBean.skin}</param-value> </context-param></programlisting> @@ -639,7 +567,7 @@ The application needs an initial skin to display before the user chooses an alternative skin. Specify the skin in your class with <code>@ManagedProperty</code>. </para> <programlisting language="Java" role="JAVA">@ManagedProperty(value="blueSky") -Private String skin;</programlisting> +private String skin;</programlisting> <stepalternatives> <step> <para>

13 years, 1 month

1
0
0 / 0

JBoss Rich Faces SVN: r22298 - modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning.

by richfaces-svn-commits＠lists.jboss.org

Author: SeanRogers Date: 2011-03-23 20:54:09 -0400 (Wed, 23 Mar 2011) New Revision: 22298 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/tabl-richinputNumberSpinner.xml Log: Fixed rf-insp skinning table RFPL-1384 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/tabl-richinputNumberSpinner.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/tabl-richinputNumberSpinner.xml 2011-03-23 17:48:56 UTC (rev 22297) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/tabl-richinputNumberSpinner.xml 2011-03-24 00:54:09 UTC (rev 22298) @@ -36,7 +36,7 @@ </row> <row> - <entry morerows="2"> + <entry morerows="3"> <variablelist> <varlistentry> <term><classname>.rf-insp-inp</classname></term>

13 years, 1 month

1
0
0 / 0

JBoss Rich Faces SVN: r22297 - branches/enterprise.

by richfaces-svn-commits＠lists.jboss.org

Author: ghjboss Date: 2011-03-23 13:48:56 -0400 (Wed, 23 Mar 2011) New Revision: 22297 Added: branches/enterprise/3.3.1.SP2_RFPL-1383/ Log: create branch for the patch RFPL-1383

13 years, 1 month

1
0
0 / 0

JBoss Rich Faces SVN: r22296 - in branches/RF-10753/examples/richfaces-showcase: src/main/webapp-gae/WEB-INF and 1 other directory.

by richfaces-svn-commits＠lists.jboss.org

Author: artdaw Date: 2011-03-23 08:28:21 -0400 (Wed, 23 Mar 2011) New Revision: 22296 Added: branches/RF-10753/examples/richfaces-showcase/src/main/webapp-gae/WEB-INF/faces-config.xml Modified: branches/RF-10753/examples/richfaces-showcase/pom.xml branches/RF-10753/examples/richfaces-showcase/src/main/webapp-gae/WEB-INF/web.xml Log: RF-10259: GAE start time is decreased. Verified by Konstantin Mishin. Modified: branches/RF-10753/examples/richfaces-showcase/pom.xml =================================================================== --- branches/RF-10753/examples/richfaces-showcase/pom.xml 2011-03-23 06:40:00 UTC (rev 22295) +++ branches/RF-10753/examples/richfaces-showcase/pom.xml 2011-03-23 12:28:21 UTC (rev 22296) @@ -200,6 +200,7 @@ <directory>src/main/webapp</directory> <excludes> <exclude>WEB-INF/web.xml</exclude> + <exclude>WEB-INF/faces-config.xml</exclude> </excludes> </resource> <resource> Added: branches/RF-10753/examples/richfaces-showcase/src/main/webapp-gae/WEB-INF/faces-config.xml =================================================================== --- branches/RF-10753/examples/richfaces-showcase/src/main/webapp-gae/WEB-INF/faces-config.xml (rev 0) +++ branches/RF-10753/examples/richfaces-showcase/src/main/webapp-gae/WEB-INF/faces-config.xml 2011-03-23 12:28:21 UTC (rev 22296) @@ -0,0 +1,256 @@ +<?xml version='1.0' encoding='UTF-8'?> + +<faces-config xmlns="http://java.sun.com/xml/ns/javaee" + version="2.0" metadata-complete="true"> + + <application> +  + </application> + + <component> + <component-type>syntaxHighlighter</component-type> + <component-class>org.richfaces.demo.components.sh.SyntaxHighlighter</component-class> + </component> + + <managed-bean> + <managed-bean-name>functionBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.function.FunctionBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>validationBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.validation.ValidationBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>passwordValidationBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.validation.PasswordValidationBean</managed-bean-class> + <managed-bean-scope>session</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>mediaData</managed-bean-name> + <managed-bean-class>org.richfaces.demo.mediaOutput.MediaData</managed-bean-class> + <managed-bean-scope>view</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>mediaBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.mediaOutput.MediaBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>pollBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.poll.PollBean</managed-bean-class> + <managed-bean-scope>view</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>profile</managed-bean-name> + <managed-bean-class>org.richfaces.demo.togglepanel.Profile</managed-bean-class> + <managed-bean-scope>view</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>progressBarBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.progressBar.ProgressBarBean</managed-bean-class> + <managed-bean-scope>view</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>tooltipData</managed-bean-name> + <managed-bean-class>org.richfaces.demo.tooltip.TooltipData</managed-bean-class> + <managed-bean-scope>view</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>calendarBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.calendar.CalendarBean</managed-bean-class> + <managed-bean-scope>view</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>calendarModel</managed-bean-name> + <managed-bean-class>org.richfaces.demo.calendar.model.CalendarModel</managed-bean-class> + <managed-bean-scope>application</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>queueBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.queue.QueueBean</managed-bean-class> + <managed-bean-scope>view</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>regionBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.region.RegionBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>autocompleteBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.autocomplete.AutocompleteBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + <managed-property> + <property-name>capitals</property-name> + <value>#{capitalsParser.capitalsList}</value> + </managed-property> + </managed-bean> + <managed-bean> + <managed-bean-name>inplaceSelectBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.inplaces.InplaceSelectBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + <managed-property> + <property-name>capitals</property-name> + <value>#{capitalsParser.capitalsList}</value> + </managed-property> + </managed-bean> + <managed-bean> + <managed-bean-name>panelMenuBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.panelmenu.PanelMenuBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>capitalsBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.tables.CapitalsBean</managed-bean-class> + <managed-bean-scope>session</managed-bean-scope> + <managed-property> + <property-name>capitals</property-name> + <value>#{capitalsParser.capitalsList}</value> + </managed-property> + </managed-bean> + <managed-bean> + <managed-bean-name>carsBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.tables.CarsBean</managed-bean-class> + <managed-bean-scope>session</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>carsFilteringBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.tables.CarsFilteringBean</managed-bean-class> + <managed-bean-scope>session</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>capitalsSortingBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.tables.CapitalsSortingBean</managed-bean-class> + <managed-bean-scope>view</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>extTableSelectionBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.tables.ExtTableSelectionBean</managed-bean-class> + <managed-bean-scope>session</managed-bean-scope> + <managed-property> + <property-name>inventoryItems</property-name> + <value>#{carsBean.allInventoryItems}</value> + </managed-property> + </managed-bean> + <managed-bean> + <managed-bean-name>capitalsParser</managed-bean-name> + <managed-bean-class>org.richfaces.demo.tables.model.capitals.CapitalsParser</managed-bean-class> + <managed-bean-scope>application</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>slidesBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.tables.SlidesBean</managed-bean-class> + <managed-bean-scope>view</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>reportBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.tables.ReportBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>paramBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.param.ParamBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>toolBarBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.toolbar.ToolBarBean</managed-bean-class> + <managed-bean-scope>view</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>userBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.common.UserBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>demoNavigator</managed-bean-name> + <managed-bean-class>org.richfaces.demo.common.navigation.DemoNavigator</managed-bean-class> + <managed-bean-scope>session</managed-bean-scope> + <managed-property> + <property-name>groups</property-name> + <value>#{navigationParser.groupsList}</value> + </managed-property> + </managed-bean> + <managed-bean> + <managed-bean-name>navigationParser</managed-bean-name> + <managed-bean-class>org.richfaces.demo.common.navigation.NavigationParser</managed-bean-class> + <managed-bean-scope>application</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>selectsBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.common.SelectsBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>skinBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.common.SkinBean</managed-bean-class> + <managed-bean-scope>session</managed-bean-scope> + <managed-property> + <property-name>skin</property-name> + <value>blueSky</value> + </managed-property> + </managed-bean> + <managed-bean> + <managed-bean-name>listBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.lists.ListBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>fileUploadBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.fileupload.FileUploadBean</managed-bean-class> + <managed-bean-scope>session</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>dragDropBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.dragdrop.DragDropBean</managed-bean-class> + <managed-bean-scope>view</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>dragDropEventBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.dragdrop.DragDropEventBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + <managed-property> + <property-name>dragDropBean</property-name> + <value>#{dragDropBean}</value> + </managed-property> + </managed-bean> + <managed-bean> + <managed-bean-name>dropDownMenuBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.dropdownmenu.DropDownMenuBean</managed-bean-class> + <managed-bean-scope>view</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>cdsParser</managed-bean-name> + <managed-bean-class>org.richfaces.demo.tree.CDParser</managed-bean-class> + <managed-bean-scope>application</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>fileSystemBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.tree.adaptors.FileSystemBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>treeBean</managed-bean-name> + <managed-bean-class>org.richfaces.demo.tree.TreeBean</managed-bean-class> + <managed-bean-scope>application</managed-bean-scope> + <managed-property> + <property-name>cdXmlDescriptors</property-name> + <value>#{cdsParser.cdsList}</value> + </managed-property> + </managed-bean> + + <managed-bean> + <managed-bean-name>opBean1</managed-bean-name> + <managed-bean-class>org.richfaces.demo.outputPanel.OutputPanelBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> + <managed-bean> + <managed-bean-name>opBean2</managed-bean-name> + <managed-bean-class>org.richfaces.demo.outputPanel.OutputPanelBean</managed-bean-class> + <managed-bean-scope>request</managed-bean-scope> + </managed-bean> +</faces-config> Modified: branches/RF-10753/examples/richfaces-showcase/src/main/webapp-gae/WEB-INF/web.xml =================================================================== --- branches/RF-10753/examples/richfaces-showcase/src/main/webapp-gae/WEB-INF/web.xml 2011-03-23 06:40:00 UTC (rev 22295) +++ branches/RF-10753/examples/richfaces-showcase/src/main/webapp-gae/WEB-INF/web.xml 2011-03-23 12:28:21 UTC (rev 22296) @@ -54,16 +54,6 @@ <param-value>org.ajax4jsf.cache.lru.LRUMapCacheFactory</param-value> </context-param> - <context-param> - <description> - Set this flag to true if you want the JavaServer Faces - Reference Implementation to validate the XML in your - faces-config.xml resources against the DTD. Default - value is false. - </description> - <param-name>com.sun.faces.validateXml</param-name> - <param-value>true</param-value> - </context-param>  <context-param> <description> @@ -120,4 +110,4 @@ <role-name>admin</role-name> </auth-constraint> </security-constraint> -</web-app> \ No newline at end of file +</web-app>

13 years, 1 month

1
0
0 / 0

JBoss Rich Faces SVN: r22295 - modules/docs/trunk/Component_Reference/src/main/docbook/en-US.

by richfaces-svn-commits＠lists.jboss.org

Author: SeanRogers Date: 2011-03-23 02:40:00 -0400 (Wed, 23 Mar 2011) New Revision: 22295 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml Log: Removed unnecessary common features chapter: RFPL-1380 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml 2011-03-23 06:25:43 UTC (rev 22294) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml 2011-03-23 06:40:00 UTC (rev 22295) @@ -8,7 +8,6 @@ --> <xi:include href="chap-Component_Reference-Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Common_Ajax_attributes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="chap-Component_Reference-Common_features.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <part id="part-Component_Reference-Ajax_control_components"> <title>Ajax control components</title> <xi:include href="chap-Component_Reference-Actions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

13 years, 1 month

1
0
0 / 0

JBoss Rich Faces SVN: r22294 - in modules/docs/trunk/Component_Reference/src/main/docbook/en-US: extras and 1 other directory.

by richfaces-svn-commits＠lists.jboss.org

Author: SeanRogers Date: 2011-03-23 02:25:43 -0400 (Wed, 23 Mar 2011) New Revision: 22294 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Common_Ajax_attributes.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-data-Data_reference_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-render-render_example.xml_sample Log: Revised Component Reference common Ajax attributes: RFPL-1380 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Common_Ajax_attributes.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Common_Ajax_attributes.xml 2011-03-23 01:49:02 UTC (rev 22293) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Common_Ajax_attributes.xml 2011-03-23 06:25:43 UTC (rev 22294) @@ -9,12 +9,82 @@ <para> Most attributes have default values, so they need not be explicitly set for the component to function in its default state. These attributes can be altered to customize the behavior of the component if necessary. </para> + + <section id="sect-Component_Reference-Common_Ajax_attributes-Data_processing"> + <title>Data processing</title> + <para> + The RichFaces Ajax script is built on a base of the JSF 2 Ajax script. As such, each time a request is sent, the data from the requesting component's parent <acronym>JSF</acronym> form is submitted along with the <acronym>XMLHTTPRequest</acronym> object. The form data contains values from the input element and auxiliary information such as state-saving data. + </para> + <section id="sect-Component_Reference-Data_processing-execute"> + <title><varname>execute</varname></title> + <para> + The <varname>execute</varname> attribute allows <acronym>JSF</acronym> processing to be limited to defined components. The <varname>execute</varname> attribute can point to an <varname>id</varname> identifier of a specific component to process. Components can also be identified through the use of Expression Language (<acronym>EL</acronym>). + </para> + <para> + Alternatively, the <varname>execute</varname> attribute accepts the following keywords: + </para> + <variablelist> + <varlistentry> + <term><code>@all</code></term> + <listitem> + <para> + Every component is processed. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>@none</code></term> + <listitem> + <para> + No components are processed. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>@this</code></term> + <listitem> + <para> + The requesting component with the <varname>execute</varname> attribute is processed. This is the default behavior for components. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>@form</code></term> + <listitem> + <para> + The form that contains the requesting component is processed. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>@region</code></term> + <listitem> + <para> + The region that contains the requesting component is processed. Use the <sgmltag><a4j:region></sgmltag> component as a wrapper element to specify regions. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Some components make use of additional keywords. These are detailed under the relevant component entry in this book. + </para> + </section> + + <section id="sect-Component_Reference-Data_processing-bypassUpdates"> + <title><varname>bypassUpdates</varname></title> + <para> + If the <varname>bypassUpdates</varname> attribute is set to <literal>true</literal>, the Update Model phase of the request processing lifecycle is bypassed. This is useful if user input needs to be validated but the model does not need to be updated. This is the opposite functionality to the <varname>execute</varname> attribute in RichFaces. + </para> + </section> + + </section> + <section id="sect-Component_Reference-Common_Ajax_attributes-Rendering"> <title>Rendering</title> <section id="sect-Component_Reference-Rendering-render"> <title><varname>render</varname></title> <para> - The <varname>render</varname> attribute provides a reference to one or more areas on the page that need updating after an Ajax interaction. It uses the <methodname>UIComponent.findComponent()</methodname> algorithm to find the components in the component tree using their <varname>id</varname> attributes as a reference. Components can be referenced by their <varname>id</varname> attribute alone, or by a hierarchy of components' <varname>id</varname> attributes to make locating components more efficient. <xref linkend="exam-Component_Reference-render-render_example" /> shows both ways of referencing components. Each command button will correctly render the referenced panel grids, but the second button locates the references more efficiently with explicit hierarchy paths. + The <varname>render</varname> attribute provides a reference to one or more components on the page that need updating after an Ajax interaction. It uses the <methodname>UIComponent.findComponent()</methodname> algorithm to find the components in the component tree using their <varname>id</varname> identifiers as a reference. Components can be referenced by their <varname>id</varname> identifier alone, or by their <varname>clientId</varname> identifier to make locating components more efficient. <xref linkend="exam-Component_Reference-render-render_example" /> shows both ways of referencing components. Each command button will correctly render the referenced panel grids, but the second button locates the references more efficiently with explicit <varname>clientId</varname> paths. </para> <example id="exam-Component_Reference-render-render_example"> <title>render example</title> @@ -23,13 +93,25 @@ <para> The value of the <varname>render</varname> attribute can also be an expression written using JavaServer Faces' Expression Language (<acronym>EL</acronym>); this can either be a <type>Set</type>, <type>Collection</type>, <type>Array</type>, or <type>String</type>. </para> + <note> + <title>Differences between <acronym>JSF</acronym> Ajax and RichFaces Ajax</title> + <para> + <acronym>JSF</acronym> evaluates all parameters during page rendering. As such, during a request from a page, all <varname>execute</varname> and <varname>render</varname> values are passed to the server from the client. In contrast, RichFaces evaluates these options at the server side during the current request. + </para> + <para> + This means that with JSF, making changes during a request to a <varname>render</varname> value defined with EL will not influence the request. RichFaces, however, will always use the newer values. + </para> + <para> + The RichFaces approach additionally increases data integrity. Parameters that are changed from the client side are re-evaluated on the server, where they cannot be changed. + </para> + </note> <important> - <title><varname>rendered</varname> attributes</title> + <title>Conditionally-rendered component updates</title> <para> - A common problem with using <varname>render</varname> occurs when the referenced component has a <varname>rendered</varname> attribute. <acronym>JSF</acronym> does not mark the place in the browser's Document Object Model (<acronym>DOM</acronym>) where the rendered component would be placed in case the <varname>rendered</varname> attribute returns <literal>false</literal>. As such, when RichFaces sends the render code to the client, the page does not update as the place for the update is not known. + A common problem with using <varname>render</varname> occurs when the referenced component is conditionally rendered via the <varname>rendered</varname> attribute. If a component is not initially rendered, it does not have any HTML representation in the Document Object Model (<acronym>DOM</acronym>). As such, when RichFaces renders the component via Ajax, the page does not update as the place for the update is not known. </para> <para> - To work around this issue, wrap the component to be rendered in an <sgmltag><a4j:outputPanel></sgmltag> with <code>layout="none"</code>. The <sgmltag><a4j:outputPanel></sgmltag> will receive the update and render the component as required. + To work around this issue, wrap the component to be rendered in an <sgmltag><a4j:outputPanel></sgmltag> component. The <sgmltag><a4j:outputPanel></sgmltag> component will receive the update and render the component as required. </para> </important> </section> @@ -40,14 +122,17 @@ A component with <code>ajaxRendered="true"</code> will be re-rendered with <emphasis>every</emphasis> Ajax request, even when not referenced by the requesting component's <varname>render</varname> attribute. This can be useful for updating a status display or error message without explicitly requesting it. </para> <para> - Rendering of components in this way can be repressed by adding <code>limitRender="true"</code> to the requesting component, as described in <xref linkend="sect-Component_Reference-Rendering-limitRender" />. + The <varname>ajaxRendered</varname> attribute's functionality is the basis for the <sgmltag><a4j:outputPanel></sgmltag> component. The <sgmltag><a4j:outputPanel></sgmltag> component is designed to mark parts of the page for automatic updating. Refer to <xref linkend="sect-Component_Reference-Containers-a4joutputPanel" /> for details. </para> + <para> + Automatic rendering of such components can be repressed by adding <code>limitRender="true"</code> to the requesting component, as described in <xref linkend="sect-Component_Reference-Rendering-limitRender" />. + </para> </section> <section id="sect-Component_Reference-Rendering-limitRender"> <title><varname>limitRender</varname></title> <para> - A component with <code>limitRender="true"</code> specified will <emphasis>not</emphasis> cause components with <code>ajaxRendered="true"</code> to re-render, and only those components listed in the <varname>render</varname> attribute will be updated. This essentially overrides the <varname>ajaxRendered</varname> attribute in other components. + RichFaces Ajax-enabled components and Ajax behaviors with <code>limitRender="true"</code> specified will <emphasis>not</emphasis> cause components with <code>ajaxRendered="true"</code> to re-render, and only those components listed in the <varname>render</varname> attribute will be updated. This essentially overrides the <varname>ajaxRendered</varname> attribute in other components. </para> <para> <xref linkend="exam-Component_Reference-data-Data_reference_example" /> describes two command buttons, a panel grid rendered by the buttons, and an output panel showing error messages. When the first button is clicked, the output panel is rendered even though it is not explicitly referenced with the <varname>render</varname> attribute. The second button, however, uses <code>limitRender="true"</code> to override the output panel's rendering and only render the panel grid. @@ -62,20 +147,22 @@ <section id="sect-Component_Reference-Common_Ajax_attributes-Queuing_and_traffic_control"> <title>Queuing and traffic control</title> +  <section id="sect-Component_Reference-Queuing_and_traffic_control-requestDelay"> <title><varname>requestDelay</varname></title> <para> - The <varname>requestDelay</varname> attribute specifies an amount of time in milliseconds for the request to wait in the queue before being sent to the server. If a similar request is added to the queue before the delay is over, the original request is removed from the queue and not sent. + The <varname>requestDelay</varname> attribute specifies an amount of time in milliseconds for the request to wait in the queue before being sent to the server. If a similar request is added to the queue before the delay is over, the original request is replaced with the new one. </para> </section> @@ -87,37 +174,10 @@ </section> </section> - - <section id="sect-Component_Reference-Common_Ajax_attributes-Data_processing"> - <title>Data processing</title> - <para> - RichFaces uses a form-based approach for sending Ajax requests. As such, each time a request is sent the data from the requesting component's parent <acronym>JSF</acronym> form is submitted along with the <acronym>XMLHTTPRequest</acronym> object. The form data contains values from the input element and auxiliary information such as state-saving data. - </para> - <section id="sect-Component_Reference-Data_processing-execute"> - <title><varname>execute</varname></title> - <para> - The <varname>execute</varname> attribute allows <acronym>JSF</acronym> processing to be limited to defined components. To only process the requesting component, <code>execute="@this"</code> can be used. - </para> - </section> - - <section id="sect-Component_Reference-Data_processing-immediate"> - <title><varname>immediate</varname></title> - <para> - If the <varname>immediate</varname> attribute is set to <literal>true</literal>, the default ActionListener is executed immediately during the Apply Request Values phase of the request processing lifecycle, rather than waiting for the Invoke Application phase. This allows some data model values to be updated regardless of whether the Validation phase is successful or not. - </para> - </section> - - <section id="sect-Component_Reference-Data_processing-bypassUpdates"> - <title><varname>bypassUpdates</varname></title> - <para> - If the <varname>bypassUpdates</varname> attribute is set to <literal>true</literal>, the Update Model phase of the request processing lifecycle is bypassed. This is useful if user input needs to be validated but the model does not need to be updated. - </para> - </section> - </section> - - <section id="sect-Component_Reference-Common_Ajax_attributes-Action_and_navigation"> - <title>Action and navigation</title> +  <section id="sect-Component_Reference-Common_Ajax_attributes-Events_and_JavaScript_interactions"> <title>Events and JavaScript interactions</title> <para> - RichFaces allows for Ajax-enabled <acronym>JSF</acronym> applications to be developed without using any additional JavaScript code. However it is still possible to invoke custom JavaScript code through Ajax events using event listeners. + JSF provides global <varname>jsf.ajax.onError</varname> and <varname>jsf.ajax.onEvent</varname> events to define handlers (the <varname>jsf.ajax.onEvent</varname> event is used for all <varname>begin</varname>, <varname>success</varname>, and <varname>complete</varname> events). RichFaces adds event-specific attributes at the component level. </para> - <section id="sect-Component_Reference-Events_and_JavaScript_interactions-submit"> - <title><varname>submit</varname></title> + <section id="sect-Component_Reference-Events_and_JavaScript_interactions-onsubmit"> + <title><varname>onsubmit</varname></title> <para> - The <varname>submit</varname> event attribute invokes the event listener <emphasis>before</emphasis> the Ajax request is sent. The request is canceled if the event listener defined for <varname>submit</varname> event returns <literal>false</literal>. + The <varname>onsubmit</varname> event attribute invokes the event listener <emphasis>before</emphasis> the Ajax request is sent. The request is canceled if the event listener defined for the <varname>onsubmit</varname> event returns <literal>false</literal>. </para> </section> - <section id="sect-Component_Reference-Events_and_JavaScript_interactions-begin"> - <title><varname>begin</varname></title> + <section id="sect-Component_Reference-Events_and_JavaScript_interactions-onbegin"> + <title><varname>onbegin</varname></title> <para> - The <varname>begin</varname> event attribute invokes the event listener <emphasis>after</emphasis> the Ajax request is sent. + The <varname>onbegin</varname> event attribute invokes the event listener <emphasis>after</emphasis> the Ajax request is sent. </para> </section> - <section id="sect-Component_Reference-Events_and_JavaScript_interactions-click"> - <title><varname>click</varname></title> + <section id="sect-Component_Reference-Events_and_JavaScript_interactions-onbeforedomupdate"> + <title><varname>onbeforedomupdate</varname></title> <para> - The <varname>click</varname> event attribute functions similarly to the <varname>submit</varname> event attribute for those components that can be clicked, such as <sgmltag><a4j:commandButton></sgmltag> and <sgmltag><a4j:commandLink></sgmltag>. It invokes the defined JavaScript before the Ajax request, and the request will be canceled if the defined code returns <literal>false</literal>. + The <varname>onbeforedomupdate</varname> event attribute invokes the event listener after the Ajax response has been returned but <emphasis>before</emphasis> the <acronym>DOM</acronym> tree of the browser has been updated. </para> </section> - <section id="sect-Component_Reference-Events_and_JavaScript_interactions-success"> - <title><varname>success</varname></title> + <section id="sect-Component_Reference-Events_and_JavaScript_interactions-oncomplete"> + <title><varname>oncomplete</varname></title> <para> - The <varname>success</varname> event attribute invokes the event listener after the Ajax response has been returned but <emphasis>before</emphasis> the <acronym>DOM</acronym> tree of the browser has been updated. + The <varname>oncomplete</varname> event attribute invokes the event listener after the Ajax response has been returned <emphasis>and</emphasis> the <acronym>DOM</acronym> tree of the browser has been updated. </para> - </section> - - <section id="sect-Component_Reference-Events_and_JavaScript_interactions-complete"> - <title><varname>complete</varname></title> - <para> - The <varname>complete</varname> event attribute invokes the event listener after the Ajax response has been returned <emphasis>and</emphasis> the <acronym>DOM</acronym> tree of the browser has been updated. - </para> +  - <section id="sect-Component_Reference-Events_and_JavaScript_interactions-error"> - <title><varname>error</varname></title> - <para> - The <varname>error</varname> event attribute invokes the event listener when an error has occurred during Ajax communications. - </para> + <section id="sect-Component_Reference-Events_and_JavaScript_interactions-data"> + <title><varname>data</varname></title> + <para> + The <varname>data</varname> attribute allows additional data to be handled with the <varname>oncomplete</varname> event. Use <acronym>JSF</acronym> Expression Language (<acronym>EL</acronym>) to reference the property of the managed bean, and its value will be serialized in JavaScript Object Notation (<acronym>JSON</acronym>) and returned to the client side. The property can then be referenced through the <parameter>event.data</parameter> variable in the event attribute definitions. Both primitive types and complex types such as arrays and collections can be serialized and used with <varname>data</varname>. + </para> + <example id="exam-Component_Reference-data-Data_reference_example"> + <title>Data reference example</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-data-Data_reference_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + </section> - <section id="sect-Component_Reference-Events_and_JavaScript_interactions-data"> - <title><varname>data</varname></title> + <section id="sect-Component_Reference-Events_and_JavaScript_interactions-onerror"> + <title><varname>onerror</varname></title> <para> - The <varname>data</varname> event attribute allows the use of additional data during an Ajax call. <acronym>JSF</acronym> Expression Language (<acronym>EL</acronym>) can be used to reference the property of the managed bean, and its value will be serialized in JavaScript Object Notation (<acronym>JSON</acronym>) and returned to the client side. The property can then be referenced through the <varname>data</varname> variable in the event attribute definitions. Both primitive types and complex types such as arrays and collections can be serialized and used with <varname>data</varname>. + The <varname>onerror</varname> event attribute invokes the event listener when an error has occurred during Ajax communications. </para> - <example id="exam-Component_Reference-data-Data_reference_example"> - <title>Data reference example</title> - <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-data-Data_reference_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </example> </section> </section> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-data-Data_reference_example.xml_sample =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-data-Data_reference_example.xml_sample 2011-03-23 01:49:02 UTC (rev 22293) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-data-Data_reference_example.xml_sample 2011-03-23 06:25:43 UTC (rev 22294) @@ -1 +1 @@ -<a4j:commandButton value="Update" data="#{userBean.name}" complete="showTheName(data.name)" /> +<a4j:commandButton value="Update" oncomplete="showTheName(event.data.name)" data="#{userBean.name}" /> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-render-render_example.xml_sample =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-render-render_example.xml_sample 2011-03-23 01:49:02 UTC (rev 22293) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-render-render_example.xml_sample 2011-03-23 06:25:43 UTC (rev 22294) @@ -7,8 +7,8 @@ ... </h:panelGrid> -<f:subview id="sv"> +<h:form id="sv"> <h:panelGrid id="infoBlock2"> ... </h:panelGrid> -</f:subview> +</h:form>

13 years, 1 month

1
0
0 / 0

JBoss Rich Faces SVN: r22293 - modules/docs/trunk/Component_Reference/src/main/docbook/en-US.

by richfaces-svn-commits＠lists.jboss.org

Author: SeanRogers Date: 2011-03-22 21:49:02 -0400 (Tue, 22 Mar 2011) New Revision: 22293 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Introduction.xml Log: Revised Component Reference Introduction: RFPL-1380 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Introduction.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Introduction.xml 2011-03-22 19:34:17 UTC (rev 22292) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Introduction.xml 2011-03-23 01:49:02 UTC (rev 22293) @@ -7,19 +7,31 @@ This book is a guide to the various components available in the RichFaces 4.0 framework. It includes descriptions of the role of the components, details on how best to use them, coded examples of their use, and basic references of their properties and attributes. </para> <para> - For full in-depth references for all component classes and properties, refer to the <citetitle>API Reference</citetitle> available from the RichFaces website. + For full in-depth references for all component classes and properties, refer to the <citetitle>API Reference</citetitle>, <citetitle>JS Documentation</citetitle>, and <citetitle>VDL Documentation</citetitle> available from the RichFaces website. </para> <section id="sect-Component_Reference-Introduction-Libraries"> <title>Libraries</title> <para> - The RichFaces framework is made up of two tag libraries: the <classname>a4j</classname> library and the <classname>rich</classname> library. The <classname>a4j</classname> tag library represents Ajax4jsf, which provides page-level Ajax support with core Ajax components. This allows developers to make use of custom Ajax behavior with existing components. The <classname>rich</classname> tag library provides Ajax support at the component level instead, and includes ready-made, self-contained components. These components don't require additional configuration in order to send requests or update. + The RichFaces framework is made up of two tag libraries: the <classname>a4j</classname> library and the <classname>rich</classname> library. </para> - <note> - <title>Ajax support</title> - <para> - All components in the <classname>a4j</classname> library feature built-in Ajax support, so it is unnecessary to add the <sgmltag><a4j:support></sgmltag> behavior. - </para> - </note> + <variablelist> + <varlistentry> + <term><classname>a4j</classname> library</term> + <listitem> + <para> + The <classname>a4j</classname> tag library provides core Ajax and utility components. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><classname>rich</classname> library</term> + <listitem> + <para> + The <classname>rich</classname> tag library provides ready-made, self-contained, rich user-interface components. These components have built-in Ajax support. By default, the components don't require additional configuration in order to send requests or update, but can also be customized by plugging in utility behaviors. + </para> + </listitem> + </varlistentry> + </variablelist> </section> </chapter>

13 years, 1 month

1
0
0 / 0

JBoss Rich Faces SVN: r22292 - in branches/4.0.X: examples/validator-demo/src/main/webapp/examples and 1 other directories.

by richfaces-svn-commits＠lists.jboss.org

Author: alexsmirnov Date: 2011-03-22 15:34:17 -0400 (Tue, 22 Mar 2011) New Revision: 22292 Added: branches/4.0.X/examples/validator-demo/src/main/webapp/bg.jpg Modified: branches/4.0.X/examples/validator-demo/src/main/webapp/examples/clientAndajaxValidator.xhtml branches/4.0.X/ui/validator/ui/src/main/resources/META-INF/resources/org.richfaces/richfaces-csv.js Log: RESOLVED - issue RFPL-1352: CSV: some validators do not work ajax fallback with MyFaces https://issues.jboss.org/browse/RFPL-1352 Added: branches/4.0.X/examples/validator-demo/src/main/webapp/bg.jpg =================================================================== (Binary files differ) Property changes on: branches/4.0.X/examples/validator-demo/src/main/webapp/bg.jpg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: branches/4.0.X/examples/validator-demo/src/main/webapp/examples/clientAndajaxValidator.xhtml =================================================================== --- branches/4.0.X/examples/validator-demo/src/main/webapp/examples/clientAndajaxValidator.xhtml 2011-03-22 09:09:34 UTC (rev 22291) +++ branches/4.0.X/examples/validator-demo/src/main/webapp/examples/clientAndajaxValidator.xhtml 2011-03-22 19:34:17 UTC (rev 22292) @@ -25,13 +25,15 @@ <csv:message id="uiMessage" for="text" /> <h:outputLabel for="number" value="Four annotations for number"/> <h:inputText id="number" value="#{test.numbers}"> - <csv:validator /> + <csv:validator onbeforesubmit="alert('Before')"/> </h:inputText> <h:outputText id="outNum" value="#{test.numbers}"></h:outputText> <csv:message id="uiNumMessage" for="number" /> </h:panelGrid> <h:commandButton value="Submit form"/> - <a4j:commandButton value="AJAX Submit" render="out"/> + <h:graphicImage value="/bg.jpg"> + <a4j:ajax event="click" value="AJAX Submit" render="out" onbeforesubmit="alert('Before AJAX')"/> + </h:graphicImage> </h:form> <csv:messages /> </ui:define> Modified: branches/4.0.X/ui/validator/ui/src/main/resources/META-INF/resources/org.richfaces/richfaces-csv.js =================================================================== --- branches/4.0.X/ui/validator/ui/src/main/resources/META-INF/resources/org.richfaces/richfaces-csv.js 2011-03-22 09:09:34 UTC (rev 22291) +++ branches/4.0.X/ui/validator/ui/src/main/resources/META-INF/resources/org.richfaces/richfaces-csv.js 2011-03-22 19:34:17 UTC (rev 22292) @@ -107,9 +107,8 @@ } }; - var getValue = function(id) { + var getValue = function(element) { var value; - var element = rf.getDomElement(id); if (valueExtractors[element.type]) { value = valueExtractors[element.type](element); } else if(undefined !== element.value ){ @@ -150,7 +149,8 @@ rf.Event.fire(window.document, rf.Event.MESSAGE_EVENT_TYPE, {'sourceId':componentId }); }, validate: function (event, id, element, params) { - var value = getValue(element || id); + var element = rf.getDomElement(element || id); + var value = getValue(element); var convertedValue; var converter = params.c; rf.csv.clearMessage(id);

13 years, 1 month

1
0
0 / 0

JBoss Rich Faces SVN: r22291 - modules/tests/metamer/trunk/application/src/main/java/org/richfaces/tests/metamer/bean.

by richfaces-svn-commits＠lists.jboss.org

Author: ppitonak(a)redhat.com Date: 2011-03-22 05:09:34 -0400 (Tue, 22 Mar 2011) New Revision: 22291 Modified: modules/tests/metamer/trunk/application/src/main/java/org/richfaces/tests/metamer/bean/RichSelectBean.java Log: added a workaround for a bug with @ManagedProperty in MyFaces Modified: modules/tests/metamer/trunk/application/src/main/java/org/richfaces/tests/metamer/bean/RichSelectBean.java =================================================================== --- modules/tests/metamer/trunk/application/src/main/java/org/richfaces/tests/metamer/bean/RichSelectBean.java 2011-03-22 09:09:06 UTC (rev 22290) +++ modules/tests/metamer/trunk/application/src/main/java/org/richfaces/tests/metamer/bean/RichSelectBean.java 2011-03-22 09:09:34 UTC (rev 22291) @@ -27,7 +27,6 @@ import javax.annotation.PostConstruct; import javax.faces.bean.ManagedBean; -import javax.faces.bean.ManagedProperty; import javax.faces.bean.ViewScoped; import javax.faces.event.ValueChangeEvent; import javax.faces.model.SelectItem; @@ -54,7 +53,8 @@ private static final long serialVersionUID = -1L; private static Logger logger; private Attributes attributes; - @ManagedProperty(value = "#{model.capitals}") +// temporary fix because of a bug in MyFaces +// @ManagedProperty(value = "#{model.capitals}") private List<Capital> capitals; private List<SelectItem> capitalsOptions = null; private List<SelectItem> validationOptions = null; @@ -73,7 +73,9 @@ capitalsOptions = new ArrayList<SelectItem>(); validationOptions = new ArrayList<SelectItem>(); - for (Capital capital : capitals) { +// temporary fix because of a bug in MyFaces +// for (Capital capital : capitals) { + for (Capital capital : Model.unmarshallCapitals()) { capitalsOptions.add(new SelectItem(capital.getState(), capital.getState())); validationOptions.add(new SelectItem(capital.getState(), capital.getState())); }

13 years, 1 month

1
0
0 / 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

richfaces-svn-commits March 2011