[richfaces-svn-commits] JBoss Rich Faces SVN: r1738 - trunk/docs/ajaxguide/en/src/main/docbook/included.

Author: vkukharchuk Date: 2007-07-20 10:41:00 -0400 (Fri, 20 Jul 2007) New Revision: 1738 Added: trunk/docs/ajaxguide/en/src/main/docbook/included/keepAlive.xml trunk/docs/ajaxguide/en/src/main/docbook/included/portlet.desc.xml trunk/docs/ajaxguide/en/src/main/docbook/included/portlet.xml Modified: trunk/docs/ajaxguide/en/src/main/docbook/included/actionparam.xml trunk/docs/ajaxguide/en/src/main/docbook/included/include.xml trunk/docs/ajaxguide/en/src/main/docbook/included/keepAlive.desc.xml trunk/docs/ajaxguide/en/src/main/docbook/included/outputPanel.xml trunk/docs/ajaxguide/en/src/main/docbook/included/page.xml trunk/docs/ajaxguide/en/src/main/docbook/included/poll.xml Log: Modified: trunk/docs/ajaxguide/en/src/main/docbook/included/actionparam.xml =================================================================== --- trunk/docs/ajaxguide/en/src/main/docbook/included/actionparam.xml 2007-07-20 13:28:10 UTC (rev 1737) +++ trunk/docs/ajaxguide/en/src/main/docbook/included/actionparam.xml 2007-07-20 14:41:00 UTC (rev 1738) @@ -84,8 +84,12 @@ <emphasis role="bold"><property>&lt;f:param&gt;</property></emphasis>, so the "name" attribute is mandatory. Otherwise, the value will be missing due missing the request parameter name for it. </para> - <para>More information can be found on the <ulink - url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... - >Ajax4JSF Users Forum</ulink>.</para> </section> + + <section> + <title>Relevant resources links</title> + <para>More information can be found on the <ulink + url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... + >Ajax4JSF Users Forum</ulink>.</para> + </section> </chapter> Modified: trunk/docs/ajaxguide/en/src/main/docbook/included/include.xml =================================================================== --- trunk/docs/ajaxguide/en/src/main/docbook/included/include.xml 2007-07-20 13:28:10 UTC (rev 1737) +++ trunk/docs/ajaxguide/en/src/main/docbook/included/include.xml 2007-07-20 14:41:00 UTC (rev 1738) @@ -91,8 +91,12 @@ <property>&lt;redirect/&gt;</property>, </emphasis> AJAX submit is performed with navigation of the whole page and not only of the current view. </para> -<para> -Some additional information can be found on the <ulink url="http://jboss.com/index.html?module=bb&amp;op=viewtopic&... Users Forum.</ulink> -</para> </section> + + <section> + <title>Relevant resources links</title> + <para> + Some additional information can be found on the <ulink url="http://jboss.com/index.html?module=bb&amp;op=viewtopic&... Users Forum.</ulink> + </para> + </section> </chapter> \ No newline at end of file Modified: trunk/docs/ajaxguide/en/src/main/docbook/included/keepAlive.desc.xml =================================================================== --- trunk/docs/ajaxguide/en/src/main/docbook/included/keepAlive.desc.xml 2007-07-20 13:28:10 UTC (rev 1737) +++ trunk/docs/ajaxguide/en/src/main/docbook/included/keepAlive.desc.xml 2007-07-20 14:41:00 UTC (rev 1738) @@ -3,8 +3,5 @@ <para>The <emphasis role="bold"> <property>&lt;a4j:keepAlive&gt;</property> </emphasis> component allows to keep a state of each bean between requests.</para> - <para> - Some additional information about usage of components can be found <ulink url="http://jboss.com/index.html?module=bb&amp;op=viewtopic&.... - </ulink> - </para> + </section> \ No newline at end of file Added: trunk/docs/ajaxguide/en/src/main/docbook/included/keepAlive.xml =================================================================== --- trunk/docs/ajaxguide/en/src/main/docbook/included/keepAlive.xml (rev 0) +++ trunk/docs/ajaxguide/en/src/main/docbook/included/keepAlive.xml 2007-07-20 14:41:00 UTC (rev 1738) @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter> + <table> + <title>Component identification parameters </title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + <entry>Value</entry> + </row> + </thead> + <tbody> + <row> + <entry>component-type</entry> + <entry>org.ajax4jsf.components.KeepAlive</entry> + </row> + <row> + <entry>component-family</entry> + <entry>org.ajax4jsf.components.AjaxKeepAlive</entry> + </row> + <row> + <entry>component-class</entry> + <entry>org.ajax4jsf.components.AjaxKeepAlive</entry> + </row> + </tbody> + </tgroup> + </table> + + <section> + <title>Creating on a page</title> + + <para>Simple Component definition on a page:</para> + + <para> + <emphasis role="bold">Example:</emphasis> + <programlisting role="XML"><![CDATA[<a4j:keepAlive beanName = "#{myClass.testBean}"/>]]></programlisting> + </para> + </section> + + <section> + <title>Dynamical creation of a component from Java code</title> + + <para> + <emphasis role="bold">Example:</emphasis> + <programlisting role="JAVA"><![CDATA[import org.ajax4jsf.ajax.AjaxKeepAlive; +... +AjaxKeepAlive myKeepAlive = new AjaxKeepAlive(); +... + ]]></programlisting> + </para> + </section> + + <section> + <title>Key attributes and ways of usage</title> + <para> + If a managed bean is declared with 'request' scope in the configuration file with the help of 'managed-bean-scope' tag then the life-time of + this bean instance is valid only for the current request. + Any attempts to make a reference to the bean instance after the request end will throw in Illegal Argument Exception by the server. + To avoid these kinds of Exception, component + <emphasis role="bold"><property>&lt;a4j:keepAlive&gt;</property> + </emphasis> is used to maintain the state of the whole bean object among subsequent request. + </para> + + <para> + <emphasis role="bold">Example:</emphasis> + <programlisting role="XML"><![CDATA[<a4j:keepAlive beanName = "#{myClass.testBean}"/>]]></programlisting> +</para> + + <para> + Note that the attribute 'beanName' must point to 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: + + <programlisting role="XML"><![CDATA[ +class MyClass{ + ... + private TestBean testBean; + // Getters and Setters for testBean. + ... +} + ]]></programlisting> +</para> + + </section> + <section> + <title>Relevant resources links</title> + <para> + Some additional information about usage of components can be found <ulink url="http://jboss.com/index.html?module=bb&amp;op=viewtopic&.... + </ulink> + </para> + </section> +</chapter> \ No newline at end of file Modified: trunk/docs/ajaxguide/en/src/main/docbook/included/outputPanel.xml =================================================================== --- trunk/docs/ajaxguide/en/src/main/docbook/included/outputPanel.xml 2007-07-20 13:28:10 UTC (rev 1737) +++ trunk/docs/ajaxguide/en/src/main/docbook/included/outputPanel.xml 2007-07-20 14:41:00 UTC (rev 1738) @@ -126,8 +126,11 @@ on <emphasis role="bold"> <property>&lt;a4j:region&gt;</property> </emphasis> and could help considerably speed up a response output. However, if a transient flag is kept as it is, this rapid processing could cause missing of transient components that present on view and don’t come into a component tree. Hence, for any particular case you could choose a way for you application optimization: speed up processing or redundant memory for keeping tree part earlier defined a transient. </para> -<para> -Some additional information about usage of component can be found <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&...;. -</para> </section> + <section> + <title>Relevant resources links</title> + <para> + Some additional information about usage of component can be found <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&...;. + </para> + </section> </chapter> \ No newline at end of file Modified: trunk/docs/ajaxguide/en/src/main/docbook/included/page.xml =================================================================== --- trunk/docs/ajaxguide/en/src/main/docbook/included/page.xml 2007-07-20 13:28:10 UTC (rev 1737) +++ trunk/docs/ajaxguide/en/src/main/docbook/included/page.xml 2007-07-20 14:41:00 UTC (rev 1738) @@ -83,13 +83,17 @@ <para>The component is rendered as a full HTML page template (it was shown in the example). The &quot;<emphasis > <property>head</property> </emphasis>&quot; section is defined with the help of the corresponding facet with the name=&quot;head&quot; and also there is an attribute with the same name for contentType definition.</para> - <para>All other component functionality is the same as of <emphasis role="bold"> + </section> + + <section> + <title>Relevant resources links</title> + <para>All other component functionality is the same as of <emphasis role="bold"> &lt;a4j:region&gt;. </emphasis> Its desctriprion could be found -<member> + <member> <ulink url="http://webdownload.exadel.com/downloads/ajax4jsf/documentation/...;. -</member></para> - - + </member> + </para> </section> + </chapter> Modified: trunk/docs/ajaxguide/en/src/main/docbook/included/poll.xml =================================================================== --- trunk/docs/ajaxguide/en/src/main/docbook/included/poll.xml 2007-07-20 13:28:10 UTC (rev 1737) +++ trunk/docs/ajaxguide/en/src/main/docbook/included/poll.xml 2007-07-20 14:41:00 UTC (rev 1738) @@ -76,9 +76,15 @@ </emphasis> chapter attributes to provide the necessary behavior of request sending (delay, limitation of a submit and render area, requests frequency, and etc.). For detailed information on these attributes see again the <emphasis role="bold"> <property><ulink url="index.html#support">&lt;a4j:support&gt;</ulink></property></emphasis> component description. </para> - <para> -The aditional information about component usage you can find here:<ulink url="http://jboss.com/index.html?module=bb&amp;op=viewtopic&... Users Forum. + + </section> + + <section> + <title>Relevant resources links</title> + <para> + The aditional information about component usage you can find here:<ulink url="http://jboss.com/index.html?module=bb&amp;op=viewtopic&... Users Forum. </ulink> - </para> + </para> </section> + </chapter> \ No newline at end of file Added: trunk/docs/ajaxguide/en/src/main/docbook/included/portlet.desc.xml =================================================================== --- trunk/docs/ajaxguide/en/src/main/docbook/included/portlet.desc.xml (rev 0) +++ trunk/docs/ajaxguide/en/src/main/docbook/included/portlet.desc.xml 2007-07-20 14:41:00 UTC (rev 1738) @@ -0,0 +1,11 @@ +<?xml version='1.0' encoding='UTF-8'?> +<root> +<section> +<title>Description</title> + <para>The <emphasis role="bold"> + <property>&lt;a4j:portlet&gt;</property> + </emphasis>can be used in portals. The main component purpose is realization of possibility to create several instances the same portlet on + one page. + </para> +</section> +</root> \ No newline at end of file Added: trunk/docs/ajaxguide/en/src/main/docbook/included/portlet.xml =================================================================== --- trunk/docs/ajaxguide/en/src/main/docbook/included/portlet.xml (rev 0) +++ trunk/docs/ajaxguide/en/src/main/docbook/included/portlet.xml 2007-07-20 14:41:00 UTC (rev 1738) @@ -0,0 +1,65 @@ +<?xml version='1.0' encoding='UTF-8'?> +<chapter> + + <table> + <title>Component identification parameters </title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + <entry>Value</entry> + </row> + </thead> + <tbody> + <row> + <entry>component-type</entry> + <entry>org.ajax4jsf.component.Portlet</entry> + </row> + <row> + <entry>component-family</entry> + <entry>org.ajax4jsf.component.Portlet</entry> + </row> + <row> + <entry>component-class</entry> + <entry>org.ajax4jsf.component.UIPortlet</entry> + </row> + <row> + <entry>renderer-type</entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + + <section> + <title>Creating on a page</title> + <programlisting role="XML"><![CDATA[ +<f:view> + <a4j:portlet> + ... + </a4j:portlet> +</f:view> +]]></programlisting> + </section> + + <section> + <title>Dynamical creation of a component from Java code</title> + <programlisting role="JAVA"><![CDATA[ +import org.ajax4jsf.ajax.component.UIPortlet; +... +UIPortlet myPortlet = new UIPortlet(); +...]]></programlisting> + </section> + + <section> + <title>Key attributes and ways of usage</title> + <para> + Portal page can include some instances of the same portlet but clientId of elements should be different for each window. + In that case 'namespace' is used for each portlet. The <emphasis role="bold"><property>&lt;a4j:portlet&gt;</property></emphasis> + implemets NaimingContainer interface and adds namespace to all componets on a page. + All portlet content should be wrapped by <emphasis role="bold"><property>&lt;a4j:portlet&gt;</property></emphasis> for resolving problems mentioned + before. + </para> + + </section> +</chapter> \ No newline at end of file