Author: SeanRogers
Date: 2010-01-12 19:11:42 -0500 (Tue, 12 Jan 2010)
New Revision: 16270
Added:
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Selection_and_ordering.xml
root/docs/trunk/Component_Reference/en-US/images/figu-Component_Reference-richajaxValidator-richajaxValidator_example_result.png
root/docs/trunk/Component_Reference/en-US/images/figu-Component_Reference-richbeanValidator-richbeanValidator_example_result.png
root/docs/trunk/Component_Reference/en-US/images/figu-Component_Reference-richgraphValidator-Result_from_using_the_value_attribute.png
root/docs/trunk/Component_Reference/en-US/images/figu-Component_Reference-richgraphValidator-richgraphValidator_example_result.png
Modified:
root/docs/trunk/Component_Reference/en-US/Author_Group.xml
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Common_Ajax_attributes.xml
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Trees.xml
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Validation.xml
Log:
Updating Validation. Added images. Added Selection and ordering chapter. Added Exadel
authors.
Modified: root/docs/trunk/Component_Reference/en-US/Author_Group.xml
===================================================================
--- root/docs/trunk/Component_Reference/en-US/Author_Group.xml 2010-01-12 18:11:20 UTC
(rev 16269)
+++ root/docs/trunk/Component_Reference/en-US/Author_Group.xml 2010-01-13 00:11:42 UTC
(rev 16270)
@@ -5,11 +5,72 @@
<author>
<firstname>Sean</firstname>
<surname>Rogers</surname>
+ <contrib>Documentation lead for 4.0</contrib>
<affiliation>
<orgname>Red Hat</orgname>
<orgdiv>Engineering Content Services</orgdiv>
</affiliation>
<email>serogers(a)redhat.com</email>
</author>
+ <author>
+ <firstname>Svetlana</firstname>
+ <surname>Mukhina</surname>
+ <contrib>Documentation lead for 3.3</contrib>
+ <affiliation>
+ <orgname>Exadel</orgname>
+ <orgdiv>Documentation</orgdiv>
+ </affiliation>
+ <email>smukhina(a)exadel.com</email>
+ </author>
+ <author>
+ <firstname>Anastasiya</firstname>
+ <surname>Bogachuk</surname>
+ <contrib>Documentation for 3.3</contrib>
+ <affiliation>
+ <orgname>Exadel</orgname>
+ <orgdiv>Documentation</orgdiv>
+ </affiliation>
+ <email>abogachuk(a)exadel.com</email>
+ </author>
+ <author>
+ <firstname>Gleb</firstname>
+ <surname>Galkin</surname>
+ <contrib>Documentation for 3.3</contrib>
+ <affiliation>
+ <orgname>Exadel</orgname>
+ <orgdiv>Documentation</orgdiv>
+ </affiliation>
+ <email>ggalkin(a)exadel.com</email>
+ </author>
+ <author>
+ <firstname>Mikhail</firstname>
+ <surname>Sorokin</surname>
+ <contrib>Documentation for 3.3</contrib>
+ <affiliation>
+ <orgname>Exadel</orgname>
+ <orgdiv>Documentation</orgdiv>
+ </affiliation>
+ <email>msorokin(a)exadel.com</email>
+ </author>
+ <author>
+ <firstname>Alexander</firstname>
+ <surname>Tsebro</surname>
+ <contrib>Documentation for 3.3</contrib>
+ <affiliation>
+ <orgname>Exadel</orgname>
+ <orgdiv>Documentation</orgdiv>
+ </affiliation>
+ <email>atsebro(a)exadel.com</email>
+ </author>
+ <author>
+ <firstname>Olga</firstname>
+ <surname>Chikvina</surname>
+ <contrib>Documentation for 3.3</contrib>
+ <affiliation>
+ <orgname>Exadel</orgname>
+ <orgdiv>Documentation</orgdiv>
+ </affiliation>
+ <email>ochikvina(a)exadel.com</email>
+ </author>
</authorgroup>
Modified:
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Common_Ajax_attributes.xml
===================================================================
---
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Common_Ajax_attributes.xml 2010-01-12
18:11:20 UTC (rev 16269)
+++
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Common_Ajax_attributes.xml 2010-01-13
00:11:42 UTC (rev 16270)
@@ -51,7 +51,7 @@
</section>
<section id="sect-Component_Reference-Rendering-ajaxRendered">
- <title>ajaxRendered</title>
+ <title><varname>ajaxRendered</varname></title>
<para>
A component with <code>ajaxRendered="true"</code> will be
re-rendered with <emphasis>every</emphasis> Ajax request, even when not
referenced by the requesting component's <varname>render</varname>
attribute. This can be useful for updating a status display or error message without
explicitly requesting it.
</para>
@@ -61,7 +61,7 @@
</section>
<section id="sect-Component_Reference-Rendering-limitRender">
- <title>limitRender</title>
+ <title><varname>limitRender</varname></title>
<para>
A component with <code>limitRender="true"</code> specified will
<emphasis>not</emphasis> cause components with
<code>ajaxRendered="true"</code> to re-render, and only those
components listed in the <varname>render</varname> attribute will be updated.
This essentially overrides the <varname>ajaxRendered</varname> attribute in
other components.
</para>
@@ -93,7 +93,7 @@
<section
id="sect-Component_Reference-Common_Ajax_attributes-Queuing_and_traffic_control">
<title>Queuing and traffic control</title>
<section
id="sect-Component_Reference-Queuing_and_traffic_control-queue">
- <title>queue</title>
+ <title><varname>queue</varname></title>
<para>
The <varname>queue</varname> attribute defines the name of the queue that
will be used to schedule upcoming Ajax requests. Typically RichFaces does not queue Ajax
requests, so if events are produced simultaneously they will arrive at the server
simultaneously. This can potentially lead to unpredictable results when the responses are
returned. The <varname>queue</varname> attribute ensures that the requests are
responded to in a set order.
</para>
@@ -103,14 +103,14 @@
</section>
<section
id="sect-Component_Reference-Queuing_and_traffic_control-requestDelay">
- <title>requestDelay</title>
+ <title><varname>requestDelay</varname></title>
<para>
The <varname>requestDelay</varname> attribute specifies an amount of time
in milliseconds for the request to wait in the queue before being sent to the server. If a
similar request is added to the queue before the delay is over, the original request is
removed from the queue and not sent.
</para>
</section>
<section
id="sect-Component_Reference-Queuing_and_traffic_control-ignoreDupResponses">
- <title>ignoreDupResponses</title>
+ <title><varname>ignoreDupResponses</varname></title>
<para>
When set to <literal>true</literal>, the
<varname>ignoreDupResponses</varname> attribute causes responses from the
server for the request to be ignored if there is another similar request in the queue.
This avoids unnecessary updates on the client when another update is expected. The request
is still processed on the server, but if another similar request has been queued then no
updates are made on the client.
</para>
@@ -124,21 +124,21 @@
RichFaces uses a form-based approach for sending Ajax requests. As such, each time a
request is sent the data from the requesting component's parent
<acronym>JSF</acronym> form is submitted along with the
<acronym>XMLHTTPRequest</acronym> object. The form data contains values from
the input element and auxiliary information such as state-saving data.
</para>
<section id="sect-Component_Reference-Data_processing-process">
- <title>process</title>
+ <title><varname>process</varname></title>
<para>
The <varname>process</varname> attribute allows
<acronym>JSF</acronym> processing to be limited to defined components. To only
process the requesting component, <code>process="@this"</code> can
be used.
</para>
</section>
<section id="sect-Component_Reference-Data_processing-immediate">
- <title>immediate</title>
+ <title><varname>immediate</varname></title>
<para>
If the <varname>immediate</varname> attribute is set to
<literal>true</literal>, the default ActionListener is executed immediately
during the Apply Request Values phase of the request processing lifecycle, rather than
waitingfor the Invoke Application phase. This allows some data model values to be updated
regardless of whether the Validation phase is successful or not.
</para>
</section>
<section id="sect-Component_Reference-Data_processing-bypassUpdates">
- <title>bypassUpdates</title>
+ <title><varname>bypassUpdates</varname></title>
<para>
If the <varname>bypassUpdates</varname> attribute is set to
<literal>true</literal>, the Update Model phase of the request processing
lifecycle is bypassed. This is useful if user input needs to be validated but the model
does not need to be updated.
</para>
@@ -152,7 +152,7 @@
The <varname>action</varname> and
<varname>actionListener</varname> attributes can be used to invoke action
methods and define action events.
</para>
<section id="sect-Component_Reference-Action_and_navigation-action">
- <title>action</title>
+ <title><varname>action</varname></title>
<para>
The <varname>action</varname> attribute is a method binding that points
to the application action to be invoked. The method can be activated during the Apply
Request Values phase or the Invoke Application phase of the request processing lifecycle.
</para>
@@ -162,7 +162,7 @@
</section>
<section
id="sect-Component_Reference-Action_and_navigation-actionListener">
- <title>actionListener</title>
+ <title><varname>actionListener</varname></title>
<para>
The <varname>actionListener</varname> attribute is a method binding for
<classname>ActionEvent</classname> methods with a return type of
<literal>void</literal>.
</para>
@@ -176,49 +176,49 @@
RichFaces allows for Ajax-enabled <acronym>JSF</acronym> applications to
be developed without using any additional JavaScript code. However it is still possible to
invoke custom JavaScript code through Ajax events.
</para>
<section
id="sect-Component_Reference-Events_and_JavaScript_interactions-onsubmit">
- <title>onsubmit</title>
+ <title><varname>onsubmit</varname></title>
<para>
The <varname>onsubmit</varname> attribute will invoke the JavaScript code
before the Ajax request is sent. The request is canceled if the JavaScript code defined
for <varname>onsubmit</varname> returns <literal>false</literal>.
</para>
</section>
<section
id="sect-Component_Reference-Events_and_JavaScript_interactions-onclick">
- <title>onclick</title>
+ <title><varname>onclick</varname></title>
<para>
The <varname>onclick</varname> attribute functions similarly to the
<varname>onsubmit</varname> attribute for those components that can be
clicked, such as <sgmltag><a4j:commandButton></sgmltag> and
<sgmltag><a4j:commandLink></sgmltag>. It invokes the defined
JavaScript before the Ajax request, and the request will be canceled if the defined code
returns <literal>false</literal>.
</para>
</section>
<section
id="sect-Component_Reference-Events_and_JavaScript_interactions-oncomplete">
- <title>oncomplete</title>
+ <title><varname>oncomplete</varname></title>
<para>
The <varname>oncomplete</varname> attribute invokes the JavaScript code
after the Ajax response has been returned and the <acronym>DOM</acronym> tree
of the browser has been updated. The code is registered for further invocation of the
<acronym>XMLHTTP</acronym> request object before an Ajax request is sent. As
such, using <acronym>JSF</acronym> Expression Language
(<acronym>EL</acronym>) value binding means the code will not be changed
during processing of the request on the server. Additionally the
<varname>oncomplete</varname> attribute cannot use the
<literal>this</literal> keyword as it will not point to the component from
which the Ajax request was initiated.
</para>
</section>
<section
id="sect-Component_Reference-Events_and_JavaScript_interactions-onbegin">
- <title>onbegin</title>
+ <title><varname>onbegin</varname></title>
<para>
Incomplete
</para>
</section>
<section
id="sect-Component_Reference-Events_and_JavaScript_interactions-onsuccess">
- <title>onsuccess</title>
+ <title><varname>onsuccess</varname></title>
<para>
Incomplete
</para>
</section>
<section
id="sect-Component_Reference-Events_and_JavaScript_interactions-onerror">
- <title>onerror</title>
+ <title><varname>onerror</varname></title>
<para>
Incomplete
</para>
</section>
<section
id="sect-Component_Reference-Events_and_JavaScript_interactions-data">
- <title>data</title>
+ <title><varname>data</varname></title>
<para>
The <varname>data</varname> attribute allows the use of additional data
during an Ajax call. <acronym>JSF</acronym> Expression Language
(<acronym>EL</acronym>) can be used to reference the property of the managed
bean, and its value will be serialized in JavaScript Object Notation
(<acronym>JSON</acronym>) and returned to the client side. The property can
then be referenced through the <varname>data</varname> variable in the event
attribute definitions. Both primitive types and complex types such as arrays and
collections can be serialized and used with <varname>data</varname>.
</para>
Added:
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Selection_and_ordering.xml
===================================================================
---
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Selection_and_ordering.xml
(rev 0)
+++
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Selection_and_ordering.xml 2010-01-13
00:11:42 UTC (rev 16270)
@@ -0,0 +1,32 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="chap-Component_Reference-Selection_and_ordering">
+ <title>Selection and ordering</title>
+ <para>
+ Incomplete
+ </para>
+
+ <section id="sect-Component_Reference-Trees-richlistShuttle">
+ <title>rich:listShuttle</title>
+ <para>
+ Incomplete
+ </para>
+ </section>
+
+ <section id="sect-Component_Reference-Trees-richorderingList">
+ <title>rich:orderingList</title>
+ <para>
+ Incomplete
+ </para>
+ </section>
+
+ <section id="sect-Component_Reference-Trees-richpickList">
+ <title>rich:pickList</title>
+ <para>
+ Incomplete
+ </para>
+ </section>
+
+</chapter>
+
Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Trees.xml
===================================================================
---
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Trees.xml 2010-01-12
18:11:20 UTC (rev 16269)
+++
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Trees.xml 2010-01-13
00:11:42 UTC (rev 16270)
@@ -6,48 +6,7 @@
<para>
Incomplete
</para>
- <section id="sect-Component_Reference-Trees-richdataDefinitionList">
- <title>rich:dataDefinitionList</title>
- <para>
- Incomplete
- </para>
- </section>
- <section id="sect-Component_Reference-Trees-richdataList">
- <title>rich:dataList</title>
- <para>
- Incomplete
- </para>
- </section>
-
- <section id="sect-Component_Reference-Trees-richdataOrderedList">
- <title>rich:dataOrderedList</title>
- <para>
- Incomplete
- </para>
- </section>
-
- <section id="sect-Component_Reference-Trees-richlistShuttle">
- <title>rich:listShuttle</title>
- <para>
- Incomplete
- </para>
- </section>
-
- <section id="sect-Component_Reference-Trees-richorderingList">
- <title>rich:orderingList</title>
- <para>
- Incomplete
- </para>
- </section>
-
- <section id="sect-Component_Reference-Trees-richpickList">
- <title>rich:pickList</title>
- <para>
- Incomplete
- </para>
- </section>
-
<section id="sect-Component_Reference-Trees-richchangeExpandListener">
<title>rich:changeExpandListener</title>
<para>
Modified:
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Validation.xml
===================================================================
---
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Validation.xml 2010-01-12
18:11:20 UTC (rev 16269)
+++
root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Validation.xml 2010-01-13
00:11:42 UTC (rev 16270)
@@ -67,6 +67,21 @@
<programlisting language="Java" role="JAVA">
<xi:include href="extras/exam-Component_Reference-ValidationBean.js"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</programlisting>
+ <blockquote>
+ <figure
id="figu-Component_Reference-richajaxValidator-richajaxValidator_example_result">
+ <title>rich:ajaxValidator example result</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/figu-Component_Reference-richajaxValidator-richajaxValidator_example_result.png"
format="PNG" />
+ </imageobject>
+ <textobject>
+ <para>
+ The result of the
<sgmltag><rich:ajaxValidator></sgmltag> example: three text
entry fields with corresponding validation messages.
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </blockquote>
</example>
</section>
@@ -121,6 +136,21 @@
<programlisting language="Java" role="JAVA">
<xi:include href="extras/exam-Component_Reference-ValidationBean.js"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</programlisting>
+ <blockquote>
+ <figure
id="figu-Component_Reference-richbeanValidator-richbeanValidator_example_result">
+ <title>rich:beanValidator example result</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/figu-Component_Reference-richbeanValidator-richbeanValidator_example_result.png"
format="PNG" />
+ </imageobject>
+ <textobject>
+ <para>
+ The result of the
<sgmltag><rich:beanValidator></sgmltag> example: three text
entry fields with corresponding validation messages.
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </blockquote>
</example>
</section>
@@ -175,6 +205,21 @@
<programlisting language="Java" role="JAVA">
<xi:include href="extras/exam-Component_Reference-ValidationBean.js"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</programlisting>
+ <blockquote>
+ <figure
id="figu-Component_Reference-richgraphValidator-richgraphValidator_example_result">
+ <title>rich:graphValidator example result</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/figu-Component_Reference-richgraphValidator-richgraphValidator_example_result.png"
format="PNG" />
+ </imageobject>
+ <textobject>
+ <para>
+ The result of the
<sgmltag><rich:graphValidator></sgmltag> example: three text
entry fields with corresponding validation messages.
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </blockquote>
</example>
<para>
The optional <varname>value</varname> attribute can be used to define a
value bound to the bean. The bean properties are then validated again
<emphasis>after</emphasis> the model has been updated.
@@ -185,6 +230,21 @@
<programlisting language="XML" role="XML">
<xi:include
href="extras/exam-Component_Reference-richgraphValidator-Using_the_value_attribute.xml_sample"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</programlisting>
+ <blockquote>
+ <figure
id="figu-Component_Reference-richgraphValidator-Result_from_using_the_value_attribute">
+ <title>Result from using the value attribute</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/figu-Component_Reference-richgraphValidator-Result_from_using_the_value_attribute.png"
format="PNG" />
+ </imageobject>
+ <textobject>
+ <para>
+ The result from the example of using the <varname>value</varname>
attribute with <sgmltag><rich:graphValidator></sgmltag>. The
values in the number spinners need to validate before being stored.
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </blockquote>
</example>
</section>
Added:
root/docs/trunk/Component_Reference/en-US/images/figu-Component_Reference-richajaxValidator-richajaxValidator_example_result.png
===================================================================
(Binary files differ)
Property changes on:
root/docs/trunk/Component_Reference/en-US/images/figu-Component_Reference-richajaxValidator-richajaxValidator_example_result.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
root/docs/trunk/Component_Reference/en-US/images/figu-Component_Reference-richbeanValidator-richbeanValidator_example_result.png
===================================================================
(Binary files differ)
Property changes on:
root/docs/trunk/Component_Reference/en-US/images/figu-Component_Reference-richbeanValidator-richbeanValidator_example_result.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
root/docs/trunk/Component_Reference/en-US/images/figu-Component_Reference-richgraphValidator-Result_from_using_the_value_attribute.png
===================================================================
(Binary files differ)
Property changes on:
root/docs/trunk/Component_Reference/en-US/images/figu-Component_Reference-richgraphValidator-Result_from_using_the_value_attribute.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
root/docs/trunk/Component_Reference/en-US/images/figu-Component_Reference-richgraphValidator-richgraphValidator_example_result.png
===================================================================
(Binary files differ)
Property changes on:
root/docs/trunk/Component_Reference/en-US/images/figu-Component_Reference-richgraphValidator-richgraphValidator_example_result.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream