[ajax4jsf-svn-commits] JBoss Ajax4JSF SVN: r299 - trunk/docs/userguide/en/src/main/docbook/included.
ajax4jsf-svn-commits at lists.jboss.org
ajax4jsf-svn-commits at lists.jboss.org
Thu Jul 5 04:31:09 EDT 2007
Author: smukhina
Date: 2007-07-05 04:31:09 -0400 (Thu, 05 Jul 2007)
New Revision: 299
Modified:
trunk/docs/userguide/en/src/main/docbook/included/form.xml
trunk/docs/userguide/en/src/main/docbook/included/log.xml
trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml
trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml
trunk/docs/userguide/en/src/main/docbook/included/page.xml
trunk/docs/userguide/en/src/main/docbook/included/poll.xml
trunk/docs/userguide/en/src/main/docbook/included/region.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:
http://jira.jboss.com/jira/browse/EXIN-373
italic font style is added
Modified: trunk/docs/userguide/en/src/main/docbook/included/form.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/form.xml 2007-07-05 08:23:01 UTC (rev 298)
+++ trunk/docs/userguide/en/src/main/docbook/included/form.xml 2007-07-05 08:31:09 UTC (rev 299)
@@ -50,9 +50,9 @@
<section>
<title>Key attributes and ways of usage</title>
<para>The difference with the original component is that all hidden fields required for command links are always rendered and it doesn't depend on links rendering on the initial page. It solves the problem with invalid links that weren't rendered on a page immediately, but after some AJAX request.</para>
- <para>Beginning with release 1.0.5 additional attributes that make this form variant universal have appeared. With a new attribute definition as ajax=<emphasis role="italic">
+ <para>Beginning with release 1.0.5 additional attributes that make this form variant universal have appeared. With a new attribute definition as ajax=<emphasis >
<property>"true"</property>
- </emphasis>, it becomes possible to set AJAX submission way for any components inside, i.e. not a page URL is used as an <emphasis role="italic">
+ </emphasis>, it becomes possible to set AJAX submission way for any components inside, i.e. not a page URL is used as an <emphasis >
<property>"action"</property>
</emphasis> attribute, but the javascript:A4J.AJAX.Submit(...) call. In this case, rendering is defined as reRender=list of Ids for the form element itself.</para>
<para>Example</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/log.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/log.xml 2007-07-05 08:23:01 UTC (rev 298)
+++ trunk/docs/userguide/en/src/main/docbook/included/log.xml 2007-07-05 08:31:09 UTC (rev 299)
@@ -46,15 +46,15 @@
<section>
<title>Key attributes and ways of usage</title>
<para>Usage of the appropriate component attributes could change a representation level of debug information as well as the hot key for a window opening.</para>
- <para>The hot key could be changed with the <emphasis role="italic">
+ <para>The hot key could be changed with the <emphasis >
<property>"hotkey"</property>
</emphasis>
attribute, where it's necessary to define one letter that together with "CTRL+SHIFT" opens a window.</para>
- <para>The <emphasis role="italic">
+ <para>The <emphasis >
<property>"level"</property>
</emphasis>
attribute with several possible values (FATAL, ERROR, WARN, INFO, ALL) could change a logging level.</para>
- <para>The log could be generated not only in a new window, but also on the current page in a separate <emphasis role="bold"><property><div></property></emphasis>, this is also controlled with the <emphasis role="italic">
+ <para>The log could be generated not only in a new window, but also on the current page in a separate <emphasis role="bold"><property><div></property></emphasis>, this is also controlled with the <emphasis >
<property>"popup"</property>
</emphasis>
attribute on the component. </para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml 2007-07-05 08:23:01 UTC (rev 298)
+++ trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml 2007-07-05 08:31:09 UTC (rev 299)
@@ -68,7 +68,7 @@
<para>As it was shown in the example above there are two main components:</para>
<itemizedlist>
<listitem>
- createContent specifies a method accepting 2 parameters. The first (of java.io.OutputStream type) defines a stream, where any binary data is output. The second (of java.lang.Object type) contains deserialized object with data specified in the <emphasis role="italic">
+ createContent specifies a method accepting 2 parameters. The first (of java.io.OutputStream type) defines a stream, where any binary data is output. The second (of java.lang.Object type) contains deserialized object with data specified in the <emphasis >
<property>"value"</property>
</emphasis> attribute.
</listitem>
Modified: trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2007-07-05 08:23:01 UTC (rev 298)
+++ trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2007-07-05 08:31:09 UTC (rev 299)
@@ -106,13 +106,13 @@
</h:panelGrid>
</a4j:outputPanel>
]]></programlisting>
- <para>As you see, the code is very similar to the one shown above, but <emphasis role="italic"><property>"reRender "</property></emphasis> attribute refers directly to the updating panelGrid and not to the framing outputPanel, and it's more semantically correct.</para>
+ <para>As you see, the code is very similar to the one shown above, but <emphasis ><property>"reRender "</property></emphasis> attribute refers directly to the updating panelGrid and not to the framing outputPanel, and it's more semantically correct.</para>
<para><emphasis role="bold"><property><a4j:outPanel></property></emphasis> should be used for non-JSF component part framing, which is to be updated on Ajax response, as Ajax4jsf specifies the list of updating areas as a list of an existing JSF component. </para>
<para>On default non-JSF context isn't saved in a component tree, but is rendered anew every time. To accelerate the processing speed and Ajax response input speed, Ajax4jsf saves non-JSF context in a component tree on default. This option could be canceled by keepTransient attribute that cancels transient flag forced setting for child components. This flag setting keeps the current value set by child components.</para>
<para>Note: In JSF 1.1 implementation and lower, where non-JSF context should be framed with the "f:verbatim" attribute, <emphasis role="bold">
<property><a4j:outputPanel></property>
</emphasis> doesn't improve this JSF implementation option in any way, so you still have to use this tag where it's necessary without Ajax4jsf usage. </para>
- <para>Ajax4jsf allows setting Ajax responses rendering directly basing on component tree nodes without referring to the JSP (XHTML) page code. It could be defined by selfRendered attribute setting to <emphasis role="italic">
+ <para>Ajax4jsf allows setting Ajax responses rendering directly basing on component tree nodes without referring to the JSP (XHTML) page code. It could be defined by selfRendered attribute setting to <emphasis >
<property>"true"</property>
</emphasis>
on <emphasis role="bold">
Modified: trunk/docs/userguide/en/src/main/docbook/included/page.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/page.xml 2007-07-05 08:23:01 UTC (rev 298)
+++ trunk/docs/userguide/en/src/main/docbook/included/page.xml 2007-07-05 08:31:09 UTC (rev 299)
@@ -67,12 +67,12 @@
<title>Key attributes and ways of usage</title>
<para>The component is mostly used to solve the following problem with MyFaces for erlier Ajax4gsf versions: in MyFaces <emphasis role="bold">
<property><f:view></property>
- </emphasis> doesn't get control over the "<emphasis role="italic">
+ </emphasis> doesn't get control over the "<emphasis >
<property>RENDER_RESPONSE</property>
</emphasis>" 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 the 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 (it was shown in the example). The "<emphasis role="italic">
+ <para>The component is rendered as a full HTML page template (it was shown in the example). The "<emphasis >
<property>head</property>
</emphasis>" section is defined with the help of the corresponding facet with the name="head" and also there is an attribute with the same name for contentType definition.</para>
<para>All other component functionality is the same as of <emphasis role="bold">
Modified: trunk/docs/userguide/en/src/main/docbook/included/poll.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/poll.xml 2007-07-05 08:23:01 UTC (rev 298)
+++ trunk/docs/userguide/en/src/main/docbook/included/poll.xml 2007-07-05 08:31:09 UTC (rev 299)
@@ -38,7 +38,7 @@
]]></programlisting>
<para>The <emphasis role="bold">
<property><a4j:poll></property>
- </emphasis> component defined this way every second submits AJAX form onto the server, performs the corresponding action and renders a components with the <emphasis role="italic">
+ </emphasis> component defined this way every second submits AJAX form onto the server, performs the corresponding action and renders a components with the <emphasis >
<property>"someDataTable"</property>
</emphasis> id after a response comes back.</para>
</section>
@@ -55,7 +55,7 @@
<para>The component decodes all necessary JavaScript for time count and on the expiry of some interval for calling of a Ajax4jsf utility method for Ajax request sending (A4J.AJAX.Submit (Some request parameters)).
</para>
<para>
- The timer could be stopped or started in any time. The current state is controlled on the component with the <emphasis role="italic">
+ The timer could be stopped or started in any time. The current state is controlled on the component with the <emphasis >
<property>"enabled"</property>
</emphasis> attribute:
</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/region.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/region.xml 2007-07-05 08:23:01 UTC (rev 298)
+++ trunk/docs/userguide/en/src/main/docbook/included/region.xml 2007-07-05 08:31:09 UTC (rev 299)
@@ -93,7 +93,7 @@
<!--..Some content with HTML used ("br" ,"h1" and other tags used)-->
</a4j:region >]]></programlisting>
<para>In this case, the processing is quicker and going on without referring to a page code, but the HTML code that isn't saved in a component tree could be lost. Thus, this optimization should be very carefully performed and a usage of the additional components ajax4jsf (<emphasis role="bold"><property><a4j:outputPanel></property></emphasis>) is required. </para>
- <para>The processing could be also accelerated if a region decoded for the processing passes straight away into Encode. But to update some data out of the region or on another region, use the <emphasis role="italic">
+ <para>The processing could be also accelerated if a region decoded for the processing passes straight away into Encode. But to update some data out of the region or on another region, use the <emphasis >
<property>"renderRegionOnly"</property>
</emphasis>
attribute set to "false" ("true on default") to change this behaviour.</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/repeat.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/repeat.xml 2007-07-05 08:23:01 UTC (rev 298)
+++ trunk/docs/userguide/en/src/main/docbook/included/repeat.xml 2007-07-05 08:31:09 UTC (rev 299)
@@ -33,13 +33,13 @@
<section>
<title>Creating on a page</title>
- <para>The component definition on a page is the same as for the <emphasis role="italic">
+ <para>The component definition on a page is the same as for the <emphasis >
<property>"facelets"</property>
</emphasis> component:</para>
<programlisting role="XML"><![CDATA[<a4j:repeat id="detail" value="#{bean.props}" var="detail">
<h:outputText value="#{detail.someProperty}"/>
</a4j:repeat>]]></programlisting>
- <para>The output is generated according to a collection contained in <emphasis role="italic">
+ <para>The output is generated according to a collection contained in <emphasis >
<property>"bean.props"</property>
</emphasis> with the "detail" key passed to child components.</para>
</section>
@@ -53,7 +53,7 @@
</section>
<section>
<title>Key attributes and ways of usage</title>
- <para>The main difference of this component from iterative components of other libraries is a special <emphasis role="italic">
+ <para>The main difference of this component from iterative components of other libraries is a special <emphasis >
<property>"ajaxKeys"</property>
</emphasis> attribute. This attribute defines strings that are updated after an AJAX request. As a result it becomes easier to update several child components separately without updating the whole page.</para>
<programlisting role="JSP"><![CDATA[<a4j:poll intervall="1000" action="#{repeater.action}" reRender="list">
@@ -71,14 +71,14 @@
<tbody>
<table>
]]></programlisting>
- <para>Thus, a list with a table structure from <emphasis role="italic">
+ <para>Thus, a list with a table structure from <emphasis >
<property>"bean.props"</property>
</emphasis> is output.</para>
<para>In the above-mentioned example the component <emphasis role="bold">
<property><a4j:poll></property>
- </emphasis> sends AJAX requests every second, calling the <emphasis role="italic">
+ </emphasis> sends AJAX requests every second, calling the <emphasis >
<property>"action"</property>
- </emphasis> method of the <emphasis role="italic">
+ </emphasis> method of the <emphasis >
<property>"repeater"</property>
</emphasis> bean.
</para>
@@ -86,12 +86,12 @@
<title>Note:</title>
<para>The <emphasis role="bold">
<property><a4j:repeater></property>
- </emphasis> component is defined as fully updated, but really updated there are only the strings which rowKeys are included into the set <emphasis role="italic">
+ </emphasis> component is defined as fully updated, but really updated there are only the strings which rowKeys are included into the set <emphasis >
<property>"ajaxRowSet"</property>
- </emphasis> defined in the <emphasis role="italic">
+ </emphasis> defined in the <emphasis >
<property>"ajaxKeys"</property>
</emphasis> attribute </para>
- <para>The set could be defined during the action method processing using data on a model from the property <emphasis role="italic">
+ <para>The set could be defined during the action method processing using data on a model from the property <emphasis >
<property>"repeater.myRepeat"</property>
</emphasis></para>
</note>
Modified: trunk/docs/userguide/en/src/main/docbook/included/status.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/status.xml 2007-07-05 08:23:01 UTC (rev 298)
+++ trunk/docs/userguide/en/src/main/docbook/included/status.xml 2007-07-05 08:31:09 UTC (rev 299)
@@ -36,7 +36,7 @@
<para>There are two ways to define elements indicating a request status :</para>
<itemizedlist>
<listitem>
- With <emphasis role="italic">
+ With <emphasis >
<property>"StartText"/"StopText"</property>
</emphasis> atributes:
<programlisting role="XML"><![CDATA[<a4j:status startText="Progress" stopText="Done" for="stat1">]]></programlisting>
@@ -69,19 +69,19 @@
<title>Key attributes and ways of usage</title>
<para>There are two ways for components or containers definition, which AJAX requests status is tracked by a component.<itemizedlist>
<listitem>
- Definition with the <emphasis role="italic">
+ Definition with the <emphasis >
<property>"for"</property>
</emphasis>
attribute on the <emphasis role="bold">
<property><a4j:status></property>
- </emphasis> component. Here <emphasis role="italic">
+ </emphasis> component. Here <emphasis >
<property>"for"</property>
</emphasis>
attribute should point at an AJAX container (<emphasis role="bold"><property><a4j:region></property></emphasis>) "id", which requests are tracked by a component.
</listitem>
</itemizedlist><itemizedlist>
<listitem>
- Definition with the <emphasis role="italic">
+ Definition with the <emphasis >
<property>"status"</property>
</emphasis>
attribute obtained by any Ajax4jsf library action component. The attribute should point at the <emphasis role="bold">
@@ -107,7 +107,7 @@
<span id="j_id20:status.stop" style="display: none">
Stopped
</span>]]></programlisting>
- <para>There is a possibility to group a <emphasis role="bold"><property><a4j:status></property></emphasis> elements content into <emphasis role="bold"><property><div></property></emphasis> elements, instead of <emphasis role="bold"><property><span></property></emphasis>. To use it, just redefine the <emphasis role="italic">
+ <para>There is a possibility to group a <emphasis role="bold"><property><a4j:status></property></emphasis> elements content into <emphasis role="bold"><property><div></property></emphasis> elements, instead of <emphasis role="bold"><property><span></property></emphasis>. To use it, just redefine the <emphasis >
<property>"layout"</property>
</emphasis>
attribute from "incline"(default) to "block".</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/support.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/support.xml 2007-07-05 08:23:01 UTC (rev 298)
+++ trunk/docs/userguide/en/src/main/docbook/included/support.xml 2007-07-05 08:31:09 UTC (rev 299)
@@ -75,8 +75,8 @@
<property><a4j:support></property>
</emphasis> functionality and there is no necessity to add the support to them. </para>
</note>
- <para>With the help of <emphasis role="italic">
- <property>"onsubmit"</property></emphasis> and <emphasis role="italic">
+ <para>With the help of <emphasis >
+ <property>"onsubmit"</property></emphasis> and <emphasis >
<property>"oncomplete"</property></emphasis> attributes the component allows using JavaScript before (for request sending conditions checking) and after an AJAX response processing termination (for performance of user-defined activities on the client) </para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting role="XML"><![CDATA[<h:selectOneMenu value="#{bean.text}">
@@ -91,10 +91,10 @@
<itemizedlist>
<listitem>
<emphasis role="bold">Limitation of the submit area and updating area for the request.</emphasis>
- <para><emphasis role="italic"><property>"ajaxSingle"</property></emphasis> is an attribute that allows submission on the server only component sending a request, as if the component presented on a separate form.
+ <para><emphasis ><property>"ajaxSingle"</property></emphasis> is an attribute that allows submission on the server only component sending a request, as if the component presented on a separate form.
</para>
- <para><emphasis role="italic"><property>"limitToList"</property></emphasis> is an attribute that allows to limit areas, which are updated after the responses. Only these components defined in the reRender attribute are updated. </para>
+ <para><emphasis ><property>"limitToList"</property></emphasis> is an attribute that allows to limit areas, which are updated after the responses. Only these components defined in the reRender attribute are updated. </para>
</listitem>
</itemizedlist></para>
<para><emphasis role="bold">Example 1:</emphasis></para>
@@ -119,15 +119,15 @@
<itemizedlist>
<listitem>
<emphasis role="bold">Limitation of requests frequency and updates quantity after the responses. </emphasis>
- <para><emphasis role="italic"><property>"requestDelay"</property></emphasis> is an attribute that defines a time interval in seconds minimally permissible between responses.
+ <para><emphasis ><property>"requestDelay"</property></emphasis> is an attribute that defines a time interval in seconds minimally permissible between responses.
</para>
- <para><emphasis role="italic"><property>"eventQueue"</property></emphasis> is an attribute for naming of the queue where the next response is kept in till its processing, but if the next event comes in till this time is over, the waiting event is taken away, replacing with a new one.
+ <para><emphasis ><property>"eventQueue"</property></emphasis> is an attribute for naming of the queue where the next response is kept in till its processing, but if the next event comes in till this time is over, the waiting event is taken away, replacing with a new one.
</para>
- <para><emphasis role="italic"><property>"ignoreDupResponces"</property></emphasis> is an attribute that allows to disable any updates on the client after an AJAX request if another AJAX request is already sent.
+ <para><emphasis ><property>"ignoreDupResponces"</property></emphasis> is an attribute that allows to disable any updates on the client after an AJAX request if another AJAX request is already sent.
</para>
- <para><emphasis role="italic"><property>"timeout"</property></emphasis> is an attribute that allows to set a time interval in millisecond to define a maximum time period of response wait time. In case of the interval interaction, a new request is sent and the previous one is canceled. Postprocessing of a response isn't performed.
+ <para><emphasis ><property>"timeout"</property></emphasis> is an attribute that allows to set a time interval in millisecond to define a maximum time period of response wait time. In case of the interval interaction, a new request is sent and the previous one is canceled. Postprocessing of a response isn't performed.
</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting role="XML"><![CDATA[<h:form>
More information about the ajax4jsf-svn-commits
mailing list