[jboss-cvs] JBossAS SVN: r95660 - projects/docs/enterprise/5.0/RichFaces/en-US.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed Oct 28 02:23:39 EDT 2009
Author: laubai
Date: 2009-10-28 02:23:39 -0400 (Wed, 28 Oct 2009)
New Revision: 95660
Modified:
projects/docs/enterprise/5.0/RichFaces/en-US/Architecture_Overview.xml
projects/docs/enterprise/5.0/RichFaces/en-US/Book_Info.xml
projects/docs/enterprise/5.0/RichFaces/en-US/FAQ.xml
projects/docs/enterprise/5.0/RichFaces/en-US/Getting_Started.xml
projects/docs/enterprise/5.0/RichFaces/en-US/Revision_History.xml
projects/docs/enterprise/5.0/RichFaces/en-US/RichFaces_Developer_Guide.xml
projects/docs/enterprise/5.0/RichFaces/en-US/Settings.xml
Log:
Removed CDATA tags and sections 4.3-4.7 in Architecture Overview.
Modified: projects/docs/enterprise/5.0/RichFaces/en-US/Architecture_Overview.xml
===================================================================
--- projects/docs/enterprise/5.0/RichFaces/en-US/Architecture_Overview.xml 2009-10-28 06:19:57 UTC (rev 95659)
+++ projects/docs/enterprise/5.0/RichFaces/en-US/Architecture_Overview.xml 2009-10-28 06:23:39 UTC (rev 95660)
@@ -69,7 +69,9 @@
The RichFaces JavaScript Engine runs on the client side, and updates different areas of your JSF page based on information from the AJAX response. This JavaScript code operates automatically, so there is no need to use it directly.</para>
</formalpara>
</section>
- <section id="IntegralParts" role="new">
+ <!--
+
+ <section id="IntegralParts" role="new">
<title>RichFaces Integral Parts</title>
<para>
RichFaces includes several integral parts (framework, libraries, etc.):</para>
@@ -124,16 +126,16 @@
<title>Re-Rendering</title>
<para>AJAX attributes are common in AJAX components such as <literal><a4j:support></literal>, <literal><a4j:commandButton></literal>, <literal><a4j:jsFunction></literal>, <literal><a4j:poll></literal>, <literal><a4j:push></literal> and similar. Most RichFaces components with built-in AJAX support also contain these attributes. AJAX component attributes let RichFaces expose its features. Most attributes are assigned default values, so you can start working with RichFaces without understanding the particular use of each attribute. However, familiarizing yourself with attributes will let you tune AJAX behavior more effectively.</para>
<para><varname>reRender</varname> is a key attribute that points to one or more areas on a page that should be updated with a response upon AJAX interaction. The value of the <varname>reRender</varname> attribute can be the ID of the JSF component, or an ID list. A simple example would be:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:commandButton value="update" reRender="infoBlock"/>
...
<h:panelGrid id="infoBlock">
...
</h:panelGrid>
-...]]></programlisting>
+...</programlisting>
<para>The value of the <varname>reRender</varname> attribute belonging to the <literal>a4j:commandButton</literal> tag defines the part or parts of your page to be updated. In this case, the only part of the page that will be updated is the <literal><h:panelGrid></literal> tag, because its ID value matches the value of the <varname>reRender</varname> attribute. It is very easy to update multiple elements on a page: simply list their IDs as the value of <varname>reRender</varname>.</para>
<para><varname>reRender</varname> uses the <ulink url="http://java.sun.com/javaee/javaserverfaces/1.2_MR1/docs/api/javax/faces/component/UIComponent.html#findComponent(java.lang.String)"><literal>UIComponent.findComponent()</literal> algorithm</ulink> (with some exceptions) to locate the component on the component tree. The algorithm presumes that several steps are required, and each step is executed only if the previous step is unsuccessful. You can hasten the process of locating the component by mentioning it more explicitly. The following example shows the different approaches available. Both buttons will work, but the <guibutton>Shortcut</guibutton> will work faster.</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<h:form id="form1">
...
<a4j: commandButton value="Usual Way" reRender="infoBlock, infoBlock2" />
@@ -150,35 +152,35 @@
</h:panelGrid>
...
</f:subview>
-...]]></programlisting>
+...</programlisting>
<para>You can also use JSF EL expressions as the value of the <varname>reRender</varname> attribute. The EL for <varname>reRender</varname> is resolved immediately prior to the <emphasis>Render Response</emphasis> phase, so you can determine which elements should be rerendered based on any previous phase in the AJAX request process.</para>
<para>The most common problem when <varname>reRender</varname> is used is identifying a component with a <varname>rendered</varname> attribute. When the <varname>rendered</varname> condition returns <literal>false</literal>, JSF does not store the location of the component to be rerendered. Therefore, after a component is rendered during the AJAX request, RichFaces delivers the rendered code to the client but cannot update the page because the location for the update is unknown. To work around this, point to one of the parent components that has no <varname>rendered</varname> attribute. Alternatively, you can wrap the component to be updated with <code><a4j:outputPanel>layout="none"</code>.</para>
<para>Setting the <varname>ajaxRendered</varname> attribute of <literal><a4j:outputPanel></literal> to <literal>true</literal> lets you define a page area that will be rerendered even if it is not explicitly identified in the <varname>reRender</varname> attribute.</para>
<para>It can be useful to have an area on a page that is updated as a response on any AJAX request. For example, the following code outputs error messages regardless of which AJAX request causes the Validation phase to fail:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:outputPanel ajaxRendered="true">
<h:messages />
</a4j:outputPanel>
-...]]></programlisting>
- <para>The <varname>limitToList</varname> attribute lets you dismiss the behavior of the <literal><a4j:outputPanel></literal> element's <varname>ajaxRendered</varname> attribute. <!--#modify The following sentence seems wrong, but that's what the previous text suggested. Check, please!-->When <varname>limitToList</varname> is <literal>false</literal>, only the areas explicitly mentioned in the <varname>reRender</varname> attribute will be updated. All output panels that define <varname>ajaxRendered</varname> as <literal>true</literal> are ignored. For example:</para>
- <programlisting role="XML"><![CDATA[...
+...</programlisting>
+ <para>The <varname>limitToList</varname> attribute lets you dismiss the behavior of the <literal><a4j:outputPanel></literal> element's <varname>ajaxRendered</varname> attribute. When <varname>limitToList</varname> is <literal>false</literal>, only the areas explicitly mentioned in the <varname>reRender</varname> attribute will be updated. All output panels that define <varname>ajaxRendered</varname> as <literal>true</literal> are ignored. For example:</para>
+ <programlisting role="XML">...
<h:form>
<h:inputText value="#{person.name}">
<a4j:support event="onkeyup" reRender="test" limitToList="true"/>
</h:inputText>
<h:outputText value="#{person.name}" id="test"/>
</form>
-...]]></programlisting>
+...</programlisting>
</section>
<section id="QueueandTrafficFloodProtection">
<title>Queue and Traffic Flood Protection</title>
<para><varname>eventsQueue</varname> defines the name of the queue that will order upcoming AJAX requests. RichFaces does not queue AJAX requests by default. If events are produced simultaneously, they will arrive simultaneously at the server. However, JSF implementations (particularly early versions) do not guarantee that the first request will be served or passed into the JSF lifecycle first. The order in which server-side data is modified during simultaneous requests can be unpredictable. The <varname>eventsQueue</varname> attribute helps you avoid potential problems in this situation. Define the name of the queue explicitly if you expect intensive AJAX traffic in your application.</para>
<para>If the <varname>eventsQueue</varname> attribute is defined, a request posted in the same queue as another request will wait for the first request's AJAX response to be returned. RichFaces can also remove <emphasis>similar</emphasis> requests (requests produced by the same event) from the queue. The following code ensures that only the most recent request is sent to the server (assuming that a change is made before the original AJAX Response is returned):</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<h:inputText value="#{userBean.name}">
<a4j:support event="onkeyup" eventsQueue="foo" reRender="bar" />
</h:inputText>
-...]]></programlisting>
+...</programlisting>
<para>The <varname>requestDelay</varname> attribute defines the time (in milliseconds) that the request will wait in the queue before it is ready to send. When the delay time has passed, the request will either be sent to the server or removed (if a more recent <emphasis>similar</emphasis> request has been queued already).</para>
<para>The <varname>ignoreDupResponses</varname> attribute ignores the AJAX Response produced by the request if the most recent <emphasis>similar</emphasis> request is already queued. Setting <varname>ignoreDupResponses</varname> to <literal>true</literal> does not cancel the request while it is being processed on the server, but does not update the client-side data if the response no longer belongs to the most current request.</para>
<para> Defining the <varname>eventsQueue</varname> and <varname>requestDelay</varname> protects you against unnecessary traffic flood and synchronizes the order of your AJAX requests. If your requests originate from several sources, you can define the same queue name for each source. This is useful if you have AJAX components that invoke requests asynchronously from user event requests, such as <literal><a4j:poll></literal> or <literal><a4j:push></literal>. Where these requests modify the same data, synchronizing the request order is important to data integrity.</para>
@@ -188,7 +190,7 @@
<section id="QueuePrinciples">
<title>Queue Principles</title>
<para>RichFaces 3.3.0 and higher includes an improved queue. It eliminates the possibility of collisions of conflicting data and reduces traffic between the browser and the server by sending only the most recent AJAX request where <emphasis>similar</emphasis> requests are held simultaneously during the <emphasis>request delay period</emphasis>.</para>
- <!--#modify It did not sound as if there were any changes between the previous queue and the 3.3.0 version, so I removed the redundant paragraph. If there were any changes, let me know. lbailey at redhat.com-->
+
<para>There are four types of queue:</para>
<itemizedlist>
<listitem><para>the <emphasis>Global Default Queue</emphasis>, defined in the <filename>web.xml</filename> file,
@@ -204,7 +206,7 @@
<para>the <emphasis>Form-based Default Queue</emphasis>.</para>
</listitem>
</itemizedlist>
- <para>This section covers the different queues in detail. <!--Usage details are covered in <xref linkend="a4j_queue" />.--></para>
+ <para>This section covers the different queues in detail. </para>
<section>
<title>Global Default queue, defined in the <filename>web.xml</filename> file</title>
@@ -219,13 +221,13 @@
</itemizedlist>
<para>The Global Default Queue is application-scoped and is defined in the <filename>web.xml</filename> file as follows:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<context-param>
<param-name>org.richfaces.queue.global.enabled</param-name>
<param-value>true</param-value>
</context-param>
...
-]]></programlisting>
+</programlisting>
<para>The Global Default Queue is disabled by default because artificially serializing all AJAX requests on a page can affect expected behavior significantly.</para>
</section>
<section>
@@ -252,18 +254,18 @@
</itemizedlist>
<para>The View-scoped Default, Named, and Form-based queue types all use the <literal><a4j:queue></literal> tag to override the settings defined by the Global Queue in <filename>web.xml</filename>.</para>
<para>You can also programmatically enable/disable the global queue for a particular view using the following:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:queue name="org.richfaces.global_queue" disabled="true"... />
-...]]></programlisting>
+...</programlisting>
<para>To enable the queue for a single view page, you must set the <varname>disable</varname> attribute to <literal>false</literal>.</para>
- <para>You can override the default settings by changing the attributes of the <literal><a4j:queue></literal> component. (The complete list of attributes can be found in the <!--#modify xref 6.20 plz--><literal><a4j:queue></literal> chapter.) For example:</para>
- <programlisting role="XML"><![CDATA[...
+ <para>You can override the default settings by changing the attributes of the <literal><a4j:queue></literal> component. (The complete list of attributes can be found in the <literal><a4j:queue></literal> chapter.) For example:</para>
+ <programlisting role="XML">...
<a4j:queue name="org.richfaces.global_queue" requestDelay="1000" />
-...]]></programlisting>
+...</programlisting>
<para>You can add the view-scoped queue without explicitly defining a name. Place the appropriate tag anywhere outside the form so that it is not recognized as a form-based queue:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:queue ... />
-...]]></programlisting>
+...</programlisting>
</section>
<section>
@@ -280,13 +282,13 @@
<para>
You can reference a named queue from any Ajax4JSF or RichFaces component that supports the<varname>eventsQueue</varname> attribute. The following example shows how components can reference a named queue:
</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:queue name="sampleQueue"/>
<h:inputText value="#{bean.inputValue}" >
<a4j:support id="inputSupport" event="onkeyup" eventsQueue="sample"/>
</h:inputText>
<rich:comboBox value="#{bean.state}" suggestionValues="#{bean.suggestions}" eventsQueue="sample" />
-...]]></programlisting>
+...</programlisting>
<para>In this example, two components (<literal><a4j:queue></literal> and <literal><rich:comboBox></literal>) reference the named queue through the <varname>eventsQueue</varname> attribute. </para>
</section>
<section>
@@ -296,29 +298,7 @@
<para>To avoid the need to define the <varname>eventsQueue</varname> attribute for every component on a form, create a default queue for a form. This will override the Global Default Queue.</para>
<para>You can use either a JSF <literal><h:form></literal> or an Ajax4JSF <literal><a4j:form></literal>. </para>
- <programlisting role="XML"><![CDATA[...
-<h:form ... >
- <a4j:queue ... /><!-- note no name specified -->
- ...
-</h:form>
-...]]></programlisting>
-
- <para>You can also reference a named queue with the <varname>eventsQueue</varname> attribute if you are using an Ajax4JSF <literal><a4j:form></literal>:</para>
- <programlisting role="XML"><![CDATA[...
-<a4j:form eventsQueue="fooQueue" ...>
- ...
-</a4j:form>
-...]]></programlisting>
- <para>The queue itself also lets you reference a named queue from the form with a form-based queue:</para>
- <programlisting role="XML"><![CDATA[...
-<a4j:queue name="sampleQueue" ... /> <!-- named queue -->
-...
-<h:form ... >
- <a4j:queue ... /><!-- form-based queue-->
- <a4j:commandButton ... /> <!-- uses the form-based queue -->
- <a4j:commandButton eventsQueue="sampleQueue" /> <!-- uses named queue -->
-</h:form>
-...]]></programlisting>
+
</section>
<section>
@@ -360,7 +340,6 @@
</row>
</thead>
<tbody>
- <!--Sorting API -->
<row>
<entry>getSize()</entry>
<entry>Returns the current size to the queue</entry>
@@ -381,14 +360,14 @@
<title>Data Processing Options</title>
<para>RichFaces takes a form-based approach to sending AJAX requests. This means that each time you click on an AJAX button or the <literal><a4j:poll></literal> produces an asynchronous request, the data from the closest JSF form is submitted with the <literal>XMLHTTPRequest</literal> object. The form data contains the values from the form input element and auxiliary information such as state saving data.</para>
<para>When <varname>ajaxSingle</varname> is set to <literal>true</literal>, it includes the value of the current component (plus any <literal><f:param></literal> and <literal><a4j:actionparam></literal> values) in the request map. Any <literal><a4j:support></literal> is included as a value of the parent component, like so:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<h:form>
<h:inputText value="#{person.name}">
<a4j:support event="onkeyup" reRender="test" ajaxSingle="true"/>
</h:inputText>
<h:inputText value="#{person.middleName}"/>
</form>
-...]]></programlisting>
+...</programlisting>
<para>This request contains only the input component that causes request generation, not all of the components on the form, because <code>ajaxSingle="true"</code> is used.</para>
<note>
<para>
@@ -405,7 +384,7 @@
<section id="ActionandNavigation">
<title>Action and Navigation</title>
<para>AJAX <emphasis>action</emphasis> components are similar to non-AJAX JSF components like <literal><h:commandButton></literal>. They let you submit the form. You can use <varname>action</varname> and <varname>actionListener</varname> attributes to invoke the action method and define the action event.</para>
- <para>The <varname>action</varname> method must return <literal>null</literal> for your AJAX response to have a partial page update. (This is known as <emphasis>AJAX request generates Non-AJAX Response</emphasis> mode.) If the action does not return null, but the action outcome matches one of the navigation rules, RichFaces works in <!--#modify Check mode please; sounded as if a different mode was intended, here.--><emphasis>AJAX request generates Non-AJAX Response</emphasis> mode, which can be useful in two major cases:</para>
+ <para>The <varname>action</varname> method must return <literal>null</literal> for your AJAX response to have a partial page update. (This is known as <emphasis>AJAX request generates Non-AJAX Response</emphasis> mode.) If the action does not return null, but the action outcome matches one of the navigation rules, RichFaces works in <emphasis>AJAX request generates Non-AJAX Response</emphasis> mode, which can be useful in two major cases:</para>
<itemizedlist>
<listitem>
<para>RichFaces lets you organize page flow within the <literal><a4j:include></literal> component. (This is typical of Wizard-like behavior.) New content is rendered inside the <literal><a4j:include></literal> area. Content is taken from the navigation rule of the Faces configuration file (usually <filename>faces-config.xml</filename>). Note that the content of the wizard is not isolated from the rest of the page. The included page should have its own <literal><f:view></literal> defined, regardless of whether facelets are used. You must include an AJAX component inside <literal><a4j:include></literal> to navigate between the wizard pages or a complete page update will be performed.</para>
@@ -419,9 +398,9 @@
<title>JavaScript Interactions</title>
<para>RichFaces lets you write AJAX-enabled JSF applications without writing any JavaScript code. However, you can still invoke JavaScript code if required with several helpful AJAX attributes:</para>
<para>The <varname>onsubmit</varname> attribute lets you invoke JavaScript code before an AJAX request is sent. If <varname>onsubmit</varname> returns <literal>false</literal>, the AJAX request is canceled. <varname>onsubmit</varname> code is inserted before the RichFaces AJAX call, so if you want the AJAX request to be sent, do not include a <literal>return</literal> statement in <varname>onsubmit</varname>. When invoking a JavaScript function that returns <literal>true</literal> or <literal>false</literal>, use the conditional statement to return something only when you need to cancel the request. For example:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
onsubmit="if (mynosendfunct()==false){return false}"
-...]]></programlisting>
+...</programlisting>
<para><varname>onclick</varname> is similar to <varname>onsubmit</varname>, but is used for clickable components such as <literal><a4j:commandLink></literal> and <literal><a4j:commandButton></literal>. If <varname>onclick</varname> returns <literal>false</literal>, the AJAX request is canceled.</para>
<para><varname>oncomplete</varname> passes JavaScript that would be invoked immediately after the AJAX response returns and the DOM is updated. We do not recommend using the keyword <literal>this</literal> inside the EL expression, because it will not always point to the component where the AJAX request was initiated.</para>
<para>
@@ -430,9 +409,9 @@
</emphasis> attribute defines JavaScript code for call after Ajax response receiving
and before updating DOM on a client side. </para>
<para>The <varname>data</varname> attribute retrieves additional data from the server during an AJAX call. You can use JSF EL to point to the managed bean's property and its value will be serialized in JSON format and made available on the client side. You can refer to this value with <varname>data</varname>, like so:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:commandButton value="Update" data="#{userBean.name}" oncomplete="showTheName(data.name)" />
-...]]></programlisting>
+...</programlisting>
<para>RichFaces lets you serialize primitive and complex data types into JSON format, including arrays and collections. The beans must be serializable before you can refer to them with <varname>data</varname>.</para>
<para>There are several useful JavaScript functions available to this attribute:</para>
<variablelist>
@@ -456,12 +435,12 @@
<term><code>rich:findComponent('id')</code></term>
<listitem>
<para>returns an instance of <literal>UIComponent</literal> that takes the short ID of the component as a parameter.</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<h:inputText id="myInput">
<a4j:support event="onkeyup" reRender="outtext"/>
</h:inputText>
<h:outputText id="outtext" value="#{rich:findComponent('myInput').value}" />
-...]]></programlisting>
+...</programlisting>
</listitem>
</varlistentry>
</variablelist>
@@ -469,7 +448,7 @@
<section id="IterationcomponentsAjaxattributes">
<title>Iteration components Ajax attributes</title>
<para><varname>ajaxKeys</varname> defines strings that are updated after an AJAX request. This makes it possible to update several child components separately without updating the entire page.</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:poll intervall="1000" action="#{repeater.action}" reRender="text">
<table>
<tbody>
@@ -483,12 +462,12 @@
</tbody>
</table>
</a4j:poll>
-...]]></programlisting>
+...</programlisting>
</section>
<section id="Otherusefulattributes">
<title>Other useful attributes</title>
<para>The <varname>status</varname> attribute for AJAX components (<literal><a4j:commandButton></literal> , <literal><a4j:poll></literal> , etc.) points to an ID of the <literal><a4j:status></literal> component. Use this attribute to share the <literal><a4j:status></literal> component between different AJAX components from different regions. For example:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:region id="extr">
<h:form>
<h:outputText value="Status:" />
@@ -515,7 +494,7 @@
</a4j:region>
</h:form>
</a4j:region>
-...]]></programlisting>
+...</programlisting>
<para>In the example, <literal><a4j:support></literal> and <literal><a4j:commandButton></literal> are defined in different regions. The value of the <varname>status</varname> attribute for these components points to an ID of <literal><a4j:support></literal>, so the <literal><a4j:support></literal> component is shared between two components from different regions.</para>
<para>You can find more information in the <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/status.jsf?c=status"> RichFaces Live Demo</ulink>.</para>
<para>The <varname>focus</varname> attribute points to the ID of a component where the focus will be set following an AJAX request.</para>
@@ -530,7 +509,7 @@
<para><literal><a4j:commandButton></literal> and <literal><a4j:commandLink></literal> tags are used to send an AJAX request upon the <literal>onclick</literal> JavaScript event. </para>
<para>The <literal><a4j:poll></literal> tag is used to send an AJAX request periodically using a timer.</para>
<para>The <literal><a4j:support></literal> tag lets you add AJAX functions to standard JSF components and send an AJAX request upon a selected JavaScript event: <literal>onkeyup</literal>, <literal>onmouseover</literal>, etc.</para>
- <!--para>Most important attributes of components that provide Ajax request calling features are:</para>
+ <para>Most important attributes of components that provide Ajax request calling features are:</para>
<itemizedlist>
<listitem>
<emphasis>
@@ -577,7 +556,7 @@
<emphasis>
<property>"ignoreDupResponses"</property>
</emphasis> is used to abort unfinished request on new event. </listitem>
- </itemizedlist-->
+ </itemizedlist>
</section>
<section id="DecideWhatToSend">
<title>Decide What to Send</title>
@@ -606,7 +585,7 @@
<para>You can use <varname>process</varname> when you want to process only two components in different view areas.</para>
<para>For example, imagine that you need to process two input fields, but not the whole view. If you wrap the first input field to a region, or make a <literal><a4j:support></literal> component with <code>ajaxSingle="true"</code> nested, the second input will not be processed. </para>
<para>A simple solution to this problem is:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<h:inputText value="#{bean.name}" id="name">
<a4j:support ajaxSingle="true" process="email" event="onblur" reRender="someOut"/>
</h:inputText>
@@ -614,9 +593,9 @@
<h:inputText value="#{bean.email}" id="email">
<a4j:support ajaxSingle="true" process="name" event="onblur" reRender="someOut"/>
</h:inputText>
-...]]></programlisting>
+...</programlisting>
<para>When the <code>id="name"</code> input field loses focus, an AJAX request is sent. Therefore, only two input fields (<code>id="name"</code> and <code>id="email"</code>) are processed. Decoding, conversion/validation, and value applying phases are all executed. The <code>id="email"</code> input field is handled the same way upon a blur event.</para>
- <!--para>
+ <para>
The
<emphasis>
<property>"process"</property>
@@ -684,20 +663,20 @@
<property><h:outputText></property>
</emphasis>
.
- </para-->
+ </para>
</section>
</section>
<section id="FilterConfiguration">
<title>Filter Configuration</title>
<para>RichFaces uses a filter to correct code received in an AJAX request. In a <emphasis>regular</emphasis> JSF request, a browser makes corrections independently. In an AJAX request, a filter is required to prevent layout destruction, because received code could differ from code that has been validated by a browser, and the browser makes no corrections.</para>
<para>You can set a filter in your application's <filename>web.xml</filename>:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<filter>
<display-name>RichFaces Filter</display-name>
<filter-name>richfaces</filter-name>
<filter-class>org.ajax4jsf.Filter</filter-class>
</filter>
-...]]></programlisting>
+...</programlisting>
<note>
<para>Fast Filters are deprecated and available only for backward compatibility with previous versions of RichFaces. Fast Filter usage is not recommended. For a similar function, try the <xref linkend="Neko" />.</para>
</note>
@@ -722,7 +701,7 @@
</variablelist>
<para>The following is an example configuration:</para>
<programlisting role="XML">
-<![CDATA[...
+...
<context-param>
<param-name>org.ajax4jsf.xmlparser.ORDER</param-name>
<param-value>NONE,NEKO,TIDY</param-value>
@@ -747,14 +726,14 @@
<dispatcher>REQUEST</dispatcher>
<dispatcher>INCLUDE</dispatcher>
</filter-mapping>
-...]]>
+...
</programlisting>
<para>This example shows that the <literal>ORDER</literal> parameter defines the order in which particular filter types are used for code correction.</para>
<para>First, the <literal>NONE</literal> type is specified for the filter. Then two different page sets are defined for two different, corresponding filter types (<literal>NONE</literal> and <literal>NEKO</literal>). The first set is defined like so:</para>
-<programlisting role="XML"><![CDATA[<param-value>/pages/performance\.xhtml,/pages/default.*\.xhtml</param-value>]]></programlisting>
+<programlisting role="XML"><param-value>/pages/performance\.xhtml,/pages/default.*\.xhtml</param-value></programlisting>
<para>If a page relates to this definition, it is not corrected because the filter type for this page set is defined as <literal>NONE</literal>. If a page is not from the first set, then the <literal>NEKO</literal> filter type is used.</para>
<para>The second set is defined as follows:</para>
-<programlisting role="XML"><![CDATA[<param-value>/pages/repeat\.xhtml</param-value>]]></programlisting>
+<programlisting role="XML"><param-value>/pages/repeat\.xhtml</param-value></programlisting>
<para>If the page set relates to this definition, the <literal>NEKO</literal> filter type is used for correction. If the page is not related to this second set, the <literal>TIDY</literal> filter type is set for code correction.</para>
</section>
<section id="ScriptsandStylesLoadStrategy" role="updated">
@@ -764,59 +743,61 @@
<title><literal>org.richfaces.LoadScriptStrategy</literal></title>
<para>Declare the following in your <filename>web.xml</filename> to enable loading integrated script files.</para>
</formalpara>
-<programlisting role="XML"><![CDATA[...
+<programlisting role="XML">...
<context-param>
<param-name>org.richfaces.LoadScriptStrategy</param-name>
<param-value>ALL</param-value>
</context-param>
-...]]></programlisting>
+...</programlisting>
<para>If you do not declare <literal>org.richfaces.LoadScriptStrategy</literal> in the <filename>web.xml</filename>, it will default to the following:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<context-param>
<param-name>org.richfaces.LoadScriptStrategy</param-name>
<param-value>DEFAULT</param-value>
</context-param>
-...]]></programlisting>
+...</programlisting>
<para>The third possible value is <literal>NONE</literal>. There is no reason to use this unless you obtain a modified version of the script and want to include it manually in a page header.</para>
<warning>
<para>Using the <literal>ALL</literal> value of the <literal>LoadScriptStrategy</literal> disables JavaScript file compression.</para>
- <!--programlisting role="XML"><![CDATA[...
+ <programlisting role="XML"><![CDATA[...
<context-param>
<param-name>org.ajax4jsf.COMPRESS_SCRIPT</param-name>
<param-value>false</param-value>
</context-param>
...
- ]]></programlisting-->
+ ]]></programlisting>
</warning>
<formalpara>
<title><literal>org.richfaces.LoadStyleStrategy</literal></title>
<para>The following declaration allows only one integrated style sheet file to be loaded:</para></formalpara>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<context-param>
<param-name>org.richfaces.LoadStyleStrategy</param-name>
<param-value>ALL</param-value>
</context-param>
-...]]></programlisting>
+...</programlisting>
<para>The integrated style sheet contains style information for all shipped components. (Skins can still be used.)</para>
<para>The <literal>DEFAULT</literal> value is a classical on-demand variant.</para>
<para><literal>NONE</literal> prevents the styles from loading at all. The earlier introduced <emphasis>plain skin</emphasis> resets all color and font parameters to <literal>null</literal>. The <literal>NONE</literal> value for <literal>org.richfaces.LoadStyleStrategy</literal> means that predefined styles for RichFaces are not used. </para>
<para>For more information, see the <ulink url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4114033">RichFaces User Forum</ulink>.</para>
- </section>
+ </section>-->
+
+
<section id="RequestErrorsAndSessionExpirationHandling">
<title>Request Errors and Session Expiration Handling</title>
<para>RichFaces lets you redefine the standard handlers responsible for processing exceptions. We recommend defining your own JavaScript, which will be executed when exceptional situations occur.</para>
<para>Add the following code to <filename>web.xml</filename>: </para>
- <programlisting role="XML"><![CDATA[<context-param>
+ <programlisting role="XML"><context-param>
<param-name>org.ajax4jsf.handleViewExpiredOnClient</param-name>
<param-value>true</param-value>
-</context-param>]]>
+</context-param>
</programlisting>
<section id="RequestErrorsHandling">
<title>Request Errors Handling</title>
<para>To execute your own code on the client in the event of an error during an AJAX request, you must redefine the standard <literal>A4J.AJAX.onError</literal> method like so:</para>
- <programlisting role="JAVA"><![CDATA[ A4J.AJAX.onError = function(req, status, message){
+ <programlisting role="JAVA"> A4J.AJAX.onError = function(req, status, message){
window.alert("Custom onError handler "+message);
-}]]></programlisting>
+}</programlisting>
<para>This function accepts the following as parameters:</para>
<variablelist>
<varlistentry><term><literal>req</literal></term>
@@ -846,13 +827,13 @@
<emphasis>Example:</emphasis>
</para>
<programlisting role="JAVA">
-<![CDATA[A4J.AJAX.onExpired = function(loc, expiredMsg){
+A4J.AJAX.onExpired = function(loc, expiredMsg){
if(window.confirm("Custom onExpired handler "+expiredMsg+" for a location: "+loc)){
return loc;
} else {
return false;
}
-}]]></programlisting>
+}</programlisting>
<para>This function can take the following parameters:</para>
<variablelist>
<varlistentry><term><literal>loc</literal></term>
@@ -868,12 +849,12 @@
</variablelist>
<note>
<para>Customized <literal>onExpire</literal> handlers do not work under MyFaces. MyFaces handles exceptions by internally generating a debug page. To prevent this behavior, use the following:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<context-param>
<param-name>org.apache.myfaces.ERROR_HANDLING</param-name>
<param-value>false</param-value>
</context-param>
-...]]></programlisting>
+...</programlisting>
</note>
<!--note>
<title>Note:</title>
@@ -931,12 +912,12 @@
<section id="Example">
<title>Example</title>
<para>The following is an example of a simple <emphasis>panel</emphasis> component:</para>
- <programlisting role="XML"><![CDATA[<rich:panel> ... </rich:panel>]]>
+ <programlisting role="XML"><rich:panel> ... </rich:panel>
</programlisting>
<para>This code generates a panel component on a page, which consists of two elements: a wrapper <literal><div></literal> element and a <literal><div></literal> element for the panel body with the specified style properties. The wrapper <literal><div></literal> element will look like this: </para>
- <programlisting role="XML"><![CDATA[<div class="dr-pnl rich-panel">
+ <programlisting role="XML"><div class="dr-pnl rich-panel">
...
-</div>]]></programlisting>
+</div></programlisting>
<para><literal>dr-pnl</literal> is a CSS class that is specified in the framework via skin parameters:</para>
<itemizedlist>
<listitem>
@@ -948,12 +929,12 @@
</itemizedlist>
<para>You can change all colors for all panels on all pages by changing these skin parameter values. However, if you specify a <literal><rich:panel></literal> class on the page, its parameters are also acquired by all panels on this page.</para>
<para>Developers can also change the style properties for panel. For example:</para>
- <programlisting role="XML"><![CDATA[<rich:panel styleClass="customClass" />]]></programlisting>
+ <programlisting role="XML"><rich:panel styleClass="customClass" /></programlisting>
<para>The previous definition could add some style properties from <literal>customClass</literal> to one particular panel. As a result, we will get three styles:</para>
<programlisting role="XML">
-<![CDATA[<div class="dr_pnl rich-panel customClass">
+<div class="dr_pnl rich-panel customClass">
...
-</div>]]>
+</div>
</programlisting>
</section>
<section id="SkinParametersTablesInRichFaces">
@@ -1164,12 +1145,12 @@
</listitem>
<listitem>
<para>Add the skin definition <literal><contex-param></literal> to the <filename>web.xml</filename> of your application, like so: </para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<context-param>
<param-name>org.richfaces.SKIN</param-name>
<param-value>name</param-value>
</context-param>
-...]]></programlisting>
+...</programlisting>
</listitem>
<listitem>
<para>Place your <literal><name>.skin.properties</literal> file in either your <filename>/META-INF/skins</filename> or <filename>/WEB-INF/classes</filename> directory.</para>
@@ -1184,18 +1165,18 @@
<itemizedlist>
<listitem>
<para>Create a custom render kit and register it in the <filename>faces-config.xml</filename> like so:</para>
- <programlisting role="XML"><![CDATA[<render-kit>
+ <programlisting role="XML"><render-kit>
<render-kit-id>NEW_SKIN</render-kit-id>
<render-kit-class>org.ajax4jsf.framework.renderer.ChameleonRenderKitImpl</render-kit-class>
-</render-kit>]]></programlisting>
+</render-kit></programlisting>
</listitem>
<listitem>
<para>Next, create and register custom renderers for the component based on the look-and-feel predefined variables:</para>
- <programlisting role="XML"><![CDATA[<renderer>
+ <programlisting role="XML"><renderer>
<component-family>javax.faces.Command</component-family>
<renderer-type>javax.faces.Link</renderer-type>
<renderer-class>newskin.HtmlCommandLinkRenderer</renderer-class>
-</renderer>]]></programlisting>
+</renderer></programlisting>
</listitem>
<listitem>
<para>Finally, place a properties file with skin parameters into the class path root. There are two requirements for the properties file:</para>
@@ -1214,15 +1195,15 @@
<section id="ChangeAndModifySkin">
<title>Changing skin in runtime</title>
<para>You can change skins during runtime by defining the following EL-expression in your <filename>web.xml</filename>.</para>
- <programlisting role="XML"><![CDATA[<context-param>
+ <programlisting role="XML"><context-param>
<param-name>org.richfaces.SKIN</param-name>
<param-value>#{skinBean.skin}</param-value>
-</context-param>]]>
+</context-param>
</programlisting>
<para>
The <literal>skinBean</literal> code looks like this:
</para>
- <programlisting role="JAVA"><![CDATA[public class SkinBean {
+ <programlisting role="JAVA">public class SkinBean {
private String skin;
@@ -1232,9 +1213,9 @@
public void setSkin(String skin) {
this.skin = skin;
}
-}]]></programlisting>
+}</programlisting>
<para>You must also set the <varname>skin</varname> property's initial value in the configuration file. To set <literal>classic</literal>:</para>
- <programlisting role="XML"><![CDATA[<managed-bean>
+ <programlisting role="XML"><managed-bean>
<managed-bean-name>skinBean</managed-bean-name>
<managed-bean-class>SkinBean</managed-bean-class>
<managed-bean-scope>session</managed-bean-scope>
@@ -1242,10 +1223,10 @@
<property-name>skin</property-name>
<value>classic</value>
</managed-property>
-</managed-bean>]]>
+</managed-bean>
</programlisting>
<para>You can also change the properties of the default skin. To do so, edit the properties of the default skin. The following shows you example page code:</para>
- <programlisting role="XML"><![CDATA[<h:form>
+ <programlisting role="XML"><h:form>
<div style="display: block; float: left">
<h:selectOneRadio value="#{skinBean.skin}" border="0" layout="pageDirection" title="Changing skin" style="font-size: 8; font-family: comic" onchange="submit()">
<f:selectItem itemLabel="plain" itemValue="plain" />
@@ -1271,7 +1252,7 @@
</rich:panelBarItem>
</rich:panelBar>
</div>
-</h:form>]]></programlisting>
+</h:form></programlisting>
<para>
The above code will generate the following list of options:
</para>
@@ -1381,15 +1362,15 @@
<itemizedlist>
<listitem>
<para>basic elements nested within elements with a <emphasis>rich-container</emphasis> class. For example:</para>
- <programlisting role="CSS"><![CDATA[...
+ <programlisting role="CSS">...
.rich-container select {
//class content
}
-...]]></programlisting>
+...</programlisting>
</listitem>
<listitem>
<para>Elements with a class name that corresponds to one of the basic element names or types are mapped with the <literal>rich-<elementName>[-<elementType>]</literal> scheme, as in the following example:</para>
- <programlisting role="CSS"><![CDATA[...
+ <programlisting role="CSS">...
.rich-select {
//class content
}
@@ -1398,7 +1379,7 @@
//class content
}
-...]]></programlisting>
+...</programlisting>
<note>
<para>Elements are given classes depending upon their <literal>link</literal> type and pseudo-class name, for example, <literal>rich-link</literal>, <literal>rich-link-hover</literal>, <literal>rich-link-visited</literal></para>
</note>
@@ -1406,7 +1387,7 @@
</itemizedlist>
<para>The predefined rich CSS classes provided can be used as classes for both basic and complex HTML elements.</para>
<para>The following code snippet shows several elements as an example:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<u:selector name=".rich-box-bgcolor-header">
<u:style name="background-color" skin="headerBackgroundColor" />
</u:selector>
@@ -1428,7 +1409,7 @@
</u:style>
<u:style name="background-repeat" value="repeat-x" />
</u:selector>
-...]]></programlisting>
+...</programlisting>
<para>For a more thorough look at standard component skinning, we recommend exploring the CSS files located in the <filename>ui/core/src/main/resources/org/richfaces/</filename> directory of the RichFaces SVN repository.</para>
<section id="BasicLevel" role="NotInToc">
<title>Standard Level</title>
@@ -2260,7 +2241,7 @@
</table>
<note>
<para>The basic skinning level can fail if the <literal>ajaxPortlet</literal> is configured as follows:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<portlet>
<portlet-name>ajaxPortlet</portlet-name>
<header-content>
@@ -2269,7 +2250,7 @@
<link rel="stylesheet" type="text/css" href="/faces/rfRes/org/richfaces/skin.xcss" />
</header-content>
</portlet>
-...]]></programlisting>
+...</programlisting>
</note>
</section>
</section>
@@ -2278,24 +2259,24 @@
<para>Extended skinning of standard HTML controls is applied automatically: the browser type is detected, and if a browser does not fully support extended skinning, only basic skinning is applied.</para>
<para>There are some problems with standard HTML controls in certain browsers (Opera and Safari) that may cause problems if you wish to skin your RichFaces components and standard HTML controls manually. You can find more information about disabling skinnability in <xref linkend="ScriptsandStylesLoadStrategy" />.</para>
<para>To disable skinnability, set the <varname>org.richfaces.LoadStyleStrategy</varname> parameter to <literal>NONE</literal> in your <filename>web.xml</filename> file, like so:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<context-param>
<param-name>org.richfaces.LoadStyleStrategy</param-name>
<param-value>NONE</param-value>
</context-param>
-...]]></programlisting>
+...</programlisting>
<para>You should also include the style sheets that apply skins to RichFaces components and standard HTML controls.</para>
<para>To work around the problem of extended skinning in Opera and Safari, the <filename>skinning.js</filename> client script is added to the RichFaces library. This detects the browser type and enables extended skinning only for browsers that fully support it.</para>
<para>Activate the script by inserting the following JavaScript into your page:</para>
- <programlisting role="XML"><![CDATA[<script type="text/javascript">
+ <programlisting role="XML"><script type="text/javascript">
window.RICH_FACES_EXTENDED_SKINNING_ON = true;
-</script>]]></programlisting><!--tsuzukeru-->
+</script></programlisting>
<para>When no script-loading strategy is used and extended skinning is enabled, a warning message appears in the console.</para>
<para>You must also specify the <varname>media</varname> attribute in the <literal>link</literal> tag. This adds the <filename>extended_both.xcss</filename> style sheet to <literal>rich-extended-skinning</literal>.</para>
<para>To include your style sheets to the page when automatic skinnability is disabled, add the following:</para>
- <programlisting role="XML"><![CDATA[<link href='/YOUR_PROJECT_NAME/a4j_3_2_2-SNAPSHOTorg/richfaces/renderkit/html/css/basic_both.xcss/DATB/eAF7sqpgb-jyGdIAFrMEaw__.jsf' type='text/css' rel='stylesheet' class='component' />
+ <programlisting role="XML"><link href='/YOUR_PROJECT_NAME/a4j_3_2_2-SNAPSHOTorg/richfaces/renderkit/html/css/basic_both.xcss/DATB/eAF7sqpgb-jyGdIAFrMEaw__.jsf' type='text/css' rel='stylesheet' class='component' />
<link media='rich-extended-skinning' href='/ YOUR_PROJECT_NAME /a4j_3_2_2-SNAPSHOTorg/richfaces/renderkit/html/css/extended_both.xcss/DATB/eAF7sqpgb-jyGdIAFrMEaw__.jsf' type='text/css' rel='stylesheet' class='component' />
-<link href='/ YOUR_PROJECT_NAME /a4j_3_2_2-SNAPSHOT/org/richfaces/skin.xcss/DATB/eAF7sqpgb-jyGdIAFrMEaw__.jsf' type='text/css' rel='stylesheet' class='component' />]]></programlisting>
+<link href='/ YOUR_PROJECT_NAME /a4j_3_2_2-SNAPSHOT/org/richfaces/skin.xcss/DATB/eAF7sqpgb-jyGdIAFrMEaw__.jsf' type='text/css' rel='stylesheet' class='component' /></programlisting>
<note>
<para>The Base64 encoder now uses <literal>!</literal> instead of <literal>.</literal>, so remember to use the <literal>a4j/versionXXX</literal> resources prefix instead of <literal>a4j_versionXXX</literal>. </para>
</note>
@@ -2304,36 +2285,36 @@
<title>XCSS File Format</title>
<para>Cross-site Cascading Style Sheet (XCSS) files are the core of RichFaces component skinnability. XCSS is XML-formatted CSS that extends the skinning process. RichFaces parses the XCSS file containing all look and feel parameters of a particular component and compiles the information into a standard CSS file that can be recognized by a web browser.</para>
<para>The XCSS file contains CSS properties and skin parameter mappings. Mapping a CSS selector to a skin parameter can be done with <literal>< u:selector ></literal> and <literal>< u:style></literal> XML tags, which define the mapping structure, as in the following example:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<u:selector name=".rich-component-name">
<u:style name="background-color" skin="additionalBackgroundColor" />
<u:style name="border-color" skin="tableBorderColor" />
<u:style name="border-width" skin="tableBorderWidth" />
<u:style name="border-style" value="solid" />
</u:selector>
-...]]></programlisting>
+...</programlisting>
<para>During processing, this code will be parsed and assembled into a standard CSS format, like so:</para>
- <programlisting role="CSS"><![CDATA[...
+ <programlisting role="CSS">...
.rich-component-name {
background-color: additionalBackgroundColor; /*the value of the constant defined by your skin*/
border-color: tableBorderColor; /*the value of the constant defined by your skin*/
border-width: tableBorderWidth; /*the value of the constant defined by your skin*/
border-style: solid;
}
-...]]></programlisting>
+...</programlisting>
<para>The <varname>name</varname> attribute of <literal><u:selector></literal> defines the CSS selector, while the <varname>name</varname> attribute of the <literal><u:style></literal> tag defines the skin constant that is mapped to a CSS property. You can also use the <varname>value</varname> attribute of the <literal><u:style></literal> tag to assign a value to a CSS property.</para>
<para>CSS selectors with identical skin properties can be included in a comma-separated list:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<u:selector name=".rich-ordering-control-disabled, .rich-ordering-control-top, .rich-ordering-control-bottom, .rich-ordering-control-up, .rich-ordering-control-down">
<u:style name="border-color" skin="tableBorderColor" />
</u:selector>
-...]]></programlisting>
+...</programlisting>
</section>
<section id="PlugnSkin" role="new">
<title>Plug-n-Skin</title>
<para><emphasis>Plug-n-Skin</emphasis> lets you easily create, customize, and plug in a custom skin to your project. You can create skins based on the parameters of predefined RichFaces skins. Plug-n-Skin also lets you unify the appearance of rich controls with standard HTML elements. This section contains step-by-step instructions for creating your own skin with Plug-n-Skin.</para>
<para>First, use Maven to create a template for your new skin. (You can find more information about configuring Maven for RichFaces in the <!--#modify add info?--><ulink url="http://wiki.jboss.org/wiki/HowToConfigureMavenForRichFaces">JBoss wiki article</ulink>. These Maven instructions can be copied and pasted into the command line interface to execute them.</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
mvn archetype:create
-DarchetypeGroupId=org.richfaces.cdk
-DarchetypeArtifactId=maven-archetype-plug-n-skin
@@ -2341,7 +2322,7 @@
-DartifactId=ARTIFACT-ID
-DgroupId=GROUP-ID
-Dversion=VERSION
-...]]></programlisting>
+...</programlisting>
<para>Primary keys for the command:</para>
<itemizedlist>
<listitem>
@@ -2366,10 +2347,10 @@
<para>This operation creates a directory named after your <literal>ARTIFACT-ID</literal>. The directory contains a template of the Maven project.</para>
<para>The following steps will guide you though creating of the skin itself. </para>
<para>Run the following command from the root directory of the Maven project. (This directory will contain your <filename>pom.xml</filename> file.)</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
mvn cdk:add-skin -Dname=SKIN-NAME -Dpackage=SKIN-PACKAGE
...
-]]></programlisting>
+</programlisting>
<para>Primary keys for the command:</para>
<itemizedlist>
<listitem>
@@ -2457,16 +2438,16 @@
<para>You can now start editing the XCSS files located in <filename>\src\main\resources\SKIN-PACKAGE\SKIN-NAME\css\</filename>. Assign new style properties to your selectors (listed in the XCSS files) in either of the following ways:</para>
<itemizedlist>
<listitem>
- <para>Standard CSS coding approach (that is, add CSS properties to the selectors). Remember that the selectors must be within <literal><f:verbatim> <![CDATA[ ...]]> </f:verbatim></literal> tags. For example:</para>
- <programlisting role="XML"><![CDATA[...
+ <para>Standard CSS coding approach (that is, add CSS properties to the selectors). Remember that the selectors must be within <literal><f:verbatim> </f:verbatim></literal> tags. For example:</para>
+ <programlisting role="XML">...
.rich-calendar-cell {
background: #537df8;
}
-...]]></programlisting>
+...</programlisting>
</listitem>
<listitem>
- <para> XCSS coding approach (the usual method of creating XCSS files in RichFaces). XCSS tags must be placed <emphasis>outside</emphasis> <literal><f:verbatim> <![CDATA[ ...]]> </f:verbatim></literal> tags. </para>
- <programlisting role="XML"><![CDATA[...
+ <para> XCSS coding approach (the usual method of creating XCSS files in RichFaces). XCSS tags must be placed <emphasis>outside</emphasis> <literal><f:verbatim> </f:verbatim></literal> tags. </para>
+ <programlisting role="XML">...
<u:selector name=".rich-calendar-cell">
<u:style name="border-bottom-color" skin="panelBorderColor"/>
<u:style name="border-right-color" skin="panelBorderColor"/>
@@ -2474,16 +2455,16 @@
<u:style name="font-size" skin="generalSizeFont"/>
<u:style name="font-family" skin="generalFamilyFont"/>
</u:selector>
-...]]></programlisting>
+...</programlisting>
</listitem>
</itemizedlist>
<para>Once you have performed these steps and edited the XCSS files, build the new skin and plug it into the project. To build the skin, execute the following command from the root directory of your skin project (the directory that contains your <filename>pom.xml</filename> file):</para>
<!--#modify seems a weird way of listing a command, but okay, you are the boss-->
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
mvn clean install
-...]]></programlisting>
+...</programlisting>
<para>The Plug-n-skin feature also has a number of predefined gradients. The following code can be used to apply a gradient:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<u:selector name=".rich-combobox-item-selected">
<u:style name="border-width" value="1px" />
<u:style name="border-style" value="solid" />
@@ -2497,20 +2478,20 @@
</f:resource>
</u:style>
</u:selector>
-...]]></programlisting>
+...</programlisting>
<para>The <varname>background-image</varname> CSS property is defined with <literal><f:resource f:key="org.richfaces.renderkit.html.CustomizeableGradient"></literal>, which sets the gradient. The gradient type can be specified in the <filename>SKIN-NAME.properties</filename> with the <varname>gradientType</varname> property, which can be set to <literal>glass</literal>, <literal>plastic</literal>, or <literal>plain</literal>. The gradient can then be adjusted with the <varname>baseColor</varname>, <varname>gradientColor</varname>, <varname>gradientHeight</varname>, <varname>valign</varname> attributes, as seen in the previous code snippet.</para>
<para>You can now use your newly-created skin in your project by adding your new skin parameters to the <filename>web.xml</filename> file, and placing the JAR file containing your skin (located in the <filename>target</filename> directory of your skin project) in the <filename>\WebContent\WEB-INF\lib\</filename>.</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<context-param>
<param-name>org.ajax4jsf.SKIN</param-name>
<param-value>SKIN-NAME</param-value>
</context-param>
-...]]></programlisting>
+...</programlisting>
<section>
<title>Details of Usage</title>
<para>This section covers some practical aspects of Plug-n-Skin implementation. We assume that you have read the section of the guide describing the Plug-n-Skin prototype creation process.</para>
<para>First, we must create a new skin (as described in the previous section). The following creates a template of the new skin project:</para>
- <programlisting role="XML"><![CDATA[
+ <programlisting role="XML">
mvn archetype:create
-DarchetypeGroupId=org.richfaces.cdk
-DarchetypeArtifactId=maven-archetype-plug-n-skin
@@ -2518,10 +2499,10 @@
-DartifactId=P-n-S
-DgroupId=GROUPID
-Dversion=1.0.-SNAPSHOT
-]]></programlisting>
+</programlisting>
<para>You can now browse the <filename>P-n-S</filename> directory to view the files and folders created.</para>
<para>Next, use Maven to add all required files to the skin project, like so:</para>
- <programlisting role="XML"><![CDATA[mvn cdk:add-skin -DbaseSkin=blueSky -DcreateExt=true -Dname=PlugnSkinDemo -Dpackage=SKINPACKAGE]]></programlisting>
+ <programlisting role="XML">mvn cdk:add-skin -DbaseSkin=blueSky -DcreateExt=true -Dname=PlugnSkinDemo -Dpackage=SKINPACKAGE</programlisting>
<para>As mentioned in the previous section, <!--#modify '-D' typo?--><literal>-DbaseSkin</literal> defines the RichFaces built-in skin to use as a base, and <literal>-DcreateExt=true</literal>, which determines that the new skin will include XCSS files that unify the appearance of the rich components and the standard HTML controls.</para>
<para>Once your resources have been created, you can begin refining the newly-created skin. Begin by editing the rich components' XCSS files.</para>
<para>As an example of the Plug-n-Skin feature, we will edit some <literal><rich:calendar></literal> style attributes and some basic HTML controls. We will show you how to:</para>
@@ -2536,10 +2517,10 @@
<para>To edit <literal><rich:properties></literal>'s style properties, you must open the <filename>calendar.xcss</filename> file, located in <filename>P-n-S\src\main\resources\skinpackage\plugnskindemo\css\</filename>.</para>
<para>In the <filename>calendar.xcss</filename> file, find the <literal>.rich-calendar-today</literal> selector and amend it as follows:<literal>background-color: #075ad1;</literal>. This will change the background color of the current day.</para>
<para>Next we will change the font style of a standard HTML <emphasis>submit</emphasis> button. Open the <filename>extended.xcss</filename> file from the <filename>P-n-S\src\main\resources\skinpackage\plugnskindemo\css\</filename> directory and insert <literal>font-weight: bold;</literal> between the curly braces of these selectors, like so:</para>
- <programlisting role="XML"><![CDATA[
+ <programlisting role="XML">
button[type="button"], button[type="reset"], button[type="submit"], input[type="reset"], input[type="submit"], input[type="button"] {
font-weight: bold;
-}]]></programlisting>
+}</programlisting>
<para>The desired changes have now been made, and you can proceed to building the new <literal>PlugnSkinDemo</literal> skin and importing it into the project.</para>
<para>Build the skin by executing <command>mvn clean install</command> from the <filename>P-n-S</filename> directory. This creates a <filename>target</filename> directory containing a JAR file with a newly-compiled skin. In our case, the file is named <filename>P-n-S-1.0.-SNAPSHOT.jar</filename>.</para>
<para>Next, import the new <literal>PlugnSkinDemo</literal> skin into your project:</para>
@@ -2549,17 +2530,17 @@
</listitem>
<listitem>
<para>Add the name of the new skin to the <filename>web.xml</filename> file, like so:</para>
- <programlisting role="XML"><![CDATA[ <context-param>
+ <programlisting role="XML"> <context-param>
<param-name>org.ajax4jsf.SKIN</param-name>
<param-value>PlugnSkinDemo</param-value>
-</context-param>]]></programlisting>
+</context-param></programlisting>
</listitem>
</itemizedlist>
<para>Remember, standard controls skinning must be enabled in <filename>web.xml</filename>. Add the following to enable standard controls skinning:</para>
- <programlisting role="XML"><![CDATA[<context-param>
+ <programlisting role="XML"><context-param>
<param-name>org.richfaces.CONTROL_SKINNING</param-name>
<param-value>enable</param-value>
-</context-param>]]></programlisting>
+</context-param></programlisting>
<para>The results of each alteration to the skin are shown in the figures that follow:</para>
<figure>
<title>Plug-n-Skin feature in action. </title>
@@ -2606,24 +2587,24 @@
<itemizedlist>
<listitem>
<para>Register the State Navigation Handler and the EL Resolver in your <filename>faces-config.xml</filename> file:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<application>
<navigation-handler>org.richfaces.ui.application.StateNavigationHandler</navigation-handler>
<el-resolver>org.richfaces.el.StateELResolver</el-resolver>
</application>
-...]]></programlisting>
+...</programlisting>
</listitem>
<listitem>
<para>Register an additional application factory in the <filename>faces-config.xml</filename>:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<factory>
<application-factory>org.richfaces.ui.application.StateApplicationFactory</application-factory>
</factory>
-...]]></programlisting>
+...</programlisting>
</listitem>
<listitem>
<para>Register two managed beans in the <filename>faces-config.xml</filename>:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<managed-bean>
<managed-bean-name>state</managed-bean-name>
<managed-bean-class>org.richfaces.ui.model.States</managed-bean-class>
@@ -2639,9 +2620,9 @@
<managed-bean-class>org.richfaces.demo.stateApi.Config</managed-bean-class>
<managed-bean-scope>none</managed-bean-scope>
</managed-bean>
-...]]></programlisting>
+...</programlisting>
<para>One bean (<literal>config</literal>) defines and stores <varname>State</varname> as seen in the following example:</para>
- <programlisting role="JAVA"><![CDATA[...
+ <programlisting role="JAVA">...
public class Config {
/**
@@ -2709,12 +2690,12 @@
return states;
}
}
-...]]></programlisting>
+...</programlisting>
<para>The second bean, with the <literal>org.richfaces.ui.model.States</literal> type (<literal>state</literal>), contains the managed property <property>states</property>, which is bound to the first <literal>config</literal> bean.</para>
</listitem>
<listitem>
<para>Next, use <property>state</property> bindings on the page, as in the following example:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<h:panelGrid columns="3">
<h:outputText value="username" />
<h:inputText value="#{state.bean.name}" id="name" required="true" />
@@ -2724,7 +2705,7 @@
<h:inputSecret value="#{state.bean.confirmPassword}" rendered="#{state.showConfirm}" id="confirm" required="true" />
</h:panelGrid>
<a4j:commandButton actionListener="#{state.action.listener}" action="#{state.ok}" value="#{state.okBtn}" id="action"/>
-...]]></programlisting>
+...</programlisting>
</listitem>
</itemizedlist>
<para>To see complete example of the Login/Register dialog, see the <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/stateAPI.jsf?c=stateAPI">RichFaces Live Demo</ulink>.</para>
@@ -2735,9 +2716,9 @@
<para>RichFaces also lets you check whether the logged-in user belongs to a certain <property>user role</property> with the <literal>rich:isUserInRole(Object)</literal> function. This function takes a String or a comma-delineated list of Strings, a Collection, etc. as arguments and returns a Boolean value.</para>
<para>As an example, imagine that you need to render some controls only for administrators. To do so, create an administrator role (<literal>admin</literal>) in your <filename>web.xml</filename> file. Then implement authorization that assigns the <literal>admin</literal> role to the user that has logged in as an administrator. Once this has been done, you can use the <literal>rich:isUserInRole(Object)</literal> function with the <varname>rendered</varname> attribute of any component. For example:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<rich:editor value="#{bean.text}" rendered="#{rich:isUserInRole('admin')}" />
-...]]></programlisting>
+...</programlisting>
<para>Here, only a logged-in user with an <literal>admin</literal> role can see the text editor, which will not be rendered for users with other roles.</para>
</section>
Modified: projects/docs/enterprise/5.0/RichFaces/en-US/Book_Info.xml
===================================================================
--- projects/docs/enterprise/5.0/RichFaces/en-US/Book_Info.xml 2009-10-28 06:19:57 UTC (rev 95659)
+++ projects/docs/enterprise/5.0/RichFaces/en-US/Book_Info.xml 2009-10-28 06:23:39 UTC (rev 95660)
@@ -7,8 +7,8 @@
<subtitle>for Use with JBoss Enterprise Application Platform</subtitle>
<productname>JBoss Enterprise Application Platform</productname>
<productnumber>5.0</productnumber>
- <edition>0</edition>
- <pubsnumber>0</pubsnumber>
+ <edition>1</edition>
+ <pubsnumber>1</pubsnumber>
<corpauthor>
<inlinemediaobject>
<imageobject>
Modified: projects/docs/enterprise/5.0/RichFaces/en-US/FAQ.xml
===================================================================
--- projects/docs/enterprise/5.0/RichFaces/en-US/FAQ.xml 2009-10-28 06:19:57 UTC (rev 95659)
+++ projects/docs/enterprise/5.0/RichFaces/en-US/FAQ.xml 2009-10-28 06:23:39 UTC (rev 95660)
@@ -49,7 +49,7 @@
<listitem>
<para>Open the <filename><Maven-Root>/conf/settings.xml</filename> file and add the following to the <literal><profile></literal> section:</para>
- <programlisting role="XML"><![CDATA[
+ <programlisting role="XML">
<id>RichFaces</id>
<repositories>
<repository>
@@ -110,9 +110,9 @@
<layout>default</layout>
</pluginRepository>
</pluginRepositories>
-]]></programlisting>
+</programlisting>
<para>Add the following to the <literal><activeProfiles></literal> section:</para>
- <programlisting role="XML"><![CDATA[<activeProfile>RichFaces</activeProfile>]]></programlisting>
+ <programlisting role="XML"><activeProfile>RichFaces</activeProfile></programlisting>
</listitem>
@@ -192,7 +192,7 @@
<section id="Organizewizards">
<title>How do I organize wizards with the <literal><rich:modalPanel></literal> component?</title>
<para>Place the <literal><a4j:include></literal> tag inside the <literal><rich:modalPanel></literal> and perform navigation inside it, as in the following example below:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<f:verbatim>
<a href="javascript:Richfaces.showModalPanel('_panel',{left:'auto', top:'auto'})">Show Modal Panel</a>
</f:verbatim>
@@ -232,7 +232,7 @@
</h:form>
...
-]]></programlisting>
+</programlisting>
<!--<para>The discussion about <emphasis role="bold">
<property><a4j:include></property>
</emphasis> and navigation rules can be found on the <ulink
@@ -326,7 +326,7 @@
<para><emphasis>Fast-switching</emphasis> controls: <literal>first</literal>, <literal>last</literal>, <literal>next</literal>, <literal>previous</literal>, <literal>fastforward</literal> and <literal>fastrewind</literal>.</para></listitem>
</itemizedlist>
<para>You can create fast-switching controls by adding a <literal>facet</literal> component with the corresponding name:</para>
- <programlisting role="XML"><![CDATA[ ...
+ <programlisting role="XML"> ...
<rich:datascroller for="table" maxPages="10">
<f:facet name="first">
<h:outputText value="First"/>
@@ -336,7 +336,7 @@
</f:facet>
</rich:datascroller>
...
-]]></programlisting>
+</programlisting>
<para>You can also create disabled states with facets
There are also facets used to create the disabled states: <literal>first_disabled</literal>, <literal>last_disabled</literal>, <literal>next_disabled</literal>, <literal>previous_disabled</literal>, <literal>fastforward_disabled</literal>, <literal>fastrewind_disabled</literal>. </para>
</section>
@@ -344,7 +344,7 @@
<section>
<title>How do I place simple links inside a menu?</title>
<para>To include a link to an external URL, use the following approach:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<rich:dropDownMenu>
...
<rich:menuItem submitMode="none"
@@ -356,7 +356,7 @@
...
</rich:dropDownMenu>
...
-]]></programlisting>
+</programlisting>
<para>You can also see a demonstration of the <literal><rich:dropDownMenu></literal> component at the <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/dropDownMenu.jsf">RichFaces LiveDemo page</ulink>.</para>
</section>
@@ -368,14 +368,14 @@
<section>
<title>How do I pass my own parameters during a <literal>modalPanel</literal> opening or closing?</title>
<para>You can pass your parameters during modalPanel opening or closing like so:</para>
- <programlisting role="JAVA"><![CDATA[Richfaces.showModalPanel('panelId', {left: auto}, {param1: value1});]]></programlisting>
+ <programlisting role="JAVA">Richfaces.showModalPanel('panelId', {left: auto}, {param1: value1});</programlisting>
<para>You can pass any of your own parameters, except for the standard <literal>modalPanel</literal> parameters.</para>
</section>
<section>
<title>How do I add a simple link to the tree node?</title>
<para>Use the following simple code:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<rich:tree ...>
...
<rich:treeNode submitMode="none"
@@ -387,7 +387,7 @@
...
</rich:tree ...>
...
-]]></programlisting>
+</programlisting>
</section>
<section>
@@ -398,7 +398,7 @@
<section>
<title>How can I use a <literal>commandButton</literal> within the <literal>modalPanel</literal>?</title>
<para>Use the following simple code:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<rich:modalPanel>
<f:facet name="header">
<h:outputText value="Test" />
@@ -411,7 +411,7 @@
</h:form>
</rich:modalPanel>
...
-]]></programlisting>
+</programlisting>
<para>
<note>
<para>There are two important rules to follow when using <literal>modalPanel</literal>:</para>
@@ -430,7 +430,7 @@
<section>
<title>How do I define the currently selected tab?</title>
<para>Use the following simple code:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<rich:tabPanel selectedTab="t2">
<rich:tab label="tab 1" name="t1">
<h:outputText value="tab 1" />
@@ -443,7 +443,7 @@
</rich:tab>
</rich:tabPanel>
...
-]]></programlisting>
+</programlisting>
</section>
<!--#modify outdated URLs-->
@@ -466,7 +466,7 @@
<section>
<title>How do I retrieve the current value from the <literal>inputNumberSlider</literal>?</title>
<para>You can retrieve the value with the following approach:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<rich:inputNumberSlider width="500" step="20"
onchange="someFunctionCall(this.input.value)"
minValue="0"
@@ -482,7 +482,7 @@
}
</script>
...
-]]></programlisting>
+</programlisting>
</section>
<section>
@@ -504,7 +504,7 @@
<section>
<title>Can I remove the table border and styles from the <literal>datascroller</literal> and show only links?</title>
<para>To do this, you must redefine your rich* classes, like so:</para>
- <programlisting role="CSS"><![CDATA[.rich-datascr-button {
+ <programlisting role="CSS">.rich-datascr-button {
border: 0px;
}
.rich-dtascroller-table {
@@ -512,7 +512,7 @@
}
.rich-datascr-button {
background-color: transparent;
-}]]></programlisting>
+}</programlisting>
</section>
<!--#modify outdated URL-->
@@ -567,7 +567,7 @@
<section>
<title>How do I use the JavaScript API?</title>
<para>Use the following simple code:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:form id="form">
<h:panelGroup id="test" columns="2" style="width: 300px">
<h:selectBooleanCheckbox value="#{bean.check}">
@@ -581,21 +581,21 @@
</h:panelGroup>
</a4j:form>
...
-]]></programlisting>
+</programlisting>
</section>
<section>
<title>How do I load the Scriptaculous library?</title>
<para>To load the whole Scriptaculous library shipped with RichFaces, use the <literal><a4j:loadScript></literal> tag:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:loadScript src="resource://scriptaculous.js" />
...
-]]></programlisting>
+</programlisting>
<para>This command lets you load an integrated version of the library that includes all existing Scriptaculous files, <emphasis>except</emphasis> <filename>unittest.js</filename>. If you do not want to load the whole library, but wish to load a specific file (for example, <filename>effect.js</filename>), use the following:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:loadScript src="resource://scriptaculous/effect.js" />
...
-]]></programlisting>
+</programlisting>
<para>If you load the whole library, you do not need to load a particular file.</para>
<!-- <para>For more information see <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&t=119044"
@@ -605,9 +605,9 @@
<section>
<title>How do I avoid the problem with text wrapping in <literal><rich:tab></literal> in Internet Explorer 7?</title>
<para>The problem lies with a tab height bug in IE7. (Tab height is correct in Firefox and in IE6.) To work around the bug, you can change the doctype declaration from:</para>
- <programlisting role="XML"><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">]]></programlisting>
+ <programlisting role="XML"><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"></programlisting>
<para>to:</para>
- <programlisting role="XML"><![CDATA[<!doctype html public "-//w3c//dtd html 4.0 transitional//en">]]></programlisting>
+ <programlisting role="XML"><!doctype html public "-//w3c//dtd html 4.0 transitional//en"></programlisting>
<para>You can also see the <ulink url="http://jira.jboss.com/jira/browse/RF-1011">JIRA Issue</ulink> for further information.</para>
</section>
@@ -619,7 +619,7 @@
<section>
<title>How do I send an additional parameter to the server with <literal><rich:suggestionbox></literal>?</title>
<para>This example code gives you one method:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<rich:suggestionbox width="200" height="200" for="test" suggestionAction="#{bean.autocomplete}" var="cap">
<h:column>
<f:facet name="header">
@@ -632,25 +632,25 @@
</a4j:support>
</rich:suggestionbox>
...
-]]></programlisting>
+</programlisting>
<para>In the example, the <literal>onselect</literal> event sends the selected value to the server. You can pass additional fields of the selected object (which do not belong to the <literal>fetchvalue</literal> attribute) in the same way.</para>
</section>
<section>
<title>How do I set the border of <literal><rich:dataTable></literal> to 0px?</title>
<para>Add the following code to your CSS file:</para>
- <programlisting role="CSS"><![CDATA[...
+ <programlisting role="CSS">...
.rich-table, .rich-table-header,.rich-table-headercell, .rich-table-cell, .rich-subtable-cell, .rich-table-footercell, .rich-subtable-footercell {
border-width:0px;
}
...
-]]></programlisting>
+</programlisting>
</section>
<section>
<title>How do I dynamically create a <literal><rich:suggestionbox></literal>?</title>
<para>The following code is a working example:</para>
- <programlisting role="JAVA"><![CDATA[...
+ <programlisting role="JAVA">...
org.apache.myfaces.component.html.ext.HtmlInputText searchBox = new org.apache.myfaces.component.html.ext.HtmlInputText();
searchBox.setId( "inputQuery" );
bar.getChildren().add( searchBox );
@@ -686,7 +686,7 @@
suggestions.getChildren().add( column );
bar.getChildren().add( suggestions );
...
-]]></programlisting>
+</programlisting>
<!--<para> See also <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4099047#4099047"
>RichFaces User Forum</ulink>.</para>-->
@@ -709,9 +709,9 @@
<section id="CheckSendingRequestConditions.CustomJavaScriptBeforeRequest.OnSubmitAttribute">
<title>How can I check request conditions before sending a request?</title>
<para>To check the terms of sending a request on a client, add the <literal>onSubmit</literal> attribute to all components, like so:</para>
- <programlisting role="XML"><![CDATA[<h:inputText id="i" value="#{beanText.kennung}">
+ <programlisting role="XML"><h:inputText id="i" value="#{beanText.kennung}">
<a4j:support event="onfocus" onsubmit="doSomething();" reRender="panelToReRender"/>
-</h:inputText>]]></programlisting>
+</h:inputText></programlisting>
<para>In this example, the <literal>doSomething()</literal> function is executed before the AJAX request, and if the function returns <literal>false</literal>, the request is not fired.</para>
<note>
<para>
@@ -735,7 +735,7 @@
<note>
<para>The onComplete syntax now follows this form:</para>
<programlisting role="XML">
- <![CDATA[<someAjaxActionComponent ...oncomplete="myFunc(req,event,data)".../>]]>
+ <someAjaxActionComponent ...oncomplete="myFunc(req,event,data)".../>
</programlisting>
<para>The <literal>event</literal> is a variable defining the location in which the JavaScript event that fires the request will be placed. <literal>data</literal> is a variable containing the deserialized value of the <varname>data</varname> attribute.</para>
</note>
@@ -779,9 +779,9 @@
<title>My form will not submit, or, my setter is not called after an AJAX request. What's wrong?</title>
<para>This can occur because of conversion or validation errors at submission time. To verify this, place the following update message inside a form:
</para>
- <programlisting role="XML"><![CDATA[<a4j:outputPanel ajaxRendered="true">
+ <programlisting role="XML"><a4j:outputPanel ajaxRendered="true">
<h:messages/>
-</a4j:outputPanel>]]></programlisting>
+</a4j:outputPanel></programlisting>
<para>The <literal><rich:message></literal> component has built-in AJAX support, and can be combined with the <ulink url="http://www.jsfone.com/blog/max_katz/2008/07/creating_jsf_phase_listener.html">JSF Phase Tracker</ulink> to fix this issue, in some instances.</para>
</section>
@@ -893,7 +893,7 @@
</listitem>
</orderedlist>
<para>Fpr example:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:outputPanel id="panel">
<h:panelGroup rendered="#{bean.rendered}">
<!--Some nested content to be hidden/shown depending on bean.rendered -->
@@ -902,7 +902,7 @@
...
<a4j:commandButton action=".." value=".." reRender="panel"/>
...
-]]></programlisting>
+</programlisting>
<para>This ensures that the wrapper component presents in the DOM tree, which means that its contents can be updated dynamically.</para>
</section>
@@ -948,7 +948,7 @@
need to point reRender on the specific rows. </para-->
<para>The <literal>ajaxKeys</literal> attribute defines Strings that are updated after an AJAX request, and lets you update several child components separately without updating the whole page.</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<a4j:poll interval="1000" action="#{repeater.action}" reRender="text">
<table>
<tbody>
@@ -963,13 +963,13 @@
</table>
</a4j:poll>
...
-]]></programlisting>
+</programlisting>
</section>
<section id="RowSelectionInScrollableDataTable">
<title>How can I enable row selection in a scrollableDataTable using <literal>one and multi-selection rows mode</literal>?</title>
<para>To enable row selection in <literal>one and multi-selection rows mode</literal>, you must use the <varname>selection</varname> attribute. In the example code that follows, when a user submits the form, the current collection of objects selected by the user is placed in the object's property. Upon completion, the <literal><rich:modalPanel></literal> will be rendered with the selected data.</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<h:form>
<rich:spacer height="30" />
<rich:scrollableDataTable rowKeyVar="rkv" frozenColCount="1" height="200px"
@@ -1028,10 +1028,10 @@
</rich:column>
</rich:dataTable>
</rich:modalPanel>
-...]]></programlisting>
+...</programlisting>
<para>
To build this application, you can create a managed bean like the one below. The <literal>takeSelection()</literal> method fills the <literal>selectedCars</literal> Array with data retrieved from the <varname>selection</varname>. The <literal>getSelectedCars()</literal> method returns <literal>selectedCars</literal> Array, which is then used to populate select rows of the <literal><rich:dataTable></literal>.</para>
- <programlisting role="JAVA"><![CDATA[...
+ <programlisting role="JAVA">...
public class DataTableScrollerBean {
private SimpleSelection selection = new SimpleSelection();
private ArrayList<DemoInventoryItem> selectedCars = new ArrayList<DemoInventoryItem>();
@@ -1060,7 +1060,7 @@
this.selectedCars = selectedCars;
}
}
-...]]></programlisting>
+...</programlisting>
<!-- <para>Some additional information about usage of <property>one and
multi-selection rows mode</property> can be found <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&t=122543"
@@ -1219,7 +1219,7 @@
<para>First, to enable row selection, see the previous section on <xref linkend="RowSelectionInScrollableDataTable" />.</para>
<para>
To enable the drag-and-drop function on a <literal>dataTable</literal>, use the <literal><rich:dragSupport></literal> and <literal><rich:dropSupport></literal> components, like so:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<rich:scrollableDataTable rowKeyVar="rkv" frozenColCount="1" height="400px" width="700px" id="carList" rows="40" columnClasses="col"
value="#{dataTableScrollerBean.allCars}" var="category" sortMode="single" selection="#{dataTableScrollerBean.selection}">
<rich:column id="make">
@@ -1301,10 +1301,10 @@
</rich:column>
</rich:dataTable>
</rich:panel>
-...]]></programlisting>
+...</programlisting>
<para>
The previous example is also available on the <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/scrollableDataTable.jsf">RichFaces LiveDemo</ulink> site. Only one method is added where the dropped collection is stored:</para>
- <programlisting role="JAVA"><![CDATA[...
+ <programlisting role="JAVA">...
public void dropListener(DropEvent event) {
System.out.println("Drop Listener Fired");
getDroppedCars().clear();
@@ -1314,14 +1314,14 @@
getDroppedCars().add(getAllCars().get(key.intValue()));
}
}
-...]]></programlisting>
+...</programlisting>
</section>
<section id="SimpleTogglePanelPanelMenuState">
<title>How can I save the state of the <rich:simpleTogglePanel>?</title>
<para>You can use the <varname>opened</varname> attribute responsible for storing panel state, and an <literal><a4j:support></literal> tag bound to <varname>onexpand</varname> and <varname>oncollapse</varname> events.</para>
<para>In the following example, when you click on the toggle icon, the <literal><rich:simpleTogglePanel></literal> icon appears and the current state is displayed in the <literal><rich:modalPanel></literal>. This state is remembered between page views. </para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<rich:simpleTogglePanel id="toggleP" label="simpleTogglePanel" switchType="client" width="600px" opened="#{bean.state}">
<a4j:support event="onexpand" actionListener="#{bean.stateTrue}" reRender="repeater" oncomplete="Richfaces.showModalPanel('myFrom:panel')" />
<a4j:support event="oncollapse" actionListener="#{bean.stateFalse}" reRender="repeater" oncomplete="Richfaces.showModalPanel('myFrom:panel')" />
@@ -1347,9 +1347,9 @@
<h:outputText value="Expanded simpleTogglePanel: " style="font-weight:bold;" />
<h:outputText value="#{bean.state}" id="repeater" />
</rich:modalPanel>
-...]]></programlisting>
+...</programlisting>
<para>To build this application, create a managed bean like so:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
public class bean {
private boolean state = false;
@@ -1370,14 +1370,14 @@
this.state = false;
}
}
-...]]></programlisting>
+...</programlisting>
</section>
<section id="PanelMenuGroupState">
<title>How can I save the state of <rich:panelMenuGroup>?</title>
<para>You can use the <varname>expanded</varname> attribute and an <literal><a4j:support></literal> tag bound to <varname>onexpand</varname> and <varname>oncollapse</varname> events.</para>
<para>In the following example, when you click on the toggle icon, the <literal><rich:panelMenuGroup></literal> expands and the current state is displayed in the <literal><rich:modalPanel></literal>. This state is remembered across page views. </para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<h:form id="myFrom">
<rich:panelMenu expandMode="ajax" iconExpandedTopGroup="chevronUp" iconCollapsedTopGroup="chevronDown">
<rich:panelMenuGroup label="Group 1" expanded="#{bean.state}">
@@ -1399,9 +1399,9 @@
<h:outputText value="#{bean.state}" id="repeater" />
</rich:modalPanel>
</h:form>
-...]]></programlisting>
+...</programlisting>
<para>To build this application, create a managed bean like so:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
public class bean {
private boolean state = false;
@@ -1422,13 +1422,13 @@
this.state = false;
}
}
-...]]></programlisting> </section>
+...</programlisting> </section>
<section id="RowSelectionInDataTable">
<title>How do I highlight the rows of a dataTable on the mouseover event?</title>
<para>Use the <literal>onRowMouseOver</literal> and <literal>onRowMouseOut</literal> attributes, like so:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<h:form>
<rich:dataTable onRowMouseOver="this.style.font = 'bold 20pt Arial'"
onRowMouseOut="this.style.font='#{a4jSkin.tableFont}'"
@@ -1513,7 +1513,7 @@
</f:facet>
</rich:dataTable>
</h:form>
-...]]> </programlisting>
+... </programlisting>
</section>
@@ -1521,7 +1521,7 @@
<title>How can I enable selecting the row of a <literal><rich:dataTable></literal> when I click on it, even if I click within the bounds of an <literal><h:inputText></literal>?</title>
<para>
Use the following JavaScript function to enable row selection when you click on the row:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<script type="text/javascript">
var oldRow;
function changeColor(row)
@@ -1534,9 +1534,9 @@
oldRow=row;
}
</script>
-...]]></programlisting>
+...</programlisting>
<para>You can then use <literal><a4j:support></literal> with <varname>event</varname> and <varname>onsubmit</varname> attributes, like so:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<h:form>
<rich:dataTable cellpadding="0" cellspacing="0"
width="700" border="0" var="record" value="#{report.expReport.records}">
@@ -1546,7 +1546,7 @@
...
</rich:dataTable>
</h:form>
-...]]></programlisting>
+...</programlisting>
</section>
@@ -1555,7 +1555,7 @@
<section id="reRenderCells">
<title>How do I rerender table cells with <a4j:support>?</title>
<para>To rerender table cells with <literal><a4j:support></literal>, set exact ID values for each component to be updated, and point this <varname>id</varname> to the <varname>reRender</varname> attribute.</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<rich:column>
<f:facet name="header">
<h:outputText value="Input1"/>
@@ -1576,7 +1576,7 @@
</f:facet>
<h:outputText id="output1" value="#{entry.output1}"/>
</rich:column>
-...]]></programlisting>
+...</programlisting>
<note>
<para>The value of the <varname>reRender</varname> attribute belonging to the <literal> <a4j:support></literal> tag defines the sections of the page that will be updated. In the previous example code, the only update made is to the <literal><h:outputText></literal> component in the footer, because its <literal>id</literal> value matches the value of the <varname>reRender</varname> attribute. You can update multiple elements on a page by listing their IDs as the value of the <varname>reRender</varname> attribute.</para>
</note>
@@ -1787,7 +1787,7 @@
<section id="DynamicColumns">
<title>How can I create dynamic columns?</title>
<para>You can create dynamic columns by using the <literal><rich:column></literal> with the <varname>rendered</varname> attribute. Set the value of the <varname>rendered</varname> attribute to match the ID of the dynamic cell, as in the following example code:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<ui:composition template="/WEB-INF/layout/template.xhtml">
<ui:define name="body">
<h2>Table</h2>
@@ -1829,9 +1829,9 @@
</h:form>
</ui:define>
</ui:composition>
-...]]></programlisting>
+...</programlisting>
<para>Alternatively, you could create a managed bean, like so:</para>
- <programlisting role="JAVA"><![CDATA[
+ <programlisting role="JAVA">
public class TableBackingRendered implements Serializable {
private static final long serialVersionUID = 1L;
private Random rand = new Random(System.currentTimeMillis());
@@ -1872,7 +1872,7 @@
this.tableData = tableData;
}
}
-...]]></programlisting>
+...</programlisting>
<!--para>Another solution when you are dealing with a significant amount of rows, if you are using facelets you can use c:forEach (jslt).</para>
<para>
<emphasis role="bold">Example:</emphasis>
@@ -1896,7 +1896,7 @@
<section id="Trinidad">
<title>How can I use RichFaces with Trinidad?</title>
<para>The following code is an example of a basic <filename>web.xml</filename> file that integrates RichFaces with Trinidad.</para>
- <programlisting role="XML"><![CDATA[
+ <programlisting role="XML">
<?xml version="1.0" ?>
<web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_5.xsd"
@@ -2011,7 +2011,7 @@
</welcome-file-list>
</web-app>
-]]></programlisting>
+</programlisting>
</section>
@@ -2020,12 +2020,12 @@
<title>Why do I see a JavaScript conflict?</title>
<para>Richfaces 3.1.3 uses version 1.6.0 of the <filename> prototype.js</filename> instead of version 1.5.1, which has been used in earlier versions. The source of the conflict is that two versions of the prototype script are included. The first is included as a dependency of the toggle panel components, and the second is included explicitly as a link.</para>
<para>RichFaces 3.1.3 is bundled with the same scripts included in Prototype 1.6.0 and Scriptaculous 1.8.0:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<context-param>
<param-name>org.richfaces.ExcludeScripts</param-name>
<param-value>Prototype,Scriptaculous</param-value>
</context-param>
-...]]></programlisting>
+...</programlisting>
<para>Using Prototype with RichFaces components can be problematic because issues that were fixed in version 1.6.0 were not always patched in version 1.5.1. When version 1.5.1 is used, some RichFaces components will not work as expected.</para>
</section>
@@ -2033,7 +2033,7 @@
<title>How do I use the <rich:fileUpload> component with the Seam Framework?</title>
<para>To use the <literal><rich:fileUpload></literal> component with the Seam Framework, define initialization parameters for the Seam Filter in your <filename>web.xml</filename> file. The Seam Framework will then automatically set the component up for the AJAX4JSF filter at start-up time.</para>
<para>The following code is an example of defining initialization parameters:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<filter>
<filter-name>Seam Filter</filter-name>
<filter-class>org.jboss.seam.servlet.SeamFilter</filter-class>
@@ -2046,7 +2046,7 @@
<param-value>200000</param-value>
</init-param>
</filter>
-...]]></programlisting>
+...</programlisting>
</section>
<section id="richfileUploadforMyFaces" role="new">
@@ -2055,7 +2055,7 @@
<note>
<para>To ensure that this sequence wors correctly, map the extension filter on your Faces Servlet, not to <filename>*.jsf</filename>.</para>
</note>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<!--Ajax filter definition-->
<filter>
<display-name>Ajax4jsf Filter</display-name>
@@ -2120,7 +2120,7 @@
<servlet-name>Faces Servlet</servlet-name>
<url-pattern>*.jsf</url-pattern>
</servlet-mapping>
-...]]></programlisting>
+...</programlisting>
</section>
<section id="suggestionboxObjectSelection">
@@ -2148,12 +2148,12 @@
<section id="viewExpiredException">
<title>How do I enable handling for ViewExpiredException?</title>
<para>This exception appears after your session has timed out. Because RichFaces 3.1 is intended for use with JavaServer Faces 1.1, <exceptionname>ViewExpiredException</exceptionname>s will not generate automatically when RichFaces is used with JavaServer Faces 1.2. To work around this limitation, add the following to your <filename>web.xml</filename> file:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<context-param>
<param-name>com.sun.faces.enableRestoreView11Compatibility</param-name>
<param-value>true</param-value>
</context-param>
-...]]></programlisting>
+...</programlisting>
</section>
@@ -2168,17 +2168,17 @@
<para>
Add the following code to your <filename>web.xml</filename>:
</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<context-param>
<param-name>org.ajax4jsf.handleViewExpiredOnClient</param-name>
<param-value>true</param-value>
</context-param>
-...]]></programlisting>
+...</programlisting>
</listitem>
<listitem>
<para>
Add custom <literal>onError</literal> and <literal>onExpire</literal> handlers, like so:</para>
- <programlisting role="Java"><![CDATA[...
+ <programlisting role="Java">...
A4J.AJAX.onError = function(req,status,message){
window.alert("Custom onError handler "+message);
}
@@ -2189,7 +2189,7 @@
return false;
}
}
-...]]></programlisting>
+...</programlisting>
<para>
For a more detailed description of this process, see <xref linkend="RequestErrorsAndSessionExpirationHandling" /> in the Developer Guide.
</para>
@@ -2199,12 +2199,12 @@
<para>
Custom <literal>onError</literal> and <literal>onExpire</literal> handlers will not work under MyFaces, because MyFaces handles exceptions with an internally-generated debug page. To prevent this behavior, use the following code:
</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<context-param>
<param-name>org.apache.myfaces.ERROR_HANDLING</param-name>
<param-value>false</param-value>
</context-param>
-...]]></programlisting>
+...</programlisting>
</note>
</section>
@@ -2214,7 +2214,7 @@
<title>How can I add a cookie in an AJAX response?</title>
<para>
The bean described below adds a cookie to an AJAX response:</para>
- <programlisting role="JAVA"><![CDATA[...
+ <programlisting role="JAVA">...
public class CookieBean {
private String testCookie = null;
@@ -2241,11 +2241,11 @@
return null;
}
}
-...]]></programlisting>
+...</programlisting>
<para>
Alternatively, you can define the cookie to be included as shown in the following example. After the <literal>test</literal> cookie is set, the value of that cookie will appear on a page.
</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<h:form>
<h:outputText id="text" value="Cookie value: #{cookieBean.testCookie}"/>
<br />
@@ -2253,7 +2253,7 @@
<a4j:support event="oncomplete" reRender="text" />
</a4j:commandButton>
</h:form>
-...]]></programlisting>
+...</programlisting>
</section>
@@ -2281,7 +2281,7 @@
<para>
To launch the RichFaces sample application on the JBoss server, add the following code to your <filename>web.xml</filename>:
</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<context-param>
<param-name>org.jboss.jbossfaces.WAR_BUNDLES_JSF_IMPL</param-name>
<param-value>true</param-value>
@@ -2305,7 +2305,7 @@
...
<rich:menuItem style="display: {cd};" value="Launch Craft" disabled="true" submitMode="none"/>
<rich:menuItem style="display: {ce};" value="Launch Craft" disabled="false" onclick="launchcrft('{crft}');"/>
-...]]></programlisting>
+...</programlisting>
<para>Use <code>'block'</code> instead of <code>' '</code> to avoid <literal>invalid style</literal> CSS errors.</para>
</section>
</chapter>
Modified: projects/docs/enterprise/5.0/RichFaces/en-US/Getting_Started.xml
===================================================================
--- projects/docs/enterprise/5.0/RichFaces/en-US/Getting_Started.xml 2009-10-28 06:19:57 UTC (rev 95659)
+++ projects/docs/enterprise/5.0/RichFaces/en-US/Getting_Started.xml 2009-10-28 06:23:39 UTC (rev 95660)
@@ -40,7 +40,7 @@
<title>Registering RichFaces in <filename>web.xml</filename></title>
<para>After you add the RichFaces libraries to the project, you must register them in the project <filename>web.xml</filename> file. Add the following to <filename>web.xml</filename>:</para>
<programlisting role="XML">
-<![CDATA[...
+...
<!-- Plugging the "Blue Sky" skin into the project -->
<context-param>
<param-name>org.richfaces.SKIN</param-name>
@@ -67,12 +67,12 @@
<dispatcher>FORWARD</dispatcher>
<dispatcher>INCLUDE</dispatcher>
</filter-mapping>
-...]]>
+...
</programlisting>
<para>For more information about RichFaces skins, read <xref linkend="Skinnability" />.</para>
<para>Finally, your <filename>web.xml</filename> should look like this: </para>
<programlisting role="XML">
-<![CDATA[<?xml version="1.0"?>
+<?xml version="1.0"?>
<web-app version="2.5"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -128,7 +128,7 @@
<login-config>
<auth-method>BASIC</auth-method>
</login-config>
-</web-app>]]>
+</web-app>
</programlisting>
</section>
@@ -153,7 +153,7 @@
<title>Registering the bean in <filename>faces-cofig.xml</filename></title>
<para>To register the <literal>user</literal> bean, add the following to the <filename>faces-config.xml</filename> file: </para>
<programlisting role="XML">
-<![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="UTF-8"?>
<faces-config version="1.2"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xi="http://www.w3.org/2001/XInclude"
@@ -171,15 +171,13 @@
</managed-property>
</managed-bean>
</faces-config>
-]]>
</programlisting>
</section>
<section id="RichFacesGreeterindex">
<title>RichFaces Greeter index.jsp</title>
<para><application>RichFaces Greeter</application> has only one JSP page. Create <filename>index.jsp</filename> in the root of <literal>WEB CONTENT</literal> folder and add the following to the JSP file:</para>
- <programlisting role="XML">
-<![CDATA[<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
+ <programlisting role="XML"><!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
<!-- RichFaces tag library declaration -->
@@ -210,13 +208,13 @@
</a4j:form>
</f:view>
</body>
-</html>]]>
+</html>
</programlisting>
<para>The application uses three RichFaces components: <emphasis role="bold"><property><rich:panel></property></emphasis> is used as visual container for information; <emphasis role="bold"><property><a4j:commandButton></property></emphasis> with built-in AJAX support lets a greeting be rendered dynamically after a response returns; and <emphasis role="bold"><property><a4j:form></property></emphasis> helps the button to perform the action.</para>
<note>
<para>The RichFaces tag library should be declared on each JSP page. For XHTML pages, add the following lines to declare your tag libraries:</para>
- <programlisting role="XML"><![CDATA[<xmlns:a4j="http://richfaces.org/a4j">
-<xmlns:rich="http://richfaces.org/rich">]]></programlisting>
+ <programlisting role="XML"><xmlns:a4j="http://richfaces.org/a4j">
+<xmlns:rich="http://richfaces.org/rich"></programlisting>
<para>Now, run the application on the server by pointing your browser to the <filename>index.jsp</filename> page: <literal>http://localhost:8080/Greeter/index.jsf</literal>
</para>
<figure>
@@ -238,8 +236,7 @@
<para>To create the project structure and populate it with basic content, we use the <literal>maven-archetype-jsfwebapp</literal> Maven archetype, which is a part of the RichFaces CDK.</para>
<para>The <literal>maven-archetype-jsfwebapp</literal> archetype and the project itself require extra repositories: <literal>http://snapshots.jboss.org/maven2/</literal> and <literal>http://repository.jboss.com/maven2/</literal>. The easist way to make these repositories visible to Maven is to create a profile in <filename>maven_installation_folder/conf/settings.xml</filename>. Add the following beneath the <literal><profiles></literal> element:</para>
- <programlisting role="XML"><![CDATA[
-<profile>
+ <programlisting role="XML"><profile>
<id>jsf-app-profile</id>
<repositories>
<repository>
@@ -269,21 +266,18 @@
<layout>default</layout>
</repository>
</repositories>
-</profile>
- ]]></programlisting>
+</profile></programlisting>
<para>Once you have added the profile, you must also activate it. Add the following beneath the <literal><activeProfiles></literal> element.</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<activeProfiles>
<activeProfile>jsf-app-profile</activeProfile>
-</activeProfiles>
-...]]></programlisting>
+</activeProfiles></programlisting>
<para>This fulfills the requirements for creating a project using the <literal>maven-archetype-jsfwebapp</literal> archetype. Create a directory for your project and run the following command from within the directory:</para>
- <programlisting role="XML" ><![CDATA[...
-mvn archetype:generate -DarchetypeGroupId=org.richfaces.cdk -DarchetypeArtifactId=maven-archetype-jsfwebapp -DarchetypeVersion=3.3.1.GA -DgroupId=org.docs.richfaces -DartifactId=jsf-app
-...]]></programlisting>
+ <programlisting role="XML" >...
+mvn archetype:generate -DarchetypeGroupId=org.richfaces.cdk -DarchetypeArtifactId=maven-archetype-jsfwebapp -DarchetypeVersion=3.3.1.GA -DgroupId=org.docs.richfaces -DartifactId=jsf-app</programlisting>
<para>You can adjust some parameters of the command.</para>
@@ -314,7 +308,7 @@
<para>This command generates a JSF project that has the following structure:</para>
- <programlisting role="XML"><![CDATA[
+ <programlisting role="XML">
jsf-app
|-- pom.xml
`-- src
@@ -339,14 +333,14 @@
`-- docs
`-- richfaces
`-- BeanTest.java
- ]]></programlisting>
+</programlisting>
<para>
Go to the <literal>jsf-app</literal> folder and open the project descriptor, <filename>pom.xml</filename> to edit and add dependencies. The <literal><dependencies></literal> element should contain at least the following:
</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<dependencies>
<dependency>
<groupId>junit</groupId>
@@ -420,8 +414,7 @@
<artifactId>richfaces-ui</artifactId>
<version>3.3.1.GA</version>
</dependency>
-</dependencies>
-...]]></programlisting>
+</dependencies></programlisting>
<para>The final three dependencies add RichFaces libraries to the project. You can now build the project by running the <code>mvn install</code> command.</para>
<para>When you see <literal>BUILD SUCCESSFUL</literal>, the project is assembled. It can now be imported to an IDE and run on the server.</para>
@@ -429,13 +422,13 @@
<para>Once the project is built, you can import it into Eclipse. Then, open <filename>jsf-app/src/main/webapp/WEB-INF/web.xml</filename> to configure it according to the listing under <!--#retag--><xref linkend="RegisteringRichFacesinwebxml" />.</para>
<para>The project is now configured and now you can start using RichFaces. Open <filename>jsf-app/src/main/webapp/pages/index.jsp</filename> and add the following tag library declaration.</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<%@ taglib uri="http://richfaces.org/rich" prefix="rich"%>
-...]]></programlisting>
+...</programlisting>
<para>If you add some RichFaces component to the <filename>index.jsp</filename> page (<literal><rich:calendar></literal>, for instance), your <filename>index.jsp</filename> page will look like this:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f"%>
<%@ taglib uri="http://richfaces.org/rich" prefix="rich"%>
@@ -449,7 +442,7 @@
</f:view>
</body>
</html>
-...]]></programlisting>
+...</programlisting>
<para>You can now run the application on the Tomcat server and open it in your preferred browser by pointing the browser to <literal>http://localhost:8080/jsf-app/</literal>.</para>
</section>
Modified: projects/docs/enterprise/5.0/RichFaces/en-US/Revision_History.xml
===================================================================
--- projects/docs/enterprise/5.0/RichFaces/en-US/Revision_History.xml 2009-10-28 06:19:57 UTC (rev 95659)
+++ projects/docs/enterprise/5.0/RichFaces/en-US/Revision_History.xml 2009-10-28 06:23:39 UTC (rev 95660)
@@ -5,6 +5,25 @@
<appendix id="appe-Publican-Revision_History">
<title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>1.1</revnumber>
+ <date>Tue Oct 27 2009</date>
+ <author>
+ <firstname>Laura</firstname>
+ <surname>Bailey</surname>
+ <email>lbailey at redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Applied changes from
+JBPAPP-2980.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
<simpara>
<revhistory>
<revision>
Modified: projects/docs/enterprise/5.0/RichFaces/en-US/RichFaces_Developer_Guide.xml
===================================================================
--- projects/docs/enterprise/5.0/RichFaces/en-US/RichFaces_Developer_Guide.xml 2009-10-28 06:19:57 UTC (rev 95659)
+++ projects/docs/enterprise/5.0/RichFaces/en-US/RichFaces_Developer_Guide.xml 2009-10-28 06:23:39 UTC (rev 95660)
@@ -5,12 +5,12 @@
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Technical_Requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!--<xi:include href="Technical_Requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
<xi:include href="Getting_Started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Settings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Architecture_Overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="IDE_Support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Links_to_Resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!--<xi:include href="IDE_Support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
+ <!--<xi:include href="Links_to_Resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<index />
</book>
Modified: projects/docs/enterprise/5.0/RichFaces/en-US/Settings.xml
===================================================================
--- projects/docs/enterprise/5.0/RichFaces/en-US/Settings.xml 2009-10-28 06:19:57 UTC (rev 95659)
+++ projects/docs/enterprise/5.0/RichFaces/en-US/Settings.xml 2009-10-28 06:23:39 UTC (rev 95660)
@@ -188,32 +188,32 @@
</para>
<para>You can find more information about <exceptionname>ViewExpiredException</exceptionname>s when you use RichFaces with JSF 1.2_12 in the <ulink url="http://wiki.jboss.org/auth/wiki//RichFacesCookbook/ViewExpiredException">RichFaces Cookbook</ulink> article.</para>
- </section>
- <section id="ApacheMyFaces">
- <title>Apache MyFaces</title>
- <para>RichFaces works with <application>Apache MyFaces</application> 1.2.5 through specific libraries like TOMAHAWK Sandbox and Trinidad. However, there are several issues to consider when you configure applications to work with MyFaces and RichFaces.</para>
- <note>
- <para>
- Sometimes, filters defined in <filename>web.xml</filename> clash, which can be problematic. To avoid this, the RichFaces filter must be the first filter listed in the <filename>web.xml</filename> configuration file.
- </para>
- </note>
- <note>
- <para>There is one other issue with using MyFaces and <application>Seam</application>. <literal><f:view></literal> does not resolve correctly in MyFaces, so if you use this combination, you should wrap the contents of your <literal><f:view></literal> tags with <literal><a4j:page></literal>. We are working on a solution to this problem.</para>
- </note>
- <para>For more information, see: <ulink url="http://myfaces.apache.org"> http://myfaces.apache.org</ulink></para>
-
- </section>
+ </section>
+ <section id="ApacheMyFaces">
+ <title>Apache MyFaces</title>
+ <para>RichFaces works with <application>Apache MyFaces</application> 1.2.5 through specific libraries like TOMAHAWK Sandbox and Trinidad. However, there are several issues to consider when you configure applications to work with MyFaces and RichFaces.</para>
+ <note>
+ <para>
+ Sometimes, filters defined in <filename>web.xml</filename> clash, which can be problematic. To avoid this, the RichFaces filter must be the first filter listed in the <filename>web.xml</filename> configuration file.
+ </para>
+ </note>
+ <note>
+ <para>There is one other issue with using MyFaces and <application>Seam</application>. <literal><f:view></literal> does not resolve correctly in MyFaces, so if you use this combination, you should wrap the contents of your <literal><f:view></literal> tags with <literal><a4j:page></literal>. We are working on a solution to this problem.</para>
+ </note>
+ <para>For more information, see: <ulink url="http://myfaces.apache.org"> http://myfaces.apache.org</ulink></para>
+
+ </section>
<section id="FaceletsSupport">
<title>Facelets Support</title>
<para>RichFaces has high-level support for Facelets, regardless of the version used. However, some JSF frameworks (including Faces) require that their own <literal>ViewHandler</literal> be listed first in the <literal>ViewHandler</literal> chain. RichFaces also requires that its <literal>AjaxViewHandler</literal> be listed first, but because it is installed first, no settings will need to be altered. Where multiple frameworks are used without RichFaces, you can use the <literal>VIEW_HANDLERS</literal> parameter to define the order in which the <literal>ViewHandler</literal>s are used. For example:</para>
<programlisting role="XML">
-<![CDATA[...
+...
<context-param>
<param-name>org.ajax4jsf.VIEW_HANDLERS</param-name>
<param-value>com.sun.facelets.FaceletViewHandler</param-value>
</context-param>
-...]]>
+...
</programlisting>
<para>This declares that while <literal>Facelets</literal> will officially be first, <literal>AjaxViewHandler</literal> will briefly be ahead of it to perform some small, important task.</para>
<note>
@@ -226,7 +226,7 @@
<para>For <application>Seam 1.2</application>, your <filename>web.xml</filename> must be as follows:</para>
<programlisting role="XML">
-<![CDATA[<?xml version="1.0" ?>
+<?xml version="1.0" ?>
<web-app xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
@@ -299,12 +299,12 @@
<servlet-name>Faces Servlet</servlet-name>
<url-pattern>*.seam</url-pattern>
</servlet-mapping>
-</web-app>]]>
+</web-app>
</programlisting>
<para><application>Seam 2.x</application> supports RichFaces Filter, so your <filename>web.xml</filename> must look like this:</para>
<programlisting role="XML">
-<![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -363,7 +363,7 @@
<servlet-name>Faces Servlet</servlet-name>
<url-pattern>*.seam</url-pattern>
</servlet-mapping>
-</web-app>]]>
+</web-app>
</programlisting>
<para>There is one limitation to using Seam with MyFaces. See <xref linkend="ApacheMyFaces" /> for details.</para>
@@ -379,25 +379,25 @@
<para>There is one change required to use EAServer. EAServer calls Servlet <literal>init()</literal> before <literal>ServletContextInitializer</literal>. (This is part of the Servlet 2.3 specification, not an EAServer bug.) You must change the value of <literal>load-on-startup</literal> for the Faces Servlet to <literal>0</literal> in <filename>web.xml</filename>: </para>
<programlisting role="XML">
-<![CDATA[...
+...
<servlet>
<servlet-name>Faces Servlet</servlet-name>
<servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
<load-on-startup>0</load-on-startup>
</servlet>
-...]]>
+...
</programlisting>
</section>
<section id="OracleAS_OC4J">
<title>Oracle AS/OC4J</title>
<para>To deploy your project with RichFaces components to an Oracle Application Server, you must prevent the application's class loader from importing the Oracle XML parser. Use the following notation in <filename>orion-application.xml</filename>:</para>
- <programlisting role="XML"><![CDATA[...
+ <programlisting role="XML">...
<imported-shared-libraries>
<remove-inherited name="oracle.xml"/>
<remove-inherited name="oracle.xml.security"/>
</imported-shared-libraries>
-...]]></programlisting>
+...</programlisting>
</section>
</chapter>
More information about the jboss-cvs-commits
mailing list