Author: SeanRogers
Date: 2010-07-29 01:15:57 -0400 (Thu, 29 Jul 2010)
New Revision: 18274
Modified:
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Layout_and_appearance.xml
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml
Log:
Excluded sections on incomplete components RF-8987
Modified:
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml
===================================================================
---
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2010-07-28
23:37:47 UTC (rev 18273)
+++
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2010-07-29
05:15:57 UTC (rev 18274)
@@ -74,7 +74,8 @@
</para>
</section>
- <!-- TODO NOT IN A2 -->
+ <!-- FIXME not in M2 -->
+ <!--
<section id="sect-Component_Reference-Actions-a4jajaxListener">
<title><sgmltag><a4j:ajaxListener></sgmltag></title>
<itemizedlist>
@@ -104,6 +105,7 @@
The <sgmltag><a4j:ajaxListener></sgmltag> component is not
invoked for non-Ajax requests, or when the RichFaces works in the <emphasis>Ajax
request generates non-Ajax response</emphasis> mode, so the
<sgmltag><a4j:ajaxListener></sgmltag> invocation is a good
indicator that an Ajax response is going to be processed.
</para>
</section>
+ -->
<section id="sect-Component_Reference-Actions-a4jcommandButton">
<title><sgmltag><a4j:commandButton></sgmltag></title>
@@ -201,7 +203,6 @@
</para>
</section>
- <!-- FIXME this is really rich:componentControl -->
<section id="sect-Component_Reference-Actions-richcomponentControl">
<title><sgmltag><rich:componentControl></sgmltag></title>
<remark>The following reference data is taken from the old
<sgmltag><rich:componentControl></sgmltag> reference. The
details may be different now that the component is part of the
<classname>a4j</classname> tag library.</remark>
@@ -322,13 +323,18 @@
</variablelist>
</section>
+ <!-- TODO not in M2 -->
+ <!--
<section id="sect-Component_Reference-Actions-a4jhashParam">
<title><sgmltag><a4j:hashParam></sgmltag></title>
<para>
Incomplete
</para>
</section>
+ -->
+ <!-- FIXME not in M2 -->
+ <!--
<section id="sect-Component_Reference-Actions-a4jhtmlCommandLink">
<title><sgmltag><a4j:htmlCommandLink></sgmltag></title>
<itemizedlist>
@@ -360,6 +366,7 @@
When using the standard component, hidden fields were not rendered to child elements
if they were deemed unnecessary, so command links relating to content on the initial page
could become broken if they were later updated through Ajax. The
<sgmltag><a4j:htmlCommandLink></sgmltag> component addresses
this by always rendering all hidden fields.
</para>
</section>
+ -->
<section id="sect-Component_Reference-Actions-a4jjsFunction">
<title><sgmltag><a4j:jsFunction></sgmltag></title>
@@ -479,52 +486,6 @@
</para>
</section>
- <section id="sect-Component_Reference-Actions-a4jrepeat">
- <title><sgmltag><a4j:repeat></sgmltag></title>
- <itemizedlist>
- <listitem>
- <para>
- component-type: <classname>org.ajax4jsf.Repeat</classname>
- </para>
- </listitem>
- <listitem>
- <para>
- component-family: <classname>javax.faces.Data</classname>
- </para>
- </listitem>
- <listitem>
- <para>
- component-class:
<classname>org.ajax4jsf.component.html.HtmlAjaxRepeat</classname>
- </para>
- </listitem>
- <listitem>
- <para>
- renderer-type:
<classname>org.ajax4jsf.components.RepeatRenderer</classname>
- </para>
- </listitem>
- </itemizedlist>
- <!-- FIXME Move a4j:repeat -->
- <para>
- REVIEW COMMENT - a4j:repeat is not an action, should be moved. The
<sgmltag><a4j:repeat></sgmltag> component is used to iterate
changes through a repeated collection of components. It allows specific rows of items to
be updated without sending Ajax requests for the entire collection. The
<sgmltag><a4j:repeat></sgmltag> component forms the basis for
many of the tabular components detailed in <xref
linkend="chap-Component_Reference-Tables_and_grids" />.
- </para>
- <para>
- The contents of the collection are determined using Expression Language
(<acronym>EL</acronym>). The data model for the contents is specified with the
<varname>value</varname> attribute. The <varname>var</varname>
attribute names the object to use when iterating through the collection. This object is
then referenced in the relevant child components. After an Ajax request, only the rows
specified with the <varname>ajaxKeys</varname> attribute are updated rather
than the entire collection. <xref
linkend="exam-Component_Reference-a4jrepeat-a4jrepeat_example" /> shows how
to use <sgmltag><a4j:repeat></sgmltag> to maintain a simple
table.
- </para>
- <example id="exam-Component_Reference-a4jrepeat-a4jrepeat_example">
- <title><sgmltag><a4j:repeat></sgmltag>
example</title>
-
-<programlisting language="XML" role="XML"><xi:include
href="extras/exam-Component_Reference-Tables_and_grids-a4jrepeat_example.xml_sample"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude" />
-</programlisting>
- <para>
- Each row of a table contains two cells: one showing the item code, and the other
showing the item price. The table is generated by iterating through items in the
<code>repeatBeans.items</code> data model.
- </para>
- </example>
- <para>
- The <sgmltag><a4j:repeat></sgmltag> component uses other
attributes common to iteration components, such as the
<varname>first</varname> attribute for specifying the first item for
iteration, and the <varname>rows</varname> attribute for specifying the number
of rows of items to display.
- </para>
- </section>
-
- <!-- FIXME - a4j:support is now a4j:ajax in 4.0 -->
<section id="sect-Component_Reference-Actions-a4jajax">
<title><sgmltag><a4j:ajax></sgmltag></title>
<itemizedlist>
@@ -550,7 +511,7 @@
</listitem>
</itemizedlist>
<para>
- REVIEW COMMENT: a4j:support is a4j:ajax in 4.0, paths need to be updated. The
<sgmltag><a4j:ajax></sgmltag> component allows Ajax capability
to be added to any non-Ajax component. It is placed as a direct child to the component
that requires Ajax support. The <sgmltag><a4j:ajax></sgmltag>
component uses the common attributes listed in <xref
linkend="chap-Component_Reference-Common_Ajax_attributes" />.
+ The <sgmltag><a4j:ajax></sgmltag> component allows Ajax
capability to be added to any non-Ajax component. It is placed as a direct child to the
component that requires Ajax support. The
<sgmltag><a4j:ajax></sgmltag> component uses the common
attributes listed in <xref
linkend="chap-Component_Reference-Common_Ajax_attributes" />.
</para>
<note>
<title>Attaching JavaScript functions</title>
Modified:
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml
===================================================================
---
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml 2010-07-28
23:37:47 UTC (rev 18273)
+++
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml 2010-07-29
05:15:57 UTC (rev 18274)
@@ -6,7 +6,8 @@
<para>
This chapter details those components in the <classname>a4j</classname> tag
library which define an area used as a container or wrapper for other components.
</para>
- <!-- FIXME NOT IN A2 -->
+ <!-- FIXME NOT IN M2 -->
+ <!--
<section id="sect-Component_Reference-Containers-a4jform">
<title><sgmltag><a4j:form></sgmltag></title>
<itemizedlist>
@@ -53,6 +54,7 @@
</para>
</important>
</section>
+ -->
<section id="sect-Component_Reference-Containers-a4jinclude">
<title><sgmltag><a4j:include></sgmltag></title>
@@ -162,7 +164,8 @@
</para>
</section>
- <!-- FIXME NOT IN A2 -->
+ <!-- FIXME not in M2 -->
+ <!--
<section id="sect-Component_Reference-Containers-a4jpage">
<title><sgmltag><a4j:page></sgmltag></title>
<itemizedlist>
@@ -217,6 +220,7 @@
do not have this problem, and as such do not require the use of the
<sgmltag><a4j:page></sgmltag> component.
</para>
</section>
+ -->
<section id="sect-Component_Reference-Containers-a4jregion">
<title><sgmltag><a4j:region></sgmltag></title>
Modified:
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Layout_and_appearance.xml
===================================================================
---
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Layout_and_appearance.xml 2010-07-28
23:37:47 UTC (rev 18273)
+++
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Layout_and_appearance.xml 2010-07-29
05:15:57 UTC (rev 18274)
@@ -16,7 +16,7 @@
<section
id="sect-Component_Reference-Layout_and_appearance-richjQuery">
<title><sgmltag><rich:jQuery></sgmltag></title>
<para>
- Incomplete
+ Milestone2
</para>
</section>
Modified:
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml
===================================================================
---
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml 2010-07-28
23:37:47 UTC (rev 18273)
+++
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml 2010-07-29
05:15:57 UTC (rev 18274)
@@ -6,7 +6,9 @@
<para>
This chapter covers those components used to handle and manage resources and beans.
</para>
- <!-- FIXME NOT IN A2 -->
+
+ <!-- FIXME not in M2 -->
+ <!--
<section id="sect-Component_Reference-Resources-a4jloadBundle">
<title><sgmltag><a4j:loadBundle></sgmltag></title>
<itemizedlist>
@@ -182,6 +184,7 @@
</programlisting>
</example>
</section>
+ -->
<section id="sect-Component_Reference-Resources-a4jkeepAlive">
<title><sgmltag><a4j:keepAlive></sgmltag></title>
Modified:
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml
===================================================================
---
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-07-28
23:37:47 UTC (rev 18273)
+++
root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-07-29
05:15:57 UTC (rev 18274)
@@ -14,6 +14,51 @@
<para>
This chapter covers all components related to the display of tables and grids.
</para>
+
+ <section id="sect-Component_Reference-Actions-a4jrepeat">
+ <title><sgmltag><a4j:repeat></sgmltag></title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ component-type: <classname>org.ajax4jsf.Repeat</classname>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ component-family: <classname>javax.faces.Data</classname>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ component-class:
<classname>org.ajax4jsf.component.html.HtmlAjaxRepeat</classname>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ renderer-type:
<classname>org.ajax4jsf.components.RepeatRenderer</classname>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The <sgmltag><a4j:repeat></sgmltag> component is used to
iterate changes through a repeated collection of components. It allows specific rows of
items to be updated without sending Ajax requests for the entire collection. The
<sgmltag><a4j:repeat></sgmltag> component forms the basis for
many of the tabular components detailed in <xref
linkend="chap-Component_Reference-Tables_and_grids" />.
+ </para>
+ <para>
+ The contents of the collection are determined using Expression Language
(<acronym>EL</acronym>). The data model for the contents is specified with the
<varname>value</varname> attribute. The <varname>var</varname>
attribute names the object to use when iterating through the collection. This object is
then referenced in the relevant child components. After an Ajax request, only the rows
specified with the <varname>ajaxKeys</varname> attribute are updated rather
than the entire collection. <xref
linkend="exam-Component_Reference-a4jrepeat-a4jrepeat_example" /> shows how
to use <sgmltag><a4j:repeat></sgmltag> to maintain a simple
table.
+ </para>
+ <example id="exam-Component_Reference-a4jrepeat-a4jrepeat_example">
+ <title><sgmltag><a4j:repeat></sgmltag>
example</title>
+
+<programlisting language="XML" role="XML"><xi:include
href="extras/exam-Component_Reference-Tables_and_grids-a4jrepeat_example.xml_sample"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+</programlisting>
+ <para>
+ Each row of a table contains two cells: one showing the item code, and the other
showing the item price. The table is generated by iterating through items in the
<code>repeatBeans.items</code> data model.
+ </para>
+ </example>
+ <para>
+ The <sgmltag><a4j:repeat></sgmltag> component uses other
attributes common to iteration components, such as the
<varname>first</varname> attribute for specifying the first item for
iteration, and the <varname>rows</varname> attribute for specifying the number
of rows of items to display.
+ </para>
+ </section>
+
<section id="sect-Component_Reference-Tables_and_grids-richcolumn">
<title><sgmltag><rich:column></sgmltag></title>
<itemizedlist>
@@ -332,6 +377,8 @@
</para>
</section>
+ <!-- TODO not in M2 -->
+ <!--
<section
id="sect-Component_Reference-Tables_and_grids-richdataDefinitionList">
<title><sgmltag><rich:dataDefinitionList></sgmltag></title>
<itemizedlist>
@@ -389,7 +436,10 @@
</blockquote>
</example>
</section>
+ -->
+ <!-- TODO not in M2 -->
+ <!--
<section
id="sect-Component_Reference-Tables_and_grids-richdataFilterSlider">
<title><sgmltag><rich:dataFilterSlider></sgmltag></title>
<itemizedlist>
@@ -453,6 +503,7 @@
</blockquote>
</example>
</section>
+ -->
<section id="sect-Component_Reference-Tables_and_grids-richdataGrid">
<title><sgmltag><rich:dataGrid></sgmltag></title>
@@ -545,6 +596,8 @@
</example>
</section>
+ <!-- TODO not in M2 -->
+ <!--
<section id="sect-Component_Reference-Tables_and_grids-richdataList">
<title><sgmltag><rich:dataList></sgmltag></title>
<itemizedlist>
@@ -734,8 +787,10 @@
</blockquote>
</example>
</section>
+ -->
- <!-- TODO
+ <!-- TODO not in M2 -->
+ <!--
<section
id="sect-Component_Reference-Tables_and_grids-richdataScroller">
<title><sgmltag><rich:dataScroller></sgmltag></title>
<itemizedlist>
@@ -769,7 +824,8 @@
Incomplete
</para>
</section>
- -->
+ -->
+
<section id="sect-Component_Reference-Tables_and_grids-richdataTable">
<title><sgmltag><rich:dataTable></sgmltag></title>
<itemizedlist>