9:45 a.m.
Author: atsebro
Date: 2009-07-14 10:45:10 -0400 (Tue, 14 Jul 2009)
New Revision: 14922
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4j_page.desc.xml
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4j_page.xml
Log:
RF-7485:a4j:page component description review
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4j_page.desc.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4j_page.desc.xml 2009-07-14
13:56:52 UTC (rev 14921)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4j_page.desc.xml 2009-07-14
14:45:10 UTC (rev 14922)
@@ -1,14 +1,15 @@
<?xml version='1.0' encoding='UTF-8'?>
<root>
- <section>
- <sectioninfo>
- <keywordset>
- <keyword>component</keyword>
- <keyword>page</keyword>
- </keywordset>
- </sectioninfo>
-
-<title>Description</title>
- <para><emphasis
role="bold"><property><a4j:page></property></emphasis>
is used for solving of incompatibility problems in early Ajax4jsf versions. The component
encodes the full html page structure. </para>
- </section>
+ <section>
+ <sectioninfo>
+ <keywordset>
+ <keyword>component</keyword>
+ <keyword>page</keyword>
+ </keywordset>
+ </sectioninfo>
+ <title>Description</title>
+ <para>
+ The <emphasis
role="bold"><property><a4j:page></property></emphasis>
component encodes the full HTML-page structure and used for solving some incompatibility
in JSP environment with MyFaces in early Ajax4Jsf versions.
+ </para>
+ </section>
</root>
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4j_page.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4j_page.xml 2009-07-14
13:56:52 UTC (rev 14921)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4j_page.xml 2009-07-14
14:45:10 UTC (rev 14922)
@@ -35,89 +35,60 @@
</tgroup>
</table>
- <section>
- <title>Creating on a page</title>
- <para>This component should be defined as a child component for <emphasis
role="bold">
- <property><f:view>:</property>
- </emphasis></para>
- <programlisting role="XML"><![CDATA[<f:view>
- <a4j:page>
- <f:facet name="head">
- <!--Head Content here-->
- </f:facet>
- <!--Page Content here-->
+ <section>
+ <title>Creating the component with a Page Tag</title>
+ <para>
+ The <emphasis
role="bold"><property><a4j:page></property></emphasis>
should be the only child of <emphasis
role="bold"><property><f:view></property></emphasis>:
+ </para>
+ <programlisting role="XML"><![CDATA[<f:view>
+ <a4j:page>
+ <f:facet name="head">
+ <!--Head Content-->
+ </f:facet>
+ <!--Page Content-->
</a4j:page>
</f:view>]]></programlisting>
</section>
- <section>
- <title>Creating the Component Dynamically Using Java</title>
- <para>
- <emphasis role="bold">Example:</emphasis>
- </para>
- <programlisting role="JAVA"><![CDATA[import
org.ajax4jsf.component.html.HtmlPage;
+ <section>
+ <title>Creating the Component Dynamically Using Java</title>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="JAVA"><![CDATA[import
org.ajax4jsf.component.html.HtmlPage;
...
HtmlPage myPage = new HtmlPage();
...]]></programlisting>
- </section>
- <section>
- <title>Facets</title>
- <table>
- <title>Facets</title>
- <tgroup cols="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="bold">
- <property><f:view></property>
- </emphasis> doesn't get control over the
- <property>RENDER_RESPONSE</property>
- phase, thus Ajax can't get control and make a response also. To avoid
this problem it was necessary to use <emphasis role="bold">
- <property><a4j:page></property>
- </emphasis> on a page round the Ajax updatable area. In the last versions of
both frameworks the problem is successfully fixed and no <emphasis
role="bold"><property><a4j:page></property></emphasis>
usage is required.</para>
- <para>The component is rendered as a full HTML page template as it is shown in
the <link linkend="exampl">example</link>. The
- <property>head</property>
- section is defined with the help of the corresponding
<emphasis><property>"head"</property></emphasis>
facet.
+ </section>
- You do not need to use
<emphasis><property>"body"</property></emphasis>
facet in order to define first <property>body</property> section.
- The second and more <property>body</property> sections is defined with
the help of the corresponding
<emphasis><property>"body"</property></emphasis>
facet.
-
- </para>
+ <section>
+ <title>Details of usage</title>
<para>
- The attribute
<emphasis><property>"format"</property></emphasis>
defines page layout format for encoding DOCTYPE.
+ The component solves the problem with MyFaces for early Ajax4Jsf versions: in
MyFaces implementation the <emphasis
role="bold"><property><f:view></property></emphasis>
JSP tag doesn't get control for encoding contents during the
<property>RENDER_RESPONSE</property> phase,
+ thus Ajax can't neiher get a control nor make a response.
+ The <emphasis
role="bold"><property><a4j:page></property></emphasis>
solves this problem by wrapping the Ajax updatable areas.
+ In the last versions of both frameworks the problem is successfully fixed
and no <emphasis
role="bold"><property><a4j:page></property></emphasis>
usage is required.
</para>
+
<para>
- The attribute
<emphasis><property>"pageTitle"</property></emphasis>
is rendered as <property>title</property> section.
- </para>
-
-
- <para>
- <emphasis role="bold">Example:</emphasis>
+ The component uses <property>facet</property>
<emphasis><property>"head"</property></emphasis>
for defining the contents corresponding to the HTML HEAD.
+ There is no need to use
<emphasis><property>"body"</property></emphasis>
facet in order to define first <property>body</property> section.
+ The attribute
<emphasis><property>"format"</property></emphasis>
defines page layout format for encoding DOCTYPE.
+ The attribute
<emphasis><property>"pageTitle"</property></emphasis>
is rendered as <property>title</property> section.
</para>
- <programlisting role="XML"><![CDATA[<a4j:page
format="xhtml" pageTitle="myPage">
- <f:facet name="head">
- <!--Head Content here-->
- </f:facet>
- <!--Page Content Here-->
+
+ <para>
+ According to the described above, the component defined at page
as following
+ </para>
+ <programlisting role="XML"><![CDATA[<a4j:page
format="xhtml" pageTitle="myPage">
+ <f:facet name="head">
+ <!--Head Content here-->
+ </f:facet>
+ <!--Page Content Here-->
</a4j:page>]]></programlisting>
- <para>This structure is rendered as:</para>
-
+
<para id="exampl">
- <emphasis role="bold">Example:</emphasis>
+ will be rendered on a page as
</para>
<programlisting role="XML"><![CDATA[<!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
@@ -131,6 +102,27 @@
</html>]]></programlisting>
</section>
+ <section>
+ <title>Facets</title>
+ <table>
+ <title>Facets</title>
+ <tgroup cols="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>Relevant resources links</title>
<para>