[richfaces-svn-commits] JBoss Rich Faces SVN: r16505 - in root/docs/trunk/Component_Reference/en-US: extras and 1 other directory.

Author: SeanRogers Date: 2010-03-01 02:03:11 -0500 (Mon, 01 Mar 2010) New Revision: 16505 Added: root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Reference-a4jpage-a4jpage_rendering-0.xml_sample root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Reference-a4jpage-a4jpage_rendering-1.xml_sample root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Reference-richdataGrid-richdataGrid_example.xml_sample~ Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Containers.xml Log: Added a4j:page (RF-8416) Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Containers.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Containers.xml 2010-02-28 18:37:27 UTC (rev 16504) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Containers.xml 2010-03-01 07:03:11 UTC (rev 16505) @@ -161,6 +161,52 @@ </para> </section> + <section id="sect-Component_Reference-Containers-a4jpage"> + <title><sgmltag>&lt;a4j:page&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.ajax4jsf.components.Page</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.ajax4jsf.components.AjaxRegion</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.ajax4jsf.component.html.HtmlPage</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.ajax4jsf.components.AjaxPageRenderer</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;a4j:page&gt;</sgmltag> component encodes a full HTML-page structure using only one tag. It renders complete <sgmltag>&lt;!DOCTYPE&gt;</sgmltag>, <sgmltag>&lt;html&gt;</sgmltag>, <sgmltag>&lt;head&gt;</sgmltag>, <sgmltag>&lt;title&gt;</sgmltag>, and <sgmltag>&lt;body&gt;</sgmltag> tags using the specified attributes and facets. Additionally, the <sgmltag>&lt;a4j:page&gt;</sgmltag> component solves an incompatibility issue between early versions of <productname>MyFaces</productname> and the <productname>Ajax4jsf</productname> framework. + </para> + <para> + The <varname>pageTitle</varname> attribute is rendered as a <sgmltag>&lt;title&gt;</sgmltag> element. The component uses the <literal>head</literal> facet to define the contents of the HTML <sgmltag>&lt;head&gt;</sgmltag> element. The <literal>format</literal> facet defines the page layout format for encoding the <sgmltag>&lt;!DOCTYPE&gt;</sgmltag> element. There rest of the contents of the <sgmltag>&lt;a4j:page&gt;</sgmltag> component are rendered as part of the <sgmltag>&lt;body&gt;</sgmltag> element. + </para> + <example id="exam-Component_Reference-a4jpage-a4jpage_rendering"> + <title><sgmltag>&lt;a4j:page&gt;</sgmltag> rendering</title> + <para> + An <sgmltag>&lt;a4j:page&gt;</sgmltag> component can be defined as follows: + </para> +<programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-a4jpage-a4jpage_rendering-0.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + This definition will render on an XHTML page as follows: + </para> +<programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-a4jpage-a4jpage_rendering-1.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + <para> + When using the <productname>Ajax4jsf</productname> framework with <productname>MyFaces</productname> version 1.2.2 and lower, the <sgmltag>&lt;f:view&gt;</sgmltag> JSP tag does not receive control for encoding contents during the <literal>RENDER_RESPONSE</literal> phase. As a result, Ajax fails to receive control and send responses. The <sgmltag>&lt;a4j:page&gt;</sgmltag> component solves this problem by wrapping the Ajax areas to be updated. Later versions of <productname>MyFaces</productname> do not have this problem, and as such do not require the use of the <sgmltag>&lt;a4j:page&gt;</sgmltag> component. + </para> + </section> + <section id="sect-Component_Reference-Containers-a4jregion"> <title><sgmltag>&lt;a4j:region&gt;</sgmltag></title> <itemizedlist> Added: root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Reference-a4jpage-a4jpage_rendering-0.xml_sample =================================================================== --- root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Reference-a4jpage-a4jpage_rendering-0.xml_sample (rev 0) +++ root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Reference-a4jpage-a4jpage_rendering-0.xml_sample 2010-03-01 07:03:11 UTC (rev 16505) @@ -0,0 +1,6 @@ +<a4j:page format="xhtml" pageTitle="myPage"> + <f:facet name="head"> + <!--Head Content here--> + </f:facet> + <!--Page Content Here--> +</a4j:page> Added: root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Reference-a4jpage-a4jpage_rendering-1.xml_sample =================================================================== --- root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Reference-a4jpage-a4jpage_rendering-1.xml_sample (rev 0) +++ root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Reference-a4jpage-a4jpage_rendering-1.xml_sample 2010-03-01 07:03:11 UTC (rev 16505) @@ -0,0 +1,10 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> + <head> + <title>myPage</title> + <!--Head Content here--> + </head> + <body> + <!--Page Content Here--> + </body> +</html> Added: root/docs/trunk/Component_Reference/en-US/extras/exam-Component_Reference-richdataGrid-richdataGrid_example.xml_sample~ ===================================================================