From richfaces-svn-commits at lists.jboss.org Mon Mar 30 13:07:50 2009
Content-Type: multipart/mixed; boundary="===============6533062922547666322=="
MIME-Version: 1.0
From: richfaces-svn-commits at lists.jboss.org
To: richfaces-svn-commits at lists.jboss.org
Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r13301 -
 trunk/docs/userguide/en/src/main/docbook/included.
Date: Mon, 30 Mar 2009 13:07:50 -0400
Message-ID: <E1LoKxi-0005el-23@committer01.frg.pub.inap.atl.jboss.com>

--===============6533062922547666322==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: msorokin
Date: 2009-03-30 13:07:49 -0400 (Mon, 30 Mar 2009)
New Revision: 13301

Added:
   trunk/docs/userguide/en/src/main/docbook/included/a4j_page.desc.xml
   trunk/docs/userguide/en/src/main/docbook/included/a4j_page.xml
Log:
https://jira.jboss.org/jira/browse/RF-6593
files with components' descriptions =


Copied: trunk/docs/userguide/en/src/main/docbook/included/a4j_page.desc.xml=
 (from rev 13300, trunk/docs/userguide/en/src/main/docbook/included/page.de=
sc.xml)
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/userguide/en/src/main/docbook/included/a4j_page.desc.xml	   =
                     (rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/a4j_page.desc.xml	200=
9-03-30 17:07:49 UTC (rev 13301)
@@ -0,0 +1,14 @@
+<?xml version=3D'1.0' encoding=3D'UTF-8'?>
+<root>
+  <section>
+    <sectioninfo>
+      <keywordset>
+        <keyword>component</keyword>
+        <keyword>page</keyword>
+      </keywordset>
+    </sectioninfo>
+    =

+<title>Description</title>
+    <para><emphasis role=3D"bold"><property>&lt;a4j:page&gt;</property></e=
mphasis> is used for solving of incompatibility problems in early Ajax4jsf =
 versions. The component encodes the full html page structure. </para>
+  </section>
+</root>

Copied: trunk/docs/userguide/en/src/main/docbook/included/a4j_page.xml (fro=
m rev 13300, trunk/docs/userguide/en/src/main/docbook/included/page.xml)
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/userguide/en/src/main/docbook/included/a4j_page.xml	        =
                (rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/a4j_page.xml	2009-03-=
30 17:07:49 UTC (rev 13301)
@@ -0,0 +1,145 @@
+<?xml version=3D'1.0' encoding=3D'UTF-8'?>
+<chapter>
+  <chapterinfo>
+    <keywordset>
+      <keyword>a4j:page</keyword>
+    </keywordset>
+  </chapterinfo>
+      <table>
+      <title>Component identification parameters </title>
+      <tgroup cols=3D"2">
+        <thead>
+          <row>
+            <entry>Name</entry>
+            <entry>Value</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>component-type</entry>
+            <entry>org.ajax4jsf.components.Page</entry>
+          </row>
+          <row>
+            <entry>component-family</entry>
+            <entry>org.ajax4jsf.components.AjaxRegion</entry>
+          </row>
+          <row>
+            <entry>component-class</entry>
+            <entry>org.ajax4jsf.component.html.HtmlPage</entry>
+          </row>
+          <row>
+            <entry>renderer-type</entry>
+            <entry>org.ajax4jsf.components.AjaxPageRenderer</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+  =

+  <section>
+    <title>Creating on a page</title>
+    <para>This component should be defined as a child component for <empha=
sis role=3D"bold">
+        <property>&lt;f:view&gt;:</property>
+      </emphasis></para>
+    <programlisting role=3D"XML"><![CDATA[<f:view>
+ <a4j:page>
+     <f:facet name=3D"head">
+         <!--...Head Content here-->
+     </f:facet>
+   <!--...Page Content here-->
+ </a4j:page>
+</f:view>
+]]></programlisting>
+      </section>
+  <section>
+    <title>Creating the Component Dynamically Using Java</title>
+
+  <para>
+      <emphasis role=3D"bold">Example:</emphasis>
+ </para>
+    <programlisting role=3D"JAVA"><![CDATA[import org.ajax4jsf.component.h=
tml.HtmlPage;
+...
+HtmlPage myPage =3D new HtmlPage();
+...
+]]></programlisting>
+  </section>
+  <section>
+    <title>Facets</title>
+    <table>
+      <title>Facets</title>
+      <tgroup cols=3D"2">
+        <thead>
+          <row>
+            <entry>Facet name</entry>
+            <entry>Description</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>head</entry>
+            <entry>Defines a head content</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+  </section>
+  <section>
+    <title>Key attributes and ways of usage</title>
+    <para>The component is mostly used to solve the following problem with=
 MyFaces for erlier Ajax4jsf versions: in MyFaces <emphasis role=3D"bold">
+        <property>&lt;f:view&gt;</property>
+      </emphasis> doesn&apos;t get control over the =

+        <property>RENDER_RESPONSE</property>
+       phase, thus Ajax can&apos;t get control and make a response also. T=
o avoid this problem it was necessary to use <emphasis role=3D"bold">
+        <property>&lt;a4j:page&gt;</property>
+      </emphasis> on a page round the Ajax updatable area. In the last ver=
sions of both frameworks the problem is successfully  fixed and no <emphasi=
s role=3D"bold"><property>&lt;a4j:page&gt;</property></emphasis> usage is r=
equired.</para>
+    <para>The component is rendered as a full HTML page template as it is =
shown in the <link linkend=3D"exampl">example</link>. The =

+      <property>head</property>
+      section is defined with the help of the corresponding <emphasis><pro=
perty>&quot;head&quot;</property></emphasis> facet.
+      =

+      You do not need to use <emphasis><property>&quot;body&quot;</propert=
y></emphasis> facet in order to define first <property>body</property> sect=
ion. =

+      The second and more <property>body</property> sections is defined wi=
th the help of the corresponding <emphasis><property>&quot;body&quot;</prop=
erty></emphasis> facet.
+      =

+      </para>
+      <para>
+        The attribute <emphasis><property>&quot;format&quot;</property></e=
mphasis> defines page layout format  for encoding DOCTYPE. =

+      </para>
+    <para>
+        The attribute <emphasis><property>&quot;pageTitle&quot;</property>=
</emphasis> is  rendered as <property>title</property> section.
+    </para> =

+    =

+     =

+    <para>
+      <emphasis role=3D"bold">Example:</emphasis>
+    </para>
+    <programlisting role=3D"XML"><![CDATA[<a4j:page format=3D"xhtml" pageT=
itle=3D"myPage">
+    <f:facet name=3D"head">
+        <!--Head Content here-->
+    </f:facet>
+   <!--Page Content Here-->
+</a4j:page>
+]]></programlisting>
+    <para>This structure is rendered as:</para>
+    =

+    <para id=3D"exampl">
+      <emphasis role=3D"bold">Example:</emphasis>
+    </para>
+    <programlisting role=3D"XML"><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//D=
TD 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>]]></programlisting>
+  </section>
+  =

+  <section>
+    <title>Relevant resources links</title>
+	<para>
+	  <ulink url=3D"http://livedemo.exadel.com/richfaces-demo/richfaces/page.=
jsf?c=3Dpage">Here</ulink> you can found some additional information for <e=
mphasis role=3D"bold"
+	    ><property>&lt;a4j:page&gt;</property></emphasis> component usage.
+	</para>  	=

+  </section>
+  =

+</chapter>


--===============6533062922547666322==--