[richfaces-svn-commits] JBoss Rich Faces SVN: r13333 - trunk/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Wed Apr 1 06:21:47 EDT 2009
Author: cluts
Date: 2009-04-01 06:21:47 -0400 (Wed, 01 Apr 2009)
New Revision: 13333
Modified:
trunk/docs/userguide/en/src/main/docbook/included/ajaxValidator.xml
trunk/docs/userguide/en/src/main/docbook/included/calendar.xml
trunk/docs/userguide/en/src/main/docbook/included/columns.xml
trunk/docs/userguide/en/src/main/docbook/included/componentControl.xml
trunk/docs/userguide/en/src/main/docbook/included/dataFilterSlider.xml
trunk/docs/userguide/en/src/main/docbook/included/datascroller.xml
trunk/docs/userguide/en/src/main/docbook/included/graphValidator.xml
trunk/docs/userguide/en/src/main/docbook/included/repeat.xml
trunk/docs/userguide/en/src/main/docbook/included/status.xml
trunk/docs/userguide/en/src/main/docbook/included/support.xml
Log:
RF-5117 - code samples for some chapters had been updated
Modified: trunk/docs/userguide/en/src/main/docbook/included/ajaxValidator.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/ajaxValidator.xml 2009-04-01 10:21:24 UTC (rev 13332)
+++ trunk/docs/userguide/en/src/main/docbook/included/ajaxValidator.xml 2009-04-01 10:21:47 UTC (rev 13333)
@@ -64,8 +64,8 @@
<programlisting role="XML"><![CDATA[...
<h:outputText value="Name:" />
<h:inputText value="#{userBean.name}" id="name" required="true">
- <f:validateLength minimum="3" maximum="12"/>
- <rich:ajaxValidator event="onblur"/>
+ <f:validateLength minimum="3" maximum="12"/>
+ <rich:ajaxValidator event="onblur"/>
</h:inputText>
...]]></programlisting>
</section>
@@ -79,8 +79,7 @@
<programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlCalendar;
...
HtmlAjaxValidator myAjaxValidator= new HtmlAjaxValidator();
-...
-]]></programlisting>
+...]]></programlisting>
</section>
<section>
<title>Details of Usage</title>
@@ -113,7 +112,7 @@
<h:outputText value="Name:" />
<h:inputText value="#{userBean.name}" id="name" required="true">
<f:validateLength minimum="3" maximum="12"/>
- <rich:ajaxValidator event="onblur"/>
+ <rich:ajaxValidator event="onblur"/>
</h:inputText>
<rich:message for="name" />
</h:panelGrid>
Modified: trunk/docs/userguide/en/src/main/docbook/included/calendar.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/calendar.xml 2009-04-01 10:21:24 UTC (rev 13332)
+++ trunk/docs/userguide/en/src/main/docbook/included/calendar.xml 2009-04-01 10:21:47 UTC (rev 13333)
@@ -222,10 +222,10 @@
<property>"ondateselected"</property>
</emphasis> event as it's shown in the example below:</para>
<programlisting role="XML"><![CDATA[...
- <rich:calendar id="date" value="#{bean.dateTest}">
- <a4j:support event="ondateselected" reRender="mainTable"/>
- </rich:calendar>
- ...]]></programlisting>
+<rich:calendar id="date" value="#{bean.dateTest}">
+ <a4j:support event="ondateselected" reRender="mainTable"/>
+</rich:calendar>
+...]]></programlisting>
<note>
<title>Note:</title>
<para>
@@ -238,8 +238,8 @@
</emphasis> could be used for possibility of date selection canceling.
See an example below:</para>
<programlisting role="XML"><![CDATA[...
- <rich:calendar id="date" value="#{bean.dateTest}" ondateselect="if (!confirm('Are you sure to change date?')){return false;}"/>
- ...]]></programlisting>
+<rich:calendar id="date" value="#{bean.dateTest}" ondateselect="if (!confirm('Are you sure to change date?')){return false;}"/>
+...]]></programlisting>
<para>
<emphasis>
<property>"oncurrentdateselected"</property>
@@ -258,8 +258,8 @@
</para>
<programlisting role="XML"><![CDATA[...
<rich:calendar id="date" value="#{bean.dateTest}" oncurrentdateselect="if (!confirm('Are you sure to change month(year)?')){return false;}"
-oncurrentdateselected="alert('month(year) select:'+event.rich.date.toString());"/>
- ...]]></programlisting>
+ oncurrentdateselected="alert('month(year) select:'+event.rich.date.toString());"/>
+...]]></programlisting>
<para>How to use these attributes see also on the <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4092275#4092275"
>RichFaces Users Forum</ulink>.</para>
@@ -2039,8 +2039,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="XML"><![CDATA[<rich:calendar ... inputClass="myFontClass"/>
-]]></programlisting>
+ <programlisting role="XML"><![CDATA[<rich:calendar ... inputClass="myFontClass"/>]]></programlisting>
<para>This is a result:</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/columns.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/columns.xml 2009-04-01 10:21:24 UTC (rev 13332)
+++ trunk/docs/userguide/en/src/main/docbook/included/columns.xml 2009-04-01 10:21:47 UTC (rev 13333)
@@ -226,8 +226,7 @@
<h:outputText value="#{data.str0}" />
</rich:columns>
</rich:dataTable>
-...
-]]></programlisting>
+...]]></programlisting>
<!--para>As a result the following structure is rendered:</para>
<figure>
@@ -297,20 +296,18 @@
<programlisting role="XML"><![CDATA[...
<rich:dataTable value="#{bean.data}" var="var">
<rich:columns value="#{var.columns}">
- ...
+ ...
</rich:columns>
</rich:dataTable>
-...
-]]></programlisting>
+...]]></programlisting>
<para> This code works properly: </para>
<programlisting role="XML"><![CDATA[...
<c:forEach items="#{bean.data}" var="var">
<rich:columns value="#{var.columns}">
- ...
+ ...
</rich:columns>
</c:forEach>
-...
-]]></programlisting>
+...]]></programlisting>
</note>
Modified: trunk/docs/userguide/en/src/main/docbook/included/componentControl.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/componentControl.xml 2009-04-01 10:21:24 UTC (rev 13332)
+++ trunk/docs/userguide/en/src/main/docbook/included/componentControl.xml 2009-04-01 10:21:47 UTC (rev 13333)
@@ -76,8 +76,7 @@
<programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlComponentControl;
...
HtmlComponentControl myComponentControl = new HtmlComponentControl();
-...
-]]></programlisting>
+...]]></programlisting>
</section>
@@ -114,10 +113,9 @@
</para>
<programlisting role="XML"><![CDATA[...
<h:commandButton value="Show Modal Panel">
- <rich:componentControl for="ccModalPanelID" event="onclick" operation="show"/> <!--attached to the commandButton-->
+ <rich:componentControl for="ccModalPanelID" event="onclick" operation="show"/> <!--attached to the commandButton-->
</h:commandButton>
-...
-]]></programlisting>
+...]]></programlisting>
<para>
On the result page the component is rendered to JavaScript code.
This means, that it is possible to invoke the <emphasis role="bold"><property><rich:componentControl></property></emphasis>
@@ -127,14 +125,12 @@
</para>
<programlisting role="XML"><![CDATA[...
<rich:componentControl name="func" event="onRowClick" for="menu" operation="show" />
-...
-]]></programlisting>
+...]]></programlisting>
<para>
The generated JavaScript function will look as shown below:
</para>
<programlisting role="XML"><![CDATA[function func (event) {
-}
-]]></programlisting>
+}]]></programlisting>
<para>
An important <emphasis role="bold"><property><rich:componentControl></property></emphasis> feature,
is that it allows transferring parameters, with the help of special attribute <emphasis><property>"params"</property></emphasis>.
@@ -144,8 +140,7 @@
</para>
<programlisting role="XML"><![CDATA[...
<rich:componentControl name="func" event="onRowClick" for="menu" operation="show" params=”#{car.model}"/>
-...
-]]></programlisting>
+...]]></programlisting>
<para>
The alternative way for parameters transferring uses <emphasis role="bold"><property><f:param></property></emphasis> attribute.
As the code above, the following code will represent the same functionality.
@@ -155,10 +150,9 @@
</para>
<programlisting role="XML"><![CDATA[...
<rich:componentControl event="onRowClick" for="menu" operation="show">
- <f:param value="#{car.model}" name="model"/>
+ <f:param value="#{car.model}" name="model"/>
</rich:componentControl>
-...
-]]></programlisting>
+...]]></programlisting>
@@ -316,7 +310,8 @@
<f:view>
<h:form>
<br />
- <rich:toolTip id="toolTipFor" followMouse="false" direction="top-right" mode="ajax" value="This is button" horizontalOffset="5" verticalOffset="5" layout="block" />
+ <rich:toolTip id="toolTipFor" followMouse="false" direction="top-right" mode="ajax" value="This is button"
+ horizontalOffset="5" verticalOffset="5" layout="block" />
</h:form>
<h:commandButton id="ButtonID" value="Button">
<rich:componentControl for="toolTipFor" attachTo="ButtonID" operation="show" event="onclick"/>
Modified: trunk/docs/userguide/en/src/main/docbook/included/dataFilterSlider.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dataFilterSlider.xml 2009-04-01 10:21:24 UTC (rev 13332)
+++ trunk/docs/userguide/en/src/main/docbook/included/dataFilterSlider.xml 2009-04-01 10:21:47 UTC (rev 13333)
@@ -50,8 +50,7 @@
<programlisting role="XML"><![CDATA[...
<rich:dataFilterSlider sliderListener="#{mybean.doSlide}" startRange="0"
endRange="50000" increment="10000" handleValue="1" />
-...
-]]></programlisting>
+...]]></programlisting>
</section>
<section>
<title>Creating the Component Dynamically Using Java</title>
@@ -62,8 +61,7 @@
<programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlDataFilterSlider;
...
HtmlDataFilterSlider mySlider = new HtmlDataFilterSlider();
-...
-]]></programlisting>
+...]]></programlisting>
</section>
<section>
<title>Details of Usage</title>
@@ -83,14 +81,12 @@
handleValue="1"
for="carIndex"
forValRef="inventoryList.carInventory"
- filterBy="getMileage"
- />
+ filterBy="getMileage" />
...
<h:dataTable id="carIndex">
- ...
+ ...
</h:dataTable>
-...
-]]></programlisting>
+...]]></programlisting>
<para>In this example other two attributes are used for filtering:</para>
<itemizedlist>
<listitem><para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/datascroller.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/datascroller.xml 2009-04-01 10:21:24 UTC (rev 13332)
+++ trunk/docs/userguide/en/src/main/docbook/included/datascroller.xml 2009-04-01 10:21:47 UTC (rev 13333)
@@ -51,13 +51,12 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
- <h:dataTable id="table">
- ...
- </h:dataTable>
- ...
- <rich:datascroller for="table"/>
-...
-]]></programlisting>
+<h:dataTable id="table">
+ ...
+</h:dataTable>
+ ...
+<rich:datascroller for="table"/>
+...]]></programlisting>
</section>
<section>
<title>Creating the Component Dynamically Using Java</title>
@@ -68,8 +67,7 @@
<programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlDatascroller;
...
HtmlDatascroller myScroll = new HtmlDatascroller();
-...
-]]></programlisting>
+...]]></programlisting>
</section>
<section>
<title>Details of Usage</title>
@@ -134,16 +132,15 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[ ...
- <rich:datascroller for="table" maxPages="10">
- <f:facet name="first">
- <h:outputText value="First"/>
- </f:facet>
- <f:facet name="last">
- <h:outputText value="Last"/>
- </f:facet>
- </rich:datascroller>
-...
-]]></programlisting>
+<rich:datascroller for="table" maxPages="10">
+ <f:facet name="first">
+ <h:outputText value="First"/>
+ </f:facet>
+ <f:facet name="last">
+ <h:outputText value="Last"/>
+ </f:facet>
+</rich:datascroller>
+...]]></programlisting>
<figure>
<title><emphasis role="bold">
<property><rich:datascroller></property>
@@ -211,8 +208,7 @@
</h:panelGroup>
</h:panelGrid>
</h:form>
-...
-]]></programlisting>
+...]]></programlisting>
<para> In the example above you can enter the page number you want and set it by
clicking on the <emphasis role="bold">
@@ -280,11 +276,10 @@
<property>"controlsSeparator"</property>
</emphasis> facet. An example is placed below. </para>
<programlisting role="XML"><![CDATA[ ...
- <f:facet name="controlsSeparator">
- <h:graphicImage value="/image/sep.png"/>
- </f:facet>
-...
-]]></programlisting>
+<f:facet name="controlsSeparator">
+ <h:graphicImage value="/image/sep.png"/>
+</f:facet>
+...]]></programlisting>
<para> Starting from 3.2.1 of RichFaces multiple <emphasis role="bold">
<property><rich:datascroller></property>
</emphasis> instances behavior and page bindings are corrected.
Modified: trunk/docs/userguide/en/src/main/docbook/included/graphValidator.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/graphValidator.xml 2009-04-01 10:21:24 UTC (rev 13332)
+++ trunk/docs/userguide/en/src/main/docbook/included/graphValidator.xml 2009-04-01 10:21:47 UTC (rev 13333)
@@ -63,10 +63,10 @@
</para>
<programlisting role="XML"><![CDATA[...
<h:outputText value="Name:" />
- <h:inputText value="#{userBean.name}" id="name" required="true">
- <f:validateLength minimum="3" maximum="12"/>
- <rich:graphValidator event="onblur"/>
- </h:inputText>
+<h:inputText value="#{userBean.name}" id="name" required="true">
+ <f:validateLength minimum="3" maximum="12"/>
+ <rich:graphValidator event="onblur"/>
+</h:inputText>
...]]></programlisting>
</section>
@@ -79,8 +79,7 @@
<programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlCalendar;
...
HtmlgraphValidator mygraphValidator= new HtmlgraphValidator();
-...
-]]></programlisting>
+...]]></programlisting>
</section>
@@ -134,15 +133,13 @@
<programlisting role="XML"><![CDATA[...
<rich:graphValidator summary="Invalid values: " value="#{dayStatistics}">
-<a4j:repeat value="#{dayStatistics.dayPasstimes}" var="pt" id="table">
-<h:outputText value="#{pt.title}" />
-<rich:inputNumberSpinner minValue="0" maxValue="24" value="#{pt.time}" id="time">
-</rich:inputNumberSpinner>
-<rich:message for="time" />
-</a4j:repeat>
+ <a4j:repeat value="#{dayStatistics.dayPasstimes}" var="pt" id="table">
+ <h:outputText value="#{pt.title}" />
+ <rich:inputNumberSpinner minValue="0" maxValue="24" value="#{pt.time}" id="time" />
+ <rich:message for="time" />
+ </a4j:repeat>
</rich:graphValidator>
-...
-]]></programlisting>
+...]]></programlisting>
<para>Hence, the given above code will provide the functionality that is illustrated on the images below.</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/repeat.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/repeat.xml 2009-04-01 10:21:24 UTC (rev 13332)
+++ trunk/docs/userguide/en/src/main/docbook/included/repeat.xml 2009-04-01 10:21:47 UTC (rev 13333)
@@ -103,11 +103,10 @@
<programlisting role="XML"><![CDATA[<ul>
<a4j:repeat ...>
<li>...<li/>
- ...
+ ...
<li>...<li/>
</a4j:repeat>
-</ul>
-]]></programlisting>
+</ul>]]></programlisting>
<para>All other general attributes are defined according to the similar
attributes of iterative components (<emphasis role="bold">
<property><h:dataTable></property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/status.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/status.xml 2009-04-01 10:21:24 UTC (rev 13332)
+++ trunk/docs/userguide/en/src/main/docbook/included/status.xml 2009-04-01 10:21:47 UTC (rev 13333)
@@ -51,12 +51,12 @@
<listitem><para>
With <emphasis><property>"Start"</property></emphasis>/<emphasis><property>"Stop"</property></emphasis > facets definition:</para>
<programlisting role="XML"><![CDATA[<a4j:status for="stat2">
- <f:facet name="start">
- <h:graphicImage value="ajax_process.png" />
- </f:facet>
- <f:facet name="stop">
- <h:graphicImage value="ajax_stoped.png" />
- </f:facet>
+ <f:facet name="start">
+ <h:graphicImage value="ajax_process.png" />
+ </f:facet>
+ <f:facet name="stop">
+ <h:graphicImage value="ajax_stoped.png" />
+ </f:facet>
</a4j:status>]]></programlisting>
<para>In this case, the elements are generated for each status and correspond the facets content.</para>
</listitem>
Modified: trunk/docs/userguide/en/src/main/docbook/included/support.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/support.xml 2009-04-01 10:21:24 UTC (rev 13332)
+++ trunk/docs/userguide/en/src/main/docbook/included/support.xml 2009-04-01 10:21:47 UTC (rev 13333)
@@ -130,8 +130,7 @@
<f:selectItem itemValue="First Item" itemLabel="First Item"/>
<f:selectItem itemValue=" Second Item" itemLabel="Second Item"/>
<f:selectItem itemValue=" Third Item" itemLabel="Third Item"/>
- <a4j:support event="onblur" reRender="panel" onsubmit="if(!confirm('Are you sure to change the option ?'))
- {form.reset(); return false;}" oncomplete="alert('Value succesfully stored')"/>
+ <a4j:support event="onblur" reRender="panel" onsubmit="if(!confirm('Are you sure to change the option ?')) {form.reset(); return false;}" oncomplete="alert('Value succesfully stored')"/>
</h:selectOneMenu>]]></programlisting>
<para>In example there is the condition checking (confirm) is used before
request sending and message printing after the request processing is
@@ -235,8 +234,7 @@
</para>
<programlisting role="XML"><![CDATA[<h:form>
<h:inputText value="#{person.name}">
- <a4j:support event="onkeyup" reRender="test"
- requestDelay="1000" ignoreDupResponces="true" eventsQueue="myQueue"/>
+ <a4j:support event="onkeyup" reRender="test" requestDelay="1000" ignoreDupResponces="true" eventsQueue="myQueue"/>
</h:inputText>
<h:outputText value="#{person.name}" id="test"/>
</form>]]></programlisting>
More information about the richfaces-svn-commits
mailing list