[richfaces-svn-commits] JBoss Rich Faces SVN: r13313 - in trunk/docs/userguide/en/src/main/docbook: modules and 1 other directory.

Author: cluts Date: 2009-03-31 05:34:42 -0400 (Tue, 31 Mar 2009) New Revision: 13313 Modified: trunk/docs/userguide/en/src/main/docbook/included/a4j_page.xml trunk/docs/userguide/en/src/main/docbook/included/actionparam.xml trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml trunk/docs/userguide/en/src/main/docbook/included/commandButton.xml trunk/docs/userguide/en/src/main/docbook/included/include.xml trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml trunk/docs/userguide/en/src/main/docbook/included/poll.xml trunk/docs/userguide/en/src/main/docbook/included/portlet.xml trunk/docs/userguide/en/src/main/docbook/included/push.xml trunk/docs/userguide/en/src/main/docbook/included/region.xml trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml Log: RF-5117 - updated code samples for some chapters Modified: trunk/docs/userguide/en/src/main/docbook/included/a4j_page.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/a4j_page.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/included/a4j_page.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -41,14 +41,13 @@ <property>&lt;f:view&gt;:</property> </emphasis></para> <programlisting role="XML"><![CDATA[<f:view> - <a4j:page> - <f:facet name="head"> - <!--...Head Content here--> - </f:facet> - <!--...Page Content here--> - </a4j:page> -</f:view> -]]></programlisting> + <a4j:page> + <f:facet name="head"> + <!--...Head Content here--> + </f:facet> + <!--...Page Content here--> + </a4j:page> +</f:view>]]></programlisting> </section> <section> <title>Creating the Component Dynamically Using Java</title> @@ -59,8 +58,7 @@ <programlisting role="JAVA"><![CDATA[import org.ajax4jsf.component.html.HtmlPage; ... HtmlPage myPage = new HtmlPage(); -... -]]></programlisting> +...]]></programlisting> </section> <section> <title>Facets</title> @@ -115,8 +113,7 @@ <!--Head Content here--> </f:facet> <!--Page Content Here--> -</a4j:page> -]]></programlisting> +</a4j:page>]]></programlisting> <para>This structure is rendered as:</para> <para id="exampl"> Modified: trunk/docs/userguide/en/src/main/docbook/included/actionparam.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/actionparam.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/included/actionparam.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -71,13 +71,13 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... - <script> - ... - var foo = "bar"; - ... - </script> - ... - <a4j:actionparam noEscape="true" name="param1" value="foo" assignTo="#{bean.prop1}" /> +<script> + ... + var foo = "bar"; + ... +</script> +... +<a4j:actionparam noEscape="true" name="param1" value="foo" assignTo="#{bean.prop1}" /> ...]]></programlisting> <para> The <emphasis role="bold"><property>&lt;a4j:param&gt;</property></emphasis> extends Modified: trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -59,12 +59,10 @@ } ]]></programlisting> - <programlisting role="JAVA"><![CDATA[ -import demo.ImplBean; + <programlisting role="JAVA"><![CDATA[import demo.ImplBean; ... ImplBean myListener = new ImplBean(); -... -]]></programlisting> +...]]></programlisting> </section> @@ -88,18 +86,17 @@ </para> <programlisting role="XML"><![CDATA[... - <a4j:commandLink id="cLink" value="Click it To Send Ajax Request"> - <a4j:ajaxListener type="demo.Bean"/> - </a4j:commandLink> -... -]]></programlisting> +<a4j:commandLink id="cLink" value="Click it To Send Ajax Request"> + <a4j:ajaxListener type="demo.Bean"/> +</a4j:commandLink> +...]]></programlisting> <para> <emphasis role="bold">Example:</emphasis> </para> <programlisting role="JAVA"><![CDATA[package demo; - + import org.ajax4jsf.event.AjaxEvent; public class Bean implements org.ajax4jsf.event.AjaxListener{ @@ -108,8 +105,7 @@ //Custom Developer Code } ... -} -]]></programlisting> +}]]></programlisting> </section> <section> Modified: trunk/docs/userguide/en/src/main/docbook/included/commandButton.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/commandButton.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/included/commandButton.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -54,8 +54,7 @@ <programlisting role="JAVA"><![CDATA[import org.ajax4jsf.component.html.HtmlAjaxCommandButton; ... HtmlAjaxCommandButton myButton = new HtmlAjaxCommandButton(); -... -]]></programlisting> +...]]></programlisting> </section> <section> <title>Key attributes and ways of usage</title> @@ -77,12 +76,9 @@ </para> <programlisting role="XML"><![CDATA[... <h:form id="form"> - <a4j:commandButton id="cbutton" action="director.rollCamera" - onclick="this.disabled=true" - oncomplete="this.disabled=false" /> + <a4j:commandButton id="cbutton" action="director.rollCamera" onclick="this.disabled=true" oncomplete="this.disabled=false" /> </h:form> -... -]]></programlisting> +...]]></programlisting> <para> Otherwise if the <property>commandButton</property> contained in re-rendered region the <emphasis><property>&quot;oncomplete&quot;</property></emphasis> attribute has a problem obtaining a reference of the <property>commandButton</property> object @@ -90,12 +86,11 @@ </para> <programlisting role="XML"><![CDATA[... <h:form id="form"> -<a4j:commandButton id="cbutton" action="director.rollCamera" + <a4j:commandButton id="cbutton" action="director.rollCamera" onclick="this.disabled=true" oncomplete="document.getElementById('form:cbutton').disabled=false" /> </h:form> -... -]]></programlisting> +...]]></programlisting> <para>Common JSF navigation could be performed after an Ajax submit and partial rendering, but Navigation Case must be defined as <emphasis role="bold"><property>&lt;redirect/&gt;</property></emphasis> in order to avoid problems with some browsers.</para> <para>As any Core Ajax component sending Ajax requests and processing server responses <emphasis role="bold"><property>&lt;a4j:commandButton&gt;</property></emphasis> has all attributes described above Modified: trunk/docs/userguide/en/src/main/docbook/included/include.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/include.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/included/include.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -44,8 +44,7 @@ </para> <programlisting role="XML"><![CDATA[<h:panelGroup id="wizard"> <a4j:include viewId="/pages/include/first.xhtml" /> -</h:panelGroup> -]]></programlisting> +</h:panelGroup>]]></programlisting> <para>For navigation inside a page defined in viewId any components responsible for Ajax requests to the server generation are used.</para> <para>For example, the following component on a page <code>&quot;/pages/include/first.xhtml&quot;</code></para> @@ -54,21 +53,19 @@ </para> <programlisting role="XML"><![CDATA[... <a4j:commandButton action="next" reRender="wizard"/> -... -]]></programlisting> +...]]></programlisting> <para>And in faces-config it&apos;s defined:</para> <para> <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[<navigation-rule> - <from-view-id>/pages/include/first.xhtml</from-view-id> - <navigation-case> - <from-outcome>next</from-outcome> - <to-view-id>/pages/include/second.xhtml</to-view-id> - </navigation-case> - </navigation-rule> -]]></programlisting> + <from-view-id>/pages/include/first.xhtml</from-view-id> + <navigation-case> + <from-outcome>next</from-outcome> + <to-view-id>/pages/include/second.xhtml</to-view-id> + </navigation-case> +</navigation-rule>]]></programlisting> <para>In this case after a click on a button defined inside <code>&quot;first.xhtml&quot;</code> view, navigation is performed after an Ajax request (the same as standard JSF one) only inside this view.</para> </section> <section> Modified: trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -49,8 +49,10 @@ </script> </head> <body> -... -<a4j:jsFunction data="#{bean.someProperty}" name="callScript" oncomplete="myScript(data.subProperty1, data.subProperty2)"/> + ... + <a4j:jsFunction data="#{bean.someProperty}" name="callScript" oncomplete="myScript(data.subProperty1, data.subProperty2)"/> + ... +</body> ...]]> </programlisting> <para> The script <code>&quot;myScript&quot;</code> is called after @@ -66,8 +68,7 @@ <programlisting role="JAVA"><![CDATA[import org.ajax4jsf.component.html.HtmlajaxFunction; ... HtmlajaxFunction myFunction = new HtmlajaxFunction(); -... -]]></programlisting> +...]]></programlisting> </section> <section> <title>Key attributes and ways of usage</title> @@ -83,12 +84,12 @@ <body onload="callScript()"> ... <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="callScript" data="#{bean.someProperty1}" + reRender="someComponent" oncomplete="myScript(data.subProperty1, data.subProperty2)"> + <a4j:actionparam name="param_name" assignTo="#{bean.someProperty2}"/> + </a4j:jsFunction> + ... </h:form> ... </body> Modified: trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -90,8 +90,7 @@ a legal JSF EL expression which resolves to a managed mean instance. For example for the above code the class definition may look like this one: </para> - <programlisting role="JAVA"><![CDATA[ -class MyClass{ + <programlisting role="JAVA"><![CDATA[class MyClass{ ... private TestBean testBean; // Getters and Setters for testBean. Modified: trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -52,14 +52,12 @@ <para> <emphasis role="bold">Example:</emphasis> </para> - <programlisting role="XML"><![CDATA[ <a4j:outputPanel> - <h:form> - <h:outputText value="Some text"/> - <h:inputText id="text1" label="text1" value="#{rsBean.text1}"> - </h:inputText> - </h:form> - </a4j:outputPanel> -]]></programlisting> + <programlisting role="XML"><![CDATA[<a4j:outputPanel> + <h:form> + <h:outputText value="Some text"/> + <h:inputText id="text1" label="text1" value="#{rsBean.text1}"/> + </h:form> +</a4j:outputPanel>]]></programlisting> </section> <section> <title>Creating the Component Dynamically Using Java</title> @@ -69,8 +67,7 @@ </para> <programlisting role="JAVA"><![CDATA[import org.ajax4jsf.component.html.HtmlAjaxOutputPanel; ... -HtmlAjaxOutputPanel myPanel = new HtmlAjaxOutputPanel(); -]]></programlisting> +HtmlAjaxOutputPanel myPanel = new HtmlAjaxOutputPanel();]]></programlisting> </section> <section> <title>Key attributes and ways of usage</title> @@ -102,11 +99,10 @@ <programlisting role="XML"><![CDATA[<a4j:support ... reRender="mypanel"/> ... <a4j:outputPanel id="mypanel"> - <h:panelGrid rendered="#{not empty foo.bar}"> - ... - </h:panelGrid> -</a4j:outputPanel> -]]></programlisting> + <h:panelGrid rendered="#{not empty foo.bar}"> + ... + </h:panelGrid> +</a4j:outputPanel>]]></programlisting> <para> In addition to the areas directly indicated in <emphasis> @@ -128,9 +124,8 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[<a4j:outputPanel ajaxRendered="true"> - <h:messages/> -</a4j:outputPanel> -]]></programlisting> + <h:messages/> +</a4j:outputPanel>]]></programlisting> <para> On default <emphasis role="bold"> @@ -195,11 +190,10 @@ <programlisting role="XML"><![CDATA[<a4j:support .... reRender="mypanel"/> ... <a4j:outputPanel layout="none"> - <h:panelGrid id="mypanel" rendered="#{not empty foo.bar}"> - ... - </h:panelGrid> -</a4j:outputPanel> -]]></programlisting> + <h:panelGrid id="mypanel" rendered="#{not empty foo.bar}"> + ... + </h:panelGrid> +</a4j:outputPanel>]]></programlisting> <para> As you see, the code is very similar to the one shown above, but Modified: trunk/docs/userguide/en/src/main/docbook/included/poll.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/poll.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/included/poll.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -60,8 +60,7 @@ <programlisting role="JAVA"><![CDATA[import org.ajax4jsf.component.html.AjaxPoll; ... AjaxPoll myPoll = new AjaxPoll(); -... -]]></programlisting> +...]]></programlisting> </section> <section> <title>Key attributes and ways of usage</title> @@ -106,28 +105,27 @@ </para> <programlisting role="XML"><![CDATA[... - <a4j:region> - <h:form> +<a4j:region> + <h:form> <a4j:poll id="poll" interval="1000" enabled="#{userBean.pollEnabled}" reRender="poll,grid"/> - </h:form> - </a4j:region> - <h:form> - <h:panelGrid columns="2" width="80%" id="grid"> - <h:panelGrid columns="1"> - <h:outputText value="Polling Inactive" rendered="#{not userBean.pollEnabled}"></h:outputText> - <h:outputText value="Polling Active" rendered="#{userBean.pollEnabled}"></h:outputText> + </h:form> +</a4j:region> +<h:form> + <h:panelGrid columns="2" width="80%" id="grid"> + <h:panelGrid columns="1"> + <h:outputText value="Polling Inactive" rendered="#{not userBean.pollEnabled}" /> + <h:outputText value="Polling Active" rendered="#{userBean.pollEnabled}" /> <a4j:commandButton style="width:120px" id="control" - value="#{userBean.pollEnabled?'Stop':'Start'} Polling" - reRender="poll, grid"> - <a4j:actionparam name="polling" value="#{!userBean.pollEnabled}" - assignTo="#{userBean.pollEnabled}"/> + value="#{userBean.pollEnabled?'Stop':'Start'} Polling" + reRender="poll, grid"> + <a4j:actionparam name="polling" value="#{!userBean.pollEnabled}" + assignTo="#{userBean.pollEnabled}"/> </a4j:commandButton> - </h:panelGrid> - <h:outputText id="serverDate" style="font-size:16px" value="Server Date: #{userBean.date}"/> - </h:panelGrid> - </h:form> -... -]]></programlisting> + </h:panelGrid> + <h:outputText id="serverDate" style="font-size:16px" value="Server Date: #{userBean.date}"/> + </h:panelGrid> +</h:form> +...]]></programlisting> <para>The example shows how date and time are updated on a page in compliance with data taken from a server. The <emphasis role="bold"> Modified: trunk/docs/userguide/en/src/main/docbook/included/portlet.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/portlet.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/included/portlet.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -34,13 +34,11 @@ <section> <title>Creating the Component with a Page Tag</title> <para>To create the simplest variant on a page use the following syntax:</para> - <programlisting role="XML"><![CDATA[ -<f:view> - <a4j:portlet> - ... - </a4j:portlet> -</f:view> -]]></programlisting> + <programlisting role="XML"><![CDATA[<f:view> + <a4j:portlet> + ... + </a4j:portlet> +</f:view>]]></programlisting> </section> <section> Modified: trunk/docs/userguide/en/src/main/docbook/included/push.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/push.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/included/push.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -80,8 +80,8 @@ System.out.println(evt.getSource()); //Some action } -... -]]></programlisting> +} +...]]></programlisting> <para>Code for <code>EventListener</code> registration in the bean is placed below:</para> @@ -91,11 +91,12 @@ <programlisting role="JAVA"><![CDATA[... public void addListener(EventListener listener) { synchronized (listener) { - if (this.listener != listener) { - this.listener = (PushEventListener) listener; + if (this.listener != listener) { + this.listener = (PushEventListener) listener; + } + } } -... -]]></programlisting> +...]]></programlisting> <para>A page code for this example is placed below.</para> @@ -103,20 +104,19 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... - <a4j:status startText="in progress" stopText="done"/> +<a4j:status startText="in progress" stopText="done"/> <a4j:form> - <a4j:region> - <a4j:push reRender="msg" eventProducer="#{pushBean.addListener}" interval="2000"/> - </a4j:region> - <a4j:outputPanel id="msg" > - <h:outputText value="#{pushBean.date}"> - <f:convertDateTime type="time"/> - </h:outputText> - </a4j:outputPanel> - <a4j:commandButton value="Push!!" action="#{pushBean.push}" ajaxSingle="true"/> - </a4j:form> -... -]]></programlisting> + <a4j:region> + <a4j:push reRender="msg" eventProducer="#{pushBean.addListener}" interval="2000"/> + </a4j:region> + <a4j:outputPanel id="msg" > + <h:outputText value="#{pushBean.date}"> + <f:convertDateTime type="time"/> + </h:outputText> + </a4j:outputPanel> + <a4j:commandButton value="Push!!" action="#{pushBean.push}" ajaxSingle="true"/> +</a4j:form> +...]]></programlisting> <para>The example shows how date is updated on a page in compliance with data taken from a server. In the example <emphasis> Modified: trunk/docs/userguide/en/src/main/docbook/included/region.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/region.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/included/region.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -38,11 +38,11 @@ <section> <title>Creating on a page</title> <para>Here is an example of the region decoding on a page. </para> - <programlisting role="XML"><![CDATA[ <a4j:region> - <h:inputText value="#{userBean.name}"> - <a4j:support event="onkeyup" reRender="outname" /> - </h:inputText> - </a4j:region>]]></programlisting> + <programlisting role="XML"><![CDATA[<a4j:region> + <h:inputText value="#{userBean.name}"> + <a4j:support event="onkeyup" reRender="outname" /> + </h:inputText> +</a4j:region>]]></programlisting> </section> <section> <title>Creating the Component Dynamically Using Java</title> @@ -53,8 +53,7 @@ <programlisting role="JAVA"><![CDATA[import org.ajax4jsf.component.html.HtmlAjaxRegion; ... HtmlAjaxRegion newRegion = new HtmlAjaxRegion(); -... -]]></programlisting> +...]]></programlisting> </section> <section> <title>Key attributes and ways of usage</title> @@ -72,10 +71,10 @@ </itemizedlist></para> <para><emphasis role="bold">Example:</emphasis></para> <programlisting role="XML"><![CDATA[<h:form id="form1"> - <a4j:region> - <a4j:commandLink reRender="someID" value="Link" id="link1"/> - <!--..Some content that will be decoded on server after Ajax request.--> - </a4j:region> + <a4j:region> + <a4j:commandLink reRender="someID" value="Link" id="link1"/> + <!--..Some content that will be decoded on server after Ajax request.--> + </a4j:region> <h:form>]]></programlisting> <para>Hence, the <emphasis role="bold"> <property>&lt;a4j:commandLink&gt;</property> @@ -83,12 +82,12 @@ <para>The regions could be nested in any order, the server picks out and decodes only the region, which contains a particular component that sends a request.</para> <para><emphasis role="bold">Example:</emphasis></para> <programlisting role="XML"><![CDATA[<a4j:region> - <a4j:commandLink reRender="someID" value="Link" id="link1"/> - <a4j:region> - <a4j:commandLink reRender="someID" value="Link" id="link2"/> - <!--..Some content that will be decoded on server after Ajax request.--> - </a4j:region > - <!--..Some content that will be decoded on server after Ajax request.--> + <a4j:commandLink reRender="someID" value="Link" id="link1"/> + <a4j:region> + <a4j:commandLink reRender="someID" value="Link" id="link2"/> + <!--..Some content that will be decoded on server after Ajax request.--> + </a4j:region > + <!--..Some content that will be decoded on server after Ajax request.--> </a4j:region >]]></programlisting> <para>Therefore, the external region is decoded for the <code>&quot;link1&quot;</code> and the internal one is decoded for the <code>&quot;link2&quot;</code>.</para> <para>RichFaces allows setting Ajax responses rendering directly basing on component tree nodes without referring to the JSP (XHTML) page code. It could be defined by<emphasis><property> &quot;selfRendered&quot; </property></emphasis>attribute setting to &quot;true&quot; on <emphasis role="bold"> @@ -99,8 +98,8 @@ </para> <para><emphasis role="bold">Example:</emphasis></para> <programlisting role="XML"><![CDATA[<a4j:region selfRendered ="true"> - <a4j:commandLink reRender="someID" value="Link" id="link1"/> - <!--..Some content with HTML used ("br","h1" and other tags used)--> + <a4j:commandLink reRender="someID" value="Link" id="link1"/> + <!--..Some content with HTML used ("br","h1" and other tags used)--> </a4j:region >]]></programlisting> <para>In this case, the processing is quicker and going on without referring to a page code, but the HTML code that isn&apos;t saved in a component tree could be lost. Thus, this optimization should be very carefully performed and a usage of the additional components RichFaces (<emphasis role="bold"><property>&lt;a4j:outputPanel&gt;</property></emphasis>) is required. </para> <para>The processing could be also accelerated if a region decoded for the processing passes straight away into Encode. But to update some data out of the region or on another region, use the <emphasis > @@ -109,14 +108,12 @@ attribute set to &quot;false&quot; (&quot;true&quot; on default) to change this behaviour.</para> <para><emphasis role="bold">Example:</emphasis></para> <programlisting role="XML"><![CDATA[<a4j:region renderRegionOnly="true"> - <a4j:commandLink reRender="someID2" value="Link1" id="link1"/> - <h:panelGroup id="someId1"> - </h:panelGroup> + <a4j:commandLink reRender="someID2" value="Link1" id="link1"/> + <h:panelGroup id="someId1" /> </a4j:region> <a4j:region renderRegionOnly="false"> - <a4j:commandLink reRender="someID1" value="Link2" id="link2"/> - <h:panelGroup id="someId1"> - </h:panelGroup> + <a4j:commandLink reRender="someID1" value="Link2" id="link2"/> + <h:panelGroup id="someId1" /> </a4j:region>]]></programlisting> <para>This example shows that one of the regions is decoded when a link is used inside. Nevertheless, if after processing the <code>&quot;link1&quot;</code> is clicked, the first region passes into Encode as a root Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -87,11 +87,12 @@ <para> <emphasis role="bold">Example:</emphasis> </para> - <programlisting role="XML"> - &lt;context-param&gt; - &lt;param-name&gt;org.ajax4jsf.VIEW_HANDLERS&lt;/param-name&gt; - &lt;param-value&gt;com.sun.facelets.FaceletViewHandler&lt;/param-value&gt; - &lt;/context-param&gt; + <programlisting role="XML"><![CDATA[... + <context-param> + <param-name>org.ajax4jsf.VIEW_HANDLERS</param-name> + <param-value>com.sun.facelets.FaceletViewHandler</param-value> + </context-param> +...]]> </programlisting> <para> says that <property>Facelets</property> will officially be the first, however <code>AjaxViewHandler</code> will be a little ahead @@ -275,7 +276,7 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... - <servlet> + <servlet> <servlet-name>Faces Servlet</servlet-name> <servlet-class>javax.faces.webapp.FacesServlet</servlet-class> <load-on-startup>0</load-on-startup> Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml 2009-03-30 23:18:08 UTC (rev 13312) +++ trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml 2009-03-31 09:34:42 UTC (rev 13313) @@ -222,13 +222,12 @@ </emphasis> attribute is an id of the JSF component or an id list. </para> <para>A simple example is placed below:</para> <programlisting role="XML"><![CDATA[... - <a4j:commandButton value="update" reRender="infoBlock"/> - ... - <h:panelGrid id="infoBlock"> - ... - </h:panelGrid> +<a4j:commandButton value="update" reRender="infoBlock"/> ... -]]></programlisting> +<h:panelGrid id="infoBlock"> + ... +</h:panelGrid> +...]]></programlisting> <para> The value of <emphasis> <property>&quot;reRender&quot;</property> </emphasis> attribute of the <emphasis role="bold"> @@ -254,24 +253,23 @@ it more precisely. The following example shows the difference in approaches (both buttons will work successfully): </para> <programlisting role="XML"><![CDATA[... - <h:form id="form1"> - ... - <a4j: commandButton value="Usual Way" reRender="infoBlock, infoBlock2" /> - <a4j:commandButton value="Shortcut" reRender=":infoBlockl,:sv:infoBlock2" /> - ... - </h:form> - <h:panelGrid id="infoBlock"> - ... - </h:panelGrid> +<h:form id="form1"> + ... + <a4j: commandButton value="Usual Way" reRender="infoBlock, infoBlock2" /> + <a4j:commandButton value="Shortcut" reRender=":infoBlockl,:sv:infoBlock2" /> ... - <f:subview id="sv"> - <h:panelGrid id="infoBlock2"> - ... - </h:panelGrid> - ... - </f:subview> +</h:form> +<h:panelGrid id="infoBlock"> + ... +</h:panelGrid> ... -]]></programlisting> +<f:subview id="sv"> + <h:panelGrid id="infoBlock2"> + ... + </h:panelGrid> + ... +</f:subview> +...]]></programlisting> <para> It&apos;s also possible to use JSF EL expression as a value of the reRender attribute. It might be a property of types Set, Collection, Array or simple String. The EL for reRender is resolved right before the Render Response phase. Hence, you @@ -304,11 +302,10 @@ on any Ajax request. For example, the following code allows to output error messages regardless of what Ajax request causes the Validation phase failed. </para> <programlisting role="XML"><![CDATA[... - <a4j:outputPanel ajaxRendered="true"> - <h:messages /> - </a4j:outputPanel> -... -]]></programlisting> +<a4j:outputPanel ajaxRendered="true"> + <h:messages /> +</a4j:outputPanel> +...]]></programlisting> <para> <emphasis> <property>&quot;limitToList&quot;</property> @@ -324,14 +321,13 @@ <code>ajaxRendered=&quot;true&quot;</code> is ignored. An example is placed below: </para> <programlisting role="XML"><![CDATA[... - <h:form> - <h:inputText value="#{person.name}"> - <a4j:support event="onkeyup" reRender="test" limitToList="true"/> - </h:inputText> - <h:outputText value="#{person.name}" id="test"/> - </form> -... -]]></programlisting> +<h:form> + <h:inputText value="#{person.name}"> + <a4j:support event="onkeyup" reRender="test" limitToList="true"/> + </h:inputText> + <h:outputText value="#{person.name}" id="test"/> +</form> +...]]></programlisting> </section> <section id="QueueandTrafficFloodProtection"> <?dbhtml filename="QueueandTrafficFloodProtection.html"?> @@ -356,11 +352,10 @@ newest request will be sent to the server if you type very fast and has typed the several characters already before the previous Ajax Response is back. </para> <programlisting role="XML"><![CDATA[... - <h:inputText value="#{userBean.name}"> - <a4j:support event="onkeyup" eventsQueue="foo" reRender="bar" /> - </h:inputText> -... -]]></programlisting> +<h:inputText value="#{userBean.name}"> + <a4j:support event="onkeyup" eventsQueue="foo" reRender="bar" /> +</h:inputText> +...]]></programlisting> <para> <emphasis> <property>&quot;requestDelay&quot;</property> @@ -501,8 +496,7 @@ view using the following:</para> <programlisting role="XML"><![CDATA[... <a4j:queue name="org.richfaces.global_queue" disabled="true"... /> -... -]]></programlisting> +...]]></programlisting> <para>Hence, to enable the queue for a single view page you need to define the <property>&quot;disable&quot;</property> attribute with &quot;false&quot;. </para> @@ -523,8 +517,7 @@ the forms in order not to be recognized as a form-based queue. </para> <programlisting role="XML"><![CDATA[... <a4j:queue ... /> -... -]]></programlisting> +...]]></programlisting> </section> <section> <title>View scoped named queue</title> @@ -550,12 +543,10 @@ <programlisting role="XML"><![CDATA[... <a4j:queue name="sampleQueue"/> - <h:inputText value="#{bean.inputValue}" > -<a4j:support id="inputSupport" event="onkeyup" eventsQueue="sample"/> + <a4j:support id="inputSupport" event="onkeyup" eventsQueue="sample"/> </h:inputText> <rich:comboBox value="#{bean.state}" suggestionValues="#{bean.suggestions}" eventsQueue="sample" /> - ...]]></programlisting> <para>In this example, two components(&lt;a4j:queue&gt;, &lt;rich:comboBox&gt;,) reference the named queue via the @@ -589,8 +580,8 @@ </para> <programlisting role="XML"><![CDATA[... <h:form ... > -<a4j:queue ... /><!-- note no name specified --> - ... + <a4j:queue ... /><!-- note no name specified --> + ... </h:form> ...]]></programlisting> @@ -601,7 +592,7 @@ </para> <programlisting role="XML"><![CDATA[... <a4j:form eventsQueue="fooQueue" ...> - ... + ... </a4j:form> ...]]></programlisting> <para>However the implementation of the queue allows you to reference a named queue from the form with a form-based queue.</para> @@ -614,9 +605,9 @@ <a4j:queue name="sampleQueue" ... /> <!-- named queue --> ... <h:form ... > - <a4j:queue ... /><!-- form-based queue--> - <a4j:commandButton ... > <!-- uses the form-based queue --> - <a4j:commandButton eventsQueue="sampleQueue" > <!-- uses named queue --> + <a4j:queue ... /><!-- form-based queue--> + <a4j:commandButton ... /> <!-- uses the form-based queue --> + <a4j:commandButton eventsQueue="sampleQueue" /> <!-- uses named queue --> </h:form> ...]]></programlisting> @@ -742,14 +733,13 @@ <property>&lt;a4j:support&gt;</property> </emphasis> , it is a value of the parent component. An example is placed below: </para> <programlisting role="XML"><![CDATA[... - <h:form> - <h:inputText value="#{person.name}"> - <a4j:support event="onkeyup" reRender="test" ajaxSingle="true"/> - </h:inputText> - <h:inputText value="#{person.middleName}"/> - </form> -... -]]></programlisting> +<h:form> + <h:inputText value="#{person.name}"> + <a4j:support event="onkeyup" reRender="test" ajaxSingle="true"/> + </h:inputText> + <h:inputText value="#{person.middleName}"/> +</form> +...]]></programlisting> <para> In this example the request contains only the input component causes the request generation, not all the components contained on a form, because of <code>ajaxSingle=&quot;true&quot;</code> usage. </para> @@ -869,9 +859,8 @@ &quot;true&quot; or &quot;false&quot; , use the conditional statement to return something only when you need to cancel the request. For example: </para> <programlisting role="XML"><![CDATA[... - onsubmit="if (mynosendfunct()==false){return false}" -... -]]></programlisting> +onsubmit="if (mynosendfunct()==false){return false}" +...]]></programlisting> <para> <emphasis> <property>&quot;onclick&quot;</property> @@ -903,9 +892,8 @@ <property>&quot;data&quot;</property> </emphasis> variable. For example: </para> <programlisting role="XML"><![CDATA[... - <a4j:commandButton value="Update" data="#{userBean.name}" oncomplete="showTheName(data.name)" /> -... -]]></programlisting> +<a4j:commandButton value="Update" data="#{userBean.name}" oncomplete="showTheName(data.name)" /> +...]]></programlisting> <para> RichFaces allows to serialize not only primitive types into JSON format, but also complex types including arrays and collections. The beans should be serializable to be refered with <emphasis> @@ -936,7 +924,7 @@ taking the short ID of the component as a parameter. </para> <programlisting role="XML"><![CDATA[... <h:inputText id="myInput"> - <a4j:support event="onkeyup" reRender="outtext"/> + <a4j:support event="onkeyup" reRender="outtext"/> </h:inputText> <h:outputText id="outtext" value="#{rich:findComponent('myInput').value}" /> ...]]></programlisting> @@ -953,21 +941,20 @@ provides possibility to update several child components separately without updating the whole page. </para> <programlisting role="XML"><![CDATA[... - <a4j:poll intervall="1000" action="#{repeater.action}" reRender="text"> - <table> - <tbody> - <a4j:repeat value="#{bean.props}" var="detail" ajaxKeys="#{repeater.ajaxedRowsSet}"> - <tr> - <td> - <h:outputText value="detail.someProperty" id="text"/> - </td> - </tr> - </a4j:repeat> - </tbody> - </table> - </a4j:poll> -... -]]></programlisting> +<a4j:poll intervall="1000" action="#{repeater.action}" reRender="text"> + <table> + <tbody> + <a4j:repeat value="#{bean.props}" var="detail" ajaxKeys="#{repeater.ajaxedRowsSet}"> + <tr> + <td> + <h:outputText value="detail.someProperty" id="text"/> + </td> + </tr> + </a4j:repeat> + </tbody> + </table> +</a4j:poll> +...]]></programlisting> </section> <section id="Otherusefulattributes"> <?dbhtml filename="Otherusefulattributes.html"?> @@ -987,35 +974,33 @@ </emphasis> component between different Ajax components from different regions. The following example shows it. </para> <programlisting role="XML"><![CDATA[... - <a4j:region id="extr"> - <h:form> - <h:outputText value="Status:" /> - <a4j:status id="commonstatus" startText="In Progress...." stopText=""/> - <h:panelGrid columns="2"> - <h:outputText value="Name"/> - <h:inputText id="name" value="#{userBean.name}"> - <a4j:support event="onkeyup" reRender="out" /> +<a4j:region id="extr"> + <h:form> + <h:outputText value="Status:" /> + <a4j:status id="commonstatus" startText="In Progress...." stopText=""/> + <h:panelGrid columns="2"> + <h:outputText value="Name"/> + <h:inputText id="name" value="#{userBean.name}"> + <a4j:support event="onkeyup" reRender="out" /> + </h:inputText> + <h:outputText value="Job"/> + <a4j:region id="intr"> + <h:inputText id="job" value="#{userBean.job}"> + <a4j:support event="onkeyup" reRender="out" status="commonstatus"/> </h:inputText> - <h:outputText value="Job"/> - <a4j:region id="intr"> - <h:inputText id="job" value="#{userBean.job}"> - <a4j:support event="onkeyup" reRender="out" status="commonstatus"/> - </h:inputText> - </a4j:region> - </h:panelGrid> - - <a4j:region> - <h:outputText id="out" value="Name: #{userBean.name}, Job: #{userBean.job}" /> - <br /> - <a4j:commandButton ajaxSingle="true" value="Clean Up Form" reRender="name, job, out" status="commonstatus"> - <a4j:actionparam name="n" value="" assignTo="#{userBean.name}" /> - <a4j:actionparam name="j" value="" assignTo="#{userBean.job}" /> - </a4j:commandButton> </a4j:region> - </h:form> - </a4j:region> -... -]]></programlisting> + </h:panelGrid> + <a4j:region> + <h:outputText id="out" value="Name: #{userBean.name}, Job: #{userBean.job}" /> + <br /> + <a4j:commandButton ajaxSingle="true" value="Clean Up Form" reRender="name, job, out" status="commonstatus"> + <a4j:actionparam name="n" value="" assignTo="#{userBean.name}" /> + <a4j:actionparam name="j" value="" assignTo="#{userBean.job}" /> + </a4j:commandButton> + </a4j:region> + </h:form> +</a4j:region> +...]]></programlisting> <para> In the example <emphasis role="bold"> <property>&lt;a4j:support&gt;</property> </emphasis> and <emphasis role="bold"> @@ -1306,13 +1291,12 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... - <filter> - <display-name>RichFaces Filter</display-name> - <filter-name>richfaces</filter-name> - <filter-class>org.ajax4jsf.Filter</filter-class> - </filter> -... -]]></programlisting> +<filter> + <display-name>RichFaces Filter</display-name> + <filter-name>richfaces</filter-name> + <filter-class>org.ajax4jsf.Filter</filter-class> +</filter> +...]]></programlisting> <note> <title>Note:</title> <para> Fast Filter is deprecated and available only for backward compatibility with @@ -1352,50 +1336,43 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... - <context-param> - <param-name>org.ajax4jsf.xmlparser.ORDER</param-name> - <param-value>NONE,NEKO,TIDY</param-value> - </context-param> - - <context-param> - <param-name>org.ajax4jsf.xmlparser.NONE</param-name> - <param-value>/pages/performance\.xhtml,/pages/default.*\.xhtml</param-value> - </context-param> - - <context-param> - <param-name>org.ajax4jsf.xmlparser.NEKO</param-name> - <param-value>/pages/repeat\.xhtml</param-value> - </context-param> - - <filter> - <display-name>RichFaces Filter</display-name> - <filter-name>richfaces</filter-name> - <filter-class>org.ajax4jsf.Filter</filter-class> - </filter> - - <filter-mapping> - <filter-name>richfaces</filter-name> - <servlet-name>Faces Servlet</servlet-name> - <dispatcher>FORWARD</dispatcher> - <dispatcher>REQUEST</dispatcher> - <dispatcher>INCLUDE</dispatcher> - </filter-mapping> -... -]]></programlisting> +<context-param> + <param-name>org.ajax4jsf.xmlparser.ORDER</param-name> + <param-value>NONE,NEKO,TIDY</param-value> +</context-param> +<context-param> + <param-name>org.ajax4jsf.xmlparser.NONE</param-name> + <param-value>/pages/performance\.xhtml,/pages/default.*\.xhtml</param-value> +</context-param> +<context-param> + <param-name>org.ajax4jsf.xmlparser.NEKO</param-name> + <param-value>/pages/repeat\.xhtml</param-value> +</context-param> +<filter> + <display-name>RichFaces Filter</display-name> + <filter-name>richfaces</filter-name> + <filter-class>org.ajax4jsf.Filter</filter-class> +</filter> +<filter-mapping> + <filter-name>richfaces</filter-name> + <servlet-name>Faces Servlet</servlet-name> + <dispatcher>FORWARD</dispatcher> + <dispatcher>REQUEST</dispatcher> + <dispatcher>INCLUDE</dispatcher> +</filter-mapping> +...]]></programlisting> <para> The example shows that <code>ORDER</code> parameter defines the order in which particular filter types are used for pages code correction. </para> <para> First of all &quot;NONE&quot; type is specified for the filter. Then two different sets of pages are defined for which two filter types (NONE and NEKO) are used correspondingly. If a page relates to the first set that is defined in the following way: </para> - <programlisting role="XML"><![CDATA[<param-value>/pages/performance\.xhtml,/pages/default.*\.xhtml</param-value>, -]]></programlisting> + <programlisting role="XML"><![CDATA[<param-value>/pages/performance\.xhtml,/pages/default.*\.xhtml</param-value>]]></programlisting> <para> it&apos;s not corrected, because filter type for this page is defined as &quot;NONE&quot;. If a page is not from the first set, then &quot;NEKO&quot; type is set. </para> <para> If a page relates to the second set that is defined in the following way: </para> - <programlisting role="XML"><![CDATA[<param-value>/pages/repeat\.xhtml</param-value>, -]]></programlisting> + <programlisting role="XML"><![CDATA[<param-value>/pages/repeat\.xhtml</param-value>]]></programlisting> <para> then &quot;NEKO&quot; filter type is used for correction. If it&apos;s not related to the second set, &quot;TIDY&quot; type is set for the filter (&quot;TIDY&quot; filter type is used for code correction). </para> @@ -1412,21 +1389,19 @@ </para> <para> The following declaration in your web.xml allows loading the integrated script files. </para> <programlisting role="XML"><![CDATA[... - <context-param> - <param-name>org.richfaces.LoadScriptStrategy</param-name> - <param-value>ALL</param-value> - </context-param> -... -]]></programlisting> +<context-param> + <param-name>org.richfaces.LoadScriptStrategy</param-name> + <param-value>ALL</param-value> +</context-param> +...]]></programlisting> <para> If you do not declare the <code>org.richfaces.LoadScriptStrategy</code> in the web.xml, it equals to: </para> <programlisting role="XML"><![CDATA[... - <context-param> - <param-name>org.richfaces.LoadScriptStrategy</param-name> - <param-value>DEFAULT</param-value> - </context-param> -... -]]></programlisting> +<context-param> + <param-name>org.richfaces.LoadScriptStrategy</param-name> + <param-value>DEFAULT</param-value> +</context-param> +...]]></programlisting> <para> The third possible value is &quot;NONE&quot;. You have no a special reason to use it unless you obtain the newest (or modified) version of the script and want to include it manually in a page header. </para> @@ -1447,12 +1422,11 @@ </para> <para> The following declaration allows to load only one integrated style sheet file. </para> <programlisting role="XML"><![CDATA[... - <context-param> - <param-name>org.richfaces.LoadStyleStrategy</param-name> - <param-value>ALL</param-value> - </context-param> -... -]]></programlisting> +<context-param> + <param-name>org.richfaces.LoadStyleStrategy</param-name> + <param-value>ALL</param-value> +</context-param> +...]]></programlisting> <para> The integrated style sheet contains style for all shipped components. The skinnability feature still works. </para> <para> The &quot;DEFAULT&quot; value is a classical on-demand variant. </para> @@ -1641,8 +1615,7 @@ <para> <emphasis role="bold">Example:</emphasis> </para> - <programlisting role="XML"> - &lt;rich:panel&gt; ... &lt;/rich:panel&gt; + <programlisting role="XML"><![CDATA[<rich:panel> ... </rich:panel>]]> </programlisting> <para> The code generates a panel component on a page, which consists of two elements: a wrapper <emphasis role="bold"> @@ -1657,7 +1630,7 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"> - &lt;div class="dr-pnl rich-panel"&gt; ... &lt;/div&gt; + <![CDATA[<div class="dr-pnl rich-panel"> ... </div>]]> </programlisting> <para> dr-pnl is a CSS class specified in the framework via skin parameters: </para> <itemizedlist> @@ -1686,8 +1659,7 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"> - &lt;rich:panel styleClass="customClass"&gt; ... - &lt;/rich:panel&gt; + <![CDATA[<rich:panel styleClass="customClass" />]]> </programlisting> <para> Could add some style properties from customClass to one particular panel, as a result we get three styles: </para> @@ -1695,8 +1667,9 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"> - &lt;div class="dr_pnl rich-panel customClass"&gt; ... - &lt;/div&gt; +<![CDATA[<div class="dr_pnl rich-panel customClass"> + ... +</div>]]> </programlisting> </section> <section id="SkinParametersTablesInRichFaces"> @@ -1929,12 +1902,11 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... - <context-param> - <param-name>org.richfaces.SKIN</param-name> - <param-value>name</param-value> - </context-param> -... -]]></programlisting> +<context-param> + <param-name>org.richfaces.SKIN</param-name> + <param-value>name</param-value> +</context-param> +...]]></programlisting> </listitem> <listitem> <para> Put your <code>&lt;name&gt;.skin.properties</code> file in one of the @@ -1967,8 +1939,8 @@ <para> Create a custom render kit and register it in the faces-config.xml like this: </para> <programlisting role="XML"><![CDATA[<render-kit> - <render-kit-id>NEW_SKIN</render-kit-id> - <render-kit-class> + <render-kit-id>NEW_SKIN</render-kit-id> + <render-kit-class> org.ajax4jsf.framework.renderer.ChameleonRenderKitImpl </render-kit-class> </render-kit>]]></programlisting> @@ -1977,11 +1949,9 @@ <para> Then you need to create and register custom renderers for the component based on the look-and-feel predefined variables: </para> <programlisting role="XML"><![CDATA[<renderer> - <component-family>javax.faces.Command</component-family> - <renderer-type>javax.faces.Link</renderer-type> - <renderer-class> - newskin.HtmlCommandLinkRenderer - </renderer-class> + <component-family>javax.faces.Command</component-family> + <renderer-type>javax.faces.Link</renderer-type> + <renderer-class>newskin.HtmlCommandLinkRenderer</renderer-class> </renderer>]]></programlisting> </listitem> <listitem> @@ -2019,8 +1989,8 @@ For example: </para> <programlisting role="XML"><![CDATA[<context-param> - <param-name>org.richfaces.SKIN</param-name> - <param-value>#{skinBean.skin}</param-value> + <param-name>org.richfaces.SKIN</param-name> + <param-value>#{skinBean.skin}</param-value> </context-param>]]> </programlisting> <para> @@ -2042,13 +2012,13 @@ For example, &quot;classic&quot;: </para> <programlisting role="XML"><![CDATA[<managed-bean> - <managed-bean-name>skinBean</managed-bean-name> - <managed-bean-class>SkinBean</managed-bean-class> - <managed-bean-scope>session</managed-bean-scope> - <managed-property> - <property-name>skin</property-name> - <value>classic</value> - </managed-property> + <managed-bean-name>skinBean</managed-bean-name> + <managed-bean-class>SkinBean</managed-bean-class> + <managed-bean-scope>session</managed-bean-scope> + <managed-property> + <property-name>skin</property-name> + <value>classic</value> + </managed-property> </managed-bean>]]> </programlisting> <para> @@ -2277,7 +2247,6 @@ <u:style name="background-color" skin="generalBackgroundColor" /> </u:selector> ... - //gradient elements ... <u:selector name=".rich-gradient-menu"> @@ -2286,7 +2255,6 @@ </u:style> <u:style name="background-repeat" value="repeat-x" /> </u:selector> - <u:selector name=".rich-gradient-tab"> <u:style name="background-image"> <f:resource f:key="org.richfaces.renderkit.html.gradientimages.TabGradientImage"/> @@ -3166,8 +3134,7 @@ <param-name>org.richfaces.LoadStyleStrategy</param-name> <param-value>NONE</param-value> </context-param> -... -]]></programlisting> +...]]></programlisting> <para> Additionally, you should include the style sheets that perform skinning of the RichFaces component and standard HTML controls. </para> <para> In order to resolve the problem with extended skinning in Opera and Safari a @@ -3175,11 +3142,9 @@ the browser type and enables extended skinning only for those browsers that fully support it. </para> <para> The script can be activated by inserting this JavaScript code to the page: </para> - <programlisting role="XML"><![CDATA[ -<script type="text/javascript"> -window.RICH_FACES_EXTENDED_SKINNING_ON = true; -</script> -]]></programlisting> + <programlisting role="XML"><![CDATA[<script type="text/javascript"> + window.RICH_FACES_EXTENDED_SKINNING_ON = true; +</script>]]></programlisting> <para> When NO script loading strategy is used and extended skinning is turned on then corresponding warning message will appears in the console. </para> <para> You also need to specify <emphasis> @@ -3190,11 +3155,9 @@ &quot;rich-extended-skinning&quot;. </para> <para> This is how you can include the style sheets to the page, in case automatic skinnability implementation is disabled. </para> - <programlisting role="XML"><![CDATA[ -<link href='/YOUR_PROJECT_NAME/a4j_3_2_2-SNAPSHOTorg/richfaces/renderkit/html/css/basic_both.xcss/DATB/eAF7sqpgb-jyGdIAFrMEaw__.jsf' type='text/css' rel='stylesheet' class='component' /> + <programlisting role="XML"><![CDATA[<link href='/YOUR_PROJECT_NAME/a4j_3_2_2-SNAPSHOTorg/richfaces/renderkit/html/css/basic_both.xcss/DATB/eAF7sqpgb-jyGdIAFrMEaw__.jsf' type='text/css' rel='stylesheet' class='component' /> <link media='rich-extended-skinning' href='/ YOUR_PROJECT_NAME /a4j_3_2_2-SNAPSHOTorg/richfaces/renderkit/html/css/extended_both.xcss/DATB/eAF7sqpgb-jyGdIAFrMEaw__.jsf' type='text/css' rel='stylesheet' class='component' /> -<link href='/ YOUR_PROJECT_NAME /a4j_3_2_2-SNAPSHOT/org/richfaces/skin.xcss/DATB/eAF7sqpgb-jyGdIAFrMEaw__.jsf' type='text/css' rel='stylesheet' class='component' /> -]]></programlisting> +<link href='/ YOUR_PROJECT_NAME /a4j_3_2_2-SNAPSHOT/org/richfaces/skin.xcss/DATB/eAF7sqpgb-jyGdIAFrMEaw__.jsf' type='text/css' rel='stylesheet' class='component' />]]></programlisting> <note> <para> Now it&apos;s necessary to use <code>a4j/versionXXX</code> resources prefix instead of <code>a4j_versionXXX</code>. Base64 encoder changed to use @@ -3217,25 +3180,23 @@ </emphasis> XML tags that form the mapping structure. Please study the example below. </para> <programlisting role="XML"><![CDATA[... - <u:selector name=".rich-component-name"> - <u:style name="background-color" skin="additionalBackgroundColor" /> - <u:style name="border-color" skin="tableBorderColor" /> - <u:style name="border-width" skin="tableBorderWidth" /> - <u:style name="border-style" value="solid" /> - </u:selector> -... -]]></programlisting> +<u:selector name=".rich-component-name"> + <u:style name="background-color" skin="additionalBackgroundColor" /> + <u:style name="border-color" skin="tableBorderColor" /> + <u:style name="border-width" skin="tableBorderWidth" /> + <u:style name="border-style" value="solid" /> +</u:selector> +...]]></programlisting> <para> During processing the code in the shown example is parsed into a standard CSS format. </para> <programlisting role="CSS"><![CDATA[... .rich-component-name { -background-color: additionalBackgroundColor; /*the value of the constant defined by your skin*/ -border-color: tableBorderColor; /*the value of the constant defined by your skin*/ -border-width: tableBorderWidth /*the value of the constant defined by your skin*/ -border-style: solid; + background-color: additionalBackgroundColor; /*the value of the constant defined by your skin*/ + border-color: tableBorderColor; /*the value of the constant defined by your skin*/ + border-width: tableBorderWidth /*the value of the constant defined by your skin*/ + border-style: solid; } -... -]]></programlisting> +...]]></programlisting> <para> The <emphasis> <property>&quot;name&quot;</property> </emphasis> attribute of <emphasis role="bold"> @@ -3254,10 +3215,9 @@ list. </para> <programlisting role="XML"><![CDATA[... <u:selector name=".rich-ordering-control-disabled, .rich-ordering-control-top, .rich-ordering-control-bottom, .rich-ordering-control-up, .rich-ordering-control-down"> - <u:style name="border-color" skin="tableBorderColor" /> + <u:style name="border-color" skin="tableBorderColor" /> </u:selector> -... -]]></programlisting> +...]]></programlisting> </section> <section id="PlugnSkin" role="new"> <?dbhtml filename="PlugnSkin.html"?> @@ -3282,8 +3242,7 @@ -DartifactId=ARTIFACT-ID -DgroupId=GROUP-ID -Dversion=VERSION -... -]]></programlisting> +...]]></programlisting> <para>Primary keys for the command:</para> <itemizedlist> <listitem> @@ -3451,10 +3410,9 @@ <programlisting role="XML"> <![CDATA[... .rich-calendar-cell { -background: #537df8; + background: #537df8; } -... -]]></programlisting> +...]]></programlisting> </listitem> <listitem> <para> Using XCSS coding approach, the same way as XCSS files are normally @@ -3470,8 +3428,7 @@ <u:style name="font-size" skin="generalSizeFont"/> <u:style name="font-family" skin="generalFamilyFont"/> </u:selector> -... -]]></programlisting> +...]]></programlisting> </listitem> </itemizedlist> <para> @@ -3482,8 +3439,7 @@ folder of you skin project (the one that contains pom.xml file). </para> <programlisting role="XML"><![CDATA[... mvn clean install -... -]]></programlisting> +...]]></programlisting> <para>In addition Plug-n-Skin has a number of predefined gradients that you can also use to make your application look nicer. The given below code snippet shows how a gradient can be used </para> @@ -3501,8 +3457,7 @@ </f:resource> </u:style> </u:selector> -... -]]></programlisting> +...]]></programlisting> <para> So, as you can see, the <property>background-image</property> CSS property is defined with <code> &lt;f:resource f:key=&quot;org.richfaces.renderkit.html.CustomizeableGradient&quot;&gt; @@ -3521,8 +3476,7 @@ <param-name>org.ajax4jsf.SKIN</param-name> <param-value>SKIN-NAME</param-value> </context-param> -... -]]></programlisting> +...]]></programlisting> <section> <sectioninfo> <keywordset> @@ -3549,9 +3503,7 @@ folders were created there. </para> <para> Next, we will use Maven to add all needed files to the skin project. This will done by the following command: </para> - <programlisting role="XML"><![CDATA[ -mvn cdk:add-skin -DbaseSkin=blueSky -DcreateExt=true -Dname=PlugnSkinDemo -Dpackage=SKINPACKAGE -]]></programlisting> + <programlisting role="XML"><![CDATA[mvn cdk:add-skin -DbaseSkin=blueSky -DcreateExt=true -Dname=PlugnSkinDemo -Dpackage=SKINPACKAGE]]></programlisting> <para> As you remember from the previous section &quot;-DbaseSkin&quot; key defines what RichFaces built-in skin to be used as a base one, &quot;-DcreateExt=true&quot; determines that the new skin will come with XCSS @@ -3595,9 +3547,8 @@ this. </para> <programlisting role="XML"><![CDATA[ button[type=&quot;button&quot;], button[type=&quot;reset&quot;], button[type=&quot;submit&quot;], input[type=&quot;reset&quot;], input[type=&quot;submit&quot;], input[type=&quot;button&quot;] { -font-weight: bold; -} -]]></programlisting> + font-weight: bold; +}]]></programlisting> <para>All the changes that were planned to be preformed are done and now you can proceed to building the new PlugnSkinDemo skin and import it into the project. As you read in the previous section, the skin should be built in the @@ -3616,23 +3567,19 @@ <listitem> <para>Add the new skin&apos;s name to the &quot;web.xml&quot; file. It is done like this</para> - <programlisting role="XML"><![CDATA[ - <context-param> - <param-name>org.ajax4jsf.SKIN</param-name> - <param-value>PlugnSkinDemo</param-value> - </context-param> -]]></programlisting> + <programlisting role="XML"><![CDATA[ <context-param> + <param-name>org.ajax4jsf.SKIN</param-name> + <param-value>PlugnSkinDemo</param-value> +</context-param>]]></programlisting> </listitem> </itemizedlist> <para> Please, do not forget that standard controls skinning has to be enabled in the &quot;web.xml&quot; file, which can be done by adding the following code to the &quot;web.xml&quot; file: </para> - <programlisting role="XML"><![CDATA[ - <context-param> - <param-name>org.richfaces.CONTROL_SKINNING</param-name> - <param-value>enable</param-value> - </context-param> -]]></programlisting> + <programlisting role="XML"><![CDATA[<context-param> + <param-name>org.richfaces.CONTROL_SKINNING</param-name> + <param-value>enable</param-value> +</context-param>]]></programlisting> <para>The result of both operations is displayed on the figure below.</para> <figure> <title>Plug-n-Skin feature in action. </title>