Author: SeanRogers Date: 2010-06-23 01:58:27 -0400 (Wed, 23 Jun 2010) New Revision: 17661 Modified: root/docs/trunk/Component_Reference/en-US/Component_Reference.xml root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Actions.xml root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Containers.xml root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Resources.xml root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tables_and_grids.xml Log: Clean up after A2 release Modified: root/docs/trunk/Component_Reference/en-US/Component_Reference.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/Component_Reference.xml 2010-06-22 23:05:28 UTC (rev 17660) +++ root/docs/trunk/Component_Reference/en-US/Component_Reference.xml 2010-06-23 05:58:27 UTC (rev 17661) @@ -14,8 +14,10 @@ <xi:include href="chap-Component_Reference-Actions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Containers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -<!-- FIXME NOT IN A2 --> -<!-- <xi:include href="chap-Component_Reference-Validation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> + <!-- FIXME NOT IN A2 --> + <!-- + <xi:include href="chap-Component_Reference-Validation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + --> <xi:include href="chap-Component_Reference-Processing_management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </part> <part id="part-Component_Reference-rich_tag_library"> @@ -28,16 +30,17 @@ <!-- <xi:include href="chap-Component_Reference-Trees.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Menus_and_toolbars.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - --> - <!-- FIXME NOT IN A2 - <xi:include href="chap-Component_Reference-Output_and_messages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> - <!-- + --> + <!-- FIXME NOT IN A2 --> + <!-- + <xi:include href="chap-Component_Reference-Output_and_messages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Drag_and_drop.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Layout_and_appearance.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - --><xi:include href="chap-Component_Reference-Functions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + --> + <xi:include href="chap-Component_Reference-Functions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <!-- <xi:include href="chap-Component_Reference-Functionality_extension.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - --> + --> </part> <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </book> Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Actions.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Actions.xml 2010-06-22 23:05:28 UTC (rev 17660) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Actions.xml 2010-06-23 05:58:27 UTC (rev 17661) @@ -74,36 +74,36 @@ </para> </section> -<!-- TODO NOT IN A2 --> -<!-- <section id="sect-Component_Reference-Actions-a4jajaxListener">--> -<!-- <title><sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- listener-class: <classname>org.ajax4jsf.event.AjaxListener</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- event-class: <classname>org.ajax4jsf.event.AjaxEvent</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- tag-class: <classname>org.ajax4jsf.taglib.html.jsp.AjaxListenerTag</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag> component adds an action listener to a parent component. It works similar to the JavaServer Faces <sgmltag>&lt;f:actionListener&gt;</sgmltag> or <sgmltag>&lt;f:valueChangeListener&gt;</sgmltag> components, except that the invocation of <sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag> is not canceled if validation of the <emphasis>Update Model</emphasis> phase fails. The <sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag> component is guaranteed to be invoked with each Ajax response.--> -<!-- </para>--> -<!-- <para>--> -<!-- Basic usage requires only the <varname>type</varname> attribute, which defines the fully-qualified Java class name for the listener. This Java class should implement the <classname>org.ajax4jsf.event.AjaxListener</classname> interface, which is a base listener for all listeners and is capable of receiving Ajax events. The object from which the event originated could be accessed using the <methodname>java.util.EventObject.getSource()</methodname> method.--> -<!-- </para>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag> component is not invoked for non-Ajax requests, or when the RichFaces works in the <emphasis>Ajax request generates non-Ajax response</emphasis> mode, so the <sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag> invocation is a good indicator that an Ajax response is going to be processed.--> -<!-- </para>--> -<!-- </section>--> + <!-- TODO NOT IN A2 --> + <section id="sect-Component_Reference-Actions-a4jajaxListener"> + <title><sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + listener-class: <classname>org.ajax4jsf.event.AjaxListener</classname> + </para> + </listitem> + <listitem> + <para> + event-class: <classname>org.ajax4jsf.event.AjaxEvent</classname> + </para> + </listitem> + <listitem> + <para> + tag-class: <classname>org.ajax4jsf.taglib.html.jsp.AjaxListenerTag</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag> component adds an action listener to a parent component. It works similar to the JavaServer Faces <sgmltag>&lt;f:actionListener&gt;</sgmltag> or <sgmltag>&lt;f:valueChangeListener&gt;</sgmltag> components, except that the invocation of <sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag> is not canceled if validation of the <emphasis>Update Model</emphasis> phase fails. The <sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag> component is guaranteed to be invoked with each Ajax response. + </para> + <para> + Basic usage requires only the <varname>type</varname> attribute, which defines the fully-qualified Java class name for the listener. This Java class should implement the <classname>org.ajax4jsf.event.AjaxListener</classname> interface, which is a base listener for all listeners and is capable of receiving Ajax events. The object from which the event originated could be accessed using the <methodname>java.util.EventObject.getSource()</methodname> method. + </para> + <para> + The <sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag> component is not invoked for non-Ajax requests, or when the RichFaces works in the <emphasis>Ajax request generates non-Ajax response</emphasis> mode, so the <sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag> invocation is a good indicator that an Ajax response is going to be processed. + </para> + </section> <section id="sect-Component_Reference-Actions-a4jcommandButton"> <title><sgmltag>&lt;a4j:commandButton&gt;</sgmltag></title> @@ -328,40 +328,39 @@ Incomplete </para> </section> + + <section id="sect-Component_Reference-Actions-a4jhtmlCommandLink"> + <title><sgmltag>&lt;a4j:htmlCommandLink&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.ajax4jsf.HtmlCommandLink</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>javax.faces.Command</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.ajax4jsf.component.html.HtmlCommandLink</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.ajax4jsf.HtmlCommandLinkRenderer</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;a4j:htmlCommandLink&gt;</sgmltag> component functions similarly to the standard <sgmltag>&lt;h:commandLink&gt;</sgmltag> component, but addresses some of the potential issues that can occur. + </para> + <para> + When using the standard component, hidden fields were not rendered to child elements if they were deemed unnecessary, so command links relating to content on the initial page could become broken if they were later updated through Ajax. The <sgmltag>&lt;a4j:htmlCommandLink&gt;</sgmltag> component addresses this by always rendering all hidden fields. + </para> + </section> -<!-- FIXME NOT IS A2 --> -<!-- <section id="sect-Component_Reference-Actions-a4jhtmlCommandLink">--> -<!-- <title><sgmltag>&lt;a4j:htmlCommandLink&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.ajax4jsf.HtmlCommandLink</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>javax.faces.Command</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.ajax4jsf.component.html.HtmlCommandLink</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- renderer-type: <classname>org.ajax4jsf.HtmlCommandLinkRenderer</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:htmlCommandLink&gt;</sgmltag> component functions similarly to the standard <sgmltag>&lt;h:commandLink&gt;</sgmltag> component, but addresses some of the potential issues that can occur.--> -<!-- </para>--> -<!-- <para>--> -<!-- When using the standard component, hidden fields were not rendered to child elements if they were deemed unnecessary, so command links relating to content on the initial page could become broken if they were later updated through Ajax. The <sgmltag>&lt;a4j:htmlCommandLink&gt;</sgmltag> component addresses this by always rendering all hidden fields.--> -<!-- </para>--> -<!-- </section>--> - <section id="sect-Component_Reference-Actions-a4jjsFunction"> <title><sgmltag>&lt;a4j:jsFunction&gt;</sgmltag></title> <itemizedlist> Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Containers.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Containers.xml 2010-06-22 23:05:28 UTC (rev 17660) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Containers.xml 2010-06-23 05:58:27 UTC (rev 17661) @@ -7,109 +7,109 @@ This chapter details those components in the <classname>a4j</classname> tag library which define an area used as a container or wrapper for other components. </para> <!-- FIXME NOT IN A2 --> -<!-- <section id="sect-Component_Reference-Containers-a4jform">--> -<!-- <title><sgmltag>&lt;a4j:form&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.ajax4jsf.Form</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>javax.faces.Form</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.ajax4jsf.component.html.AjaxForm</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- renderer-type: <classname>org.ajax4jsf.FormRenderer</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:form&gt;</sgmltag> builds on the functionality of the JavaServer Faces (<acronym>JSF</acronym>) component <sgmltag>&lt;h:form&gt;</sgmltag>, adding Ajax capabilities to the form.--> -<!-- </para>--> -<!-- <note>--> -<!-- <title>Command link rendering fixed</title>--> -<!-- <para>--> -<!-- The <acronym>JSF</acronym> component <sgmltag>&lt;h:form&gt;</sgmltag>, on which the <sgmltag>&lt;a4j:form&gt;</sgmltag> component is based, had an issue whereby the <sgmltag>&lt;h:commandLink&gt;</sgmltag> component could not be re-rendered without re-rendering the entire form. <sgmltag>&lt;a4j:form&gt;</sgmltag> and <sgmltag>&lt;a4j:commandLink&gt;</sgmltag> fix this issue.--> -<!-- </para>--> -<!-- </note>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:form&gt;</sgmltag> component can add indirect Ajax support to non-Ajax components on the form by setting <code>ajaxSubmit="true"</code>. It then uses the standard Ajax component attributes and updates components specified with the <varname>render</varname> attribute.--> -<!-- </para>--> -<!-- <important>--> -<!-- <title><varname>ajaxSubmit</varname></title>--> -<!-- <para>--> -<!-- <sgmltag>&lt;a4j:form&gt;</sgmltag> should not use <code>ajaxSubmit="true"</code> if it contains other Ajax-capable components.--> -<!-- </para>--> -<!-- <para>--> -<!-- Additionally, due to security reasons the file upload form element cannot be indirectly made Ajax-capable with <sgmltag>&lt;a4j:form&gt;</sgmltag>.--> -<!-- </para>--> -<!-- </important>--> -<!-- </section>--> -<!-- --> -<!-- <section id="sect-Component_Reference-Containers-a4jinclude">--> -<!-- <title><sgmltag>&lt;a4j:include&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.ajax4jsf.Include</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>javax.faces.Output</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.ajax4jsf.component.html.Include</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- renderer-type: <classname>org.ajax4jsf.components.AjaxIncludeRenderer</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:include&gt;</sgmltag> component allows one view to be included as part of another page. This is useful for applications where multiple views might appear on the one page, with navigation between the views. Views can use partial page navigation in Ajax mode, or standard <acronym>JSF</acronym> navigation for navigation between views.--> -<!-- </para>--> -<!-- <para>--> -<!-- The <varname>viewId</varname> attribute is required to reference the resource that will be included as a view on the page. It uses a full context-relative path to point to the resource, similar to the paths used for the <sgmltag>&lt;from-view-id&gt;</sgmltag> and <sgmltag>&lt;to-view-id&gt;</sgmltag> tags in the <filename>faces-config.xml</filename> <acronym>JSF</acronym> navigation rules.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-a4jinclude-A_wizard_using_a4jinclude">--> -<!-- <title>A wizard using <sgmltag>&lt;a4j:include&gt;</sgmltag></title>--> -<!-- <para>--> -<!-- The page uses <sgmltag>&lt;a4j:include&gt;</sgmltag> to include the first step of the wizard:--> -<!-- </para>--> -<!-- --> -<!--<programlisting language="XML" role="XML">--> -<!--<xi:include href="extras/exam-Component_Reference-a4jinclude-A_wizard_using_a4jinclude-0.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />--> -<!--</programlisting>--> -<!-- <para>--> -<!-- The first step is fully contained in a separate file, <filename>wstep1.xhtml</filename>. Subsequent steps are set up similarly with additional <guibutton>Previous</guibutton> buttons.--> -<!-- </para>--> -<!-- --> -<!--<programlisting language="XML" role="XML">--> -<!--<xi:include href="extras/exam-Component_Reference-a4jinclude-A_wizard_using_a4jinclude-1.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />--> -<!--</programlisting>--> -<!-- <para>--> -<!-- The navigation is defined in the <filename>faces-config.xml</filename> configuration file:--> -<!-- </para>--> -<!-- --> -<!--<programlisting language="XML" role="XML">--> -<!--<xi:include href="extras/exam-Component_Reference-a4jinclude-A_wizard_using_a4jinclude-2.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />--> -<!--</programlisting>--> -<!-- </example>--> -<!-- </section>--> + <section id="sect-Component_Reference-Containers-a4jform"> + <title><sgmltag>&lt;a4j:form&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.ajax4jsf.Form</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>javax.faces.Form</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.ajax4jsf.component.html.AjaxForm</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.ajax4jsf.FormRenderer</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;a4j:form&gt;</sgmltag> builds on the functionality of the JavaServer Faces (<acronym>JSF</acronym>) component <sgmltag>&lt;h:form&gt;</sgmltag>, adding Ajax capabilities to the form. + </para> + <note> + <title>Command link rendering fixed</title> + <para> + The <acronym>JSF</acronym> component <sgmltag>&lt;h:form&gt;</sgmltag>, on which the <sgmltag>&lt;a4j:form&gt;</sgmltag> component is based, had an issue whereby the <sgmltag>&lt;h:commandLink&gt;</sgmltag> component could not be re-rendered without re-rendering the entire form. <sgmltag>&lt;a4j:form&gt;</sgmltag> and <sgmltag>&lt;a4j:commandLink&gt;</sgmltag> fix this issue. + </para> + </note> + <para> + The <sgmltag>&lt;a4j:form&gt;</sgmltag> component can add indirect Ajax support to non-Ajax components on the form by setting <code>ajaxSubmit="true"</code>. It then uses the standard Ajax component attributes and updates components specified with the <varname>render</varname> attribute. + </para> + <important> + <title><varname>ajaxSubmit</varname></title> + <para> + <sgmltag>&lt;a4j:form&gt;</sgmltag> should not use <code>ajaxSubmit="true"</code> if it contains other Ajax-capable components. + </para> + <para> + Additionally, due to security reasons the file upload form element cannot be indirectly made Ajax-capable with <sgmltag>&lt;a4j:form&gt;</sgmltag>. + </para> + </important> + </section> + <section id="sect-Component_Reference-Containers-a4jinclude"> + <title><sgmltag>&lt;a4j:include&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.ajax4jsf.Include</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>javax.faces.Output</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.ajax4jsf.component.html.Include</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.ajax4jsf.components.AjaxIncludeRenderer</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;a4j:include&gt;</sgmltag> component allows one view to be included as part of another page. This is useful for applications where multiple views might appear on the one page, with navigation between the views. Views can use partial page navigation in Ajax mode, or standard <acronym>JSF</acronym> navigation for navigation between views. + </para> + <para> + The <varname>viewId</varname> attribute is required to reference the resource that will be included as a view on the page. It uses a full context-relative path to point to the resource, similar to the paths used for the <sgmltag>&lt;from-view-id&gt;</sgmltag> and <sgmltag>&lt;to-view-id&gt;</sgmltag> tags in the <filename>faces-config.xml</filename> <acronym>JSF</acronym> navigation rules. + </para> + <example id="exam-Component_Reference-a4jinclude-A_wizard_using_a4jinclude"> + <title>A wizard using <sgmltag>&lt;a4j:include&gt;</sgmltag></title> + <para> + The page uses <sgmltag>&lt;a4j:include&gt;</sgmltag> to include the first step of the wizard: + </para> + +<programlisting language="XML" role="XML"> +<xi:include href="extras/exam-Component_Reference-a4jinclude-A_wizard_using_a4jinclude-0.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + <para> + The first step is fully contained in a separate file, <filename>wstep1.xhtml</filename>. Subsequent steps are set up similarly with additional <guibutton>Previous</guibutton> buttons. + </para> + +<programlisting language="XML" role="XML"> +<xi:include href="extras/exam-Component_Reference-a4jinclude-A_wizard_using_a4jinclude-1.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + <para> + The navigation is defined in the <filename>faces-config.xml</filename> configuration file: + </para> + +<programlisting language="XML" role="XML"> +<xi:include href="extras/exam-Component_Reference-a4jinclude-A_wizard_using_a4jinclude-2.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + </example> + </section> + <section id="sect-Component_Reference-Containers-a4joutputPanel"> <title><sgmltag>&lt;a4j:outputPanel&gt;</sgmltag></title> <itemizedlist> @@ -163,92 +163,92 @@ </section> <!-- FIXME NOT IN A2 --> -<!-- <section id="sect-Component_Reference-Containers-a4jpage">--> -<!-- <title><sgmltag>&lt;a4j:page&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.ajax4jsf.components.Page</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>org.ajax4jsf.components.AjaxRegion</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.ajax4jsf.component.html.HtmlPage</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- renderer-type: <classname>org.ajax4jsf.components.AjaxPageRenderer</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:page&gt;</sgmltag> component encodes a full HTML-page structure using only one tag. It renders complete <sgmltag>&lt;!DOCTYPE&gt;</sgmltag>, <sgmltag>&lt;html&gt;</sgmltag>, <sgmltag>&lt;head&gt;</sgmltag>, <sgmltag>&lt;title&gt;</sgmltag>, and <sgmltag>&lt;body&gt;</sgmltag> tags using the specified attributes and facets. Additionally, the <sgmltag>&lt;a4j:page&gt;</sgmltag> component solves an incompatibility issue between early versions of <productname>MyFaces</productname>--> -<!-- and the <productname>Ajax4jsf</productname>--> -<!-- framework.--> -<!-- </para>--> -<!-- <para>--> -<!-- The <varname>pageTitle</varname> attribute is rendered as a <sgmltag>&lt;title&gt;</sgmltag> element. The component uses the <literal>head</literal> facet to define the contents of the HTML <sgmltag>&lt;head&gt;</sgmltag> element. The <literal>format</literal> facet defines the page layout format for encoding the <sgmltag>&lt;!DOCTYPE&gt;</sgmltag> element. There rest of the contents of the <sgmltag>&lt;a4j:page&gt;</sgmltag> component are rendered as part of the <sgmltag>&lt;body&gt;</sgmltag> element.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-a4jpage-a4jpage_rendering">--> -<!-- <title><sgmltag>&lt;a4j:page&gt;</sgmltag> rendering</title>--> -<!-- <para>--> -<!-- An <sgmltag>&lt;a4j:page&gt;</sgmltag> component can be defined as follows:--> -<!-- </para>--> -<!-- --> -<!--<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jpage-a4jpage_rendering-0.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />--> -<!--</programlisting>--> -<!-- <para>--> -<!-- This definition will render on an XHTML page as follows:--> -<!-- </para>--> -<!-- --> -<!--<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jpage-a4jpage_rendering-1.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />--> -<!--</programlisting>--> -<!-- </example>--> -<!-- <para>--> -<!-- When using the <productname>Ajax4jsf</productname>--> -<!-- framework with <productname>MyFaces</productname>--> -<!-- version 1.2.2 and lower, the <sgmltag>&lt;f:view&gt;</sgmltag> JSP tag does not receive control for encoding contents during the <literal>RENDER_RESPONSE</literal> phase. As a result, Ajax fails to receive control and send responses. The <sgmltag>&lt;a4j:page&gt;</sgmltag> component solves this problem by wrapping the Ajax areas to be updated. Later versions of <productname>MyFaces</productname>--> -<!-- do not have this problem, and as such do not require the use of the <sgmltag>&lt;a4j:page&gt;</sgmltag> component.--> -<!-- </para>--> -<!-- </section>--> -<!-- --> -<!-- <section id="sect-Component_Reference-Containers-a4jregion">--> -<!-- <title><sgmltag>&lt;a4j:region&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.ajax4jsf.AjaxRegion</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>org.ajax4jsf.AjaxRegion</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.ajax4jsf.component.html.HtmlAjaxRegion</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- renderer-type: <classname>org.ajax4jsf.components.AjaxRegionRenderer</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:region&gt;</sgmltag> component specifies a part of the document object model (<acronym>DOM</acronym>) tree to be processed on the server. The processing includes data handling during decoding, conversion, validation, and model updating. When not using <sgmltag>&lt;a4j:region&gt;</sgmltag>, the entire view functions as a region.--> -<!-- </para>--> -<!-- <para>--> -<!-- The whole form is still submitted to the server, but only the specified region is processed. Regions can be nested, in which case only the immediate region of the component initiating the request will be processed.--> -<!-- </para>--> -<!-- </section>--> + <section id="sect-Component_Reference-Containers-a4jpage"> + <title><sgmltag>&lt;a4j:page&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.ajax4jsf.components.Page</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.ajax4jsf.components.AjaxRegion</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.ajax4jsf.component.html.HtmlPage</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.ajax4jsf.components.AjaxPageRenderer</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;a4j:page&gt;</sgmltag> component encodes a full HTML-page structure using only one tag. It renders complete <sgmltag>&lt;!DOCTYPE&gt;</sgmltag>, <sgmltag>&lt;html&gt;</sgmltag>, <sgmltag>&lt;head&gt;</sgmltag>, <sgmltag>&lt;title&gt;</sgmltag>, and <sgmltag>&lt;body&gt;</sgmltag> tags using the specified attributes and facets. Additionally, the <sgmltag>&lt;a4j:page&gt;</sgmltag> component solves an incompatibility issue between early versions of <productname>MyFaces</productname> + and the <productname>Ajax4jsf</productname> + framework. + </para> + <para> + The <varname>pageTitle</varname> attribute is rendered as a <sgmltag>&lt;title&gt;</sgmltag> element. The component uses the <literal>head</literal> facet to define the contents of the HTML <sgmltag>&lt;head&gt;</sgmltag> element. The <literal>format</literal> facet defines the page layout format for encoding the <sgmltag>&lt;!DOCTYPE&gt;</sgmltag> element. There rest of the contents of the <sgmltag>&lt;a4j:page&gt;</sgmltag> component are rendered as part of the <sgmltag>&lt;body&gt;</sgmltag> element. + </para> + <example id="exam-Component_Reference-a4jpage-a4jpage_rendering"> + <title><sgmltag>&lt;a4j:page&gt;</sgmltag> rendering</title> + <para> + An <sgmltag>&lt;a4j:page&gt;</sgmltag> component can be defined as follows: + </para> + +<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jpage-a4jpage_rendering-0.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + <para> + This definition will render on an XHTML page as follows: + </para> + +<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jpage-a4jpage_rendering-1.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + </example> + <para> + When using the <productname>Ajax4jsf</productname> + framework with <productname>MyFaces</productname> + version 1.2.2 and lower, the <sgmltag>&lt;f:view&gt;</sgmltag> JSP tag does not receive control for encoding contents during the <literal>RENDER_RESPONSE</literal> phase. As a result, Ajax fails to receive control and send responses. The <sgmltag>&lt;a4j:page&gt;</sgmltag> component solves this problem by wrapping the Ajax areas to be updated. Later versions of <productname>MyFaces</productname> + do not have this problem, and as such do not require the use of the <sgmltag>&lt;a4j:page&gt;</sgmltag> component. + </para> + </section> + + <section id="sect-Component_Reference-Containers-a4jregion"> + <title><sgmltag>&lt;a4j:region&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.ajax4jsf.AjaxRegion</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.ajax4jsf.AjaxRegion</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.ajax4jsf.component.html.HtmlAjaxRegion</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.ajax4jsf.components.AjaxRegionRenderer</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;a4j:region&gt;</sgmltag> component specifies a part of the document object model (<acronym>DOM</acronym>) tree to be processed on the server. The processing includes data handling during decoding, conversion, validation, and model updating. When not using <sgmltag>&lt;a4j:region&gt;</sgmltag>, the entire view functions as a region. + </para> + <para> + The whole form is still submitted to the server, but only the specified region is processed. Regions can be nested, in which case only the immediate region of the component initiating the request will be processed. + </para> + </section> </chapter> Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Resources.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Resources.xml 2010-06-22 23:05:28 UTC (rev 17660) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Resources.xml 2010-06-23 05:58:27 UTC (rev 17661) @@ -7,219 +7,219 @@ This chapter covers those components used to handle and manage resources and beans. </para> <!-- FIXME NOT IN A2 --> -<!-- <section id="sect-Component_Reference-Resources-a4jloadBundle">--> -<!-- <title><sgmltag>&lt;a4j:loadBundle&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.ajax4jsf.Bundle</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>org.ajax4jsf.Bundle</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.ajax4jsf.component.html.AjaxLoadBundle</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:loadBundle&gt;</sgmltag> component is used to load resource bundles to aid in localization of an application. The bundles are localized to the locale of the current view, and properties are stored as a map in the current request attributes.--> -<!-- </para>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:loadBundle&gt;</sgmltag> component allows bundles to be accessed by Ajax requests working in their own address scopes. This solves the problem of using the <acronym>JSF</acronym> <sgmltag>&lt;h:loadBundle&gt;</sgmltag> component with Ajax, where bundle information loaded with the page was unavailable for later Ajax requests.--> -<!-- </para>--> -<!-- <para>--> -<!-- Resource bundles are registered in the Faces configuration file, <filename>faces-config.xml</filename>.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-a4jloadBundle-a4jloadBundle_example">--> -<!-- <title><sgmltag>&lt;a4j:loadBundle&gt;</sgmltag> example</title>--> -<!-- <para>--> -<!-- This example shows a simple application capable of switching between different localized languages.--> -<!-- </para>--> -<!-- <procedure>--> -<!-- <step id="step-Component_Reference-a4jloadBundle_example-Create_resource_bundles">--> -<!-- <title>Create resource bundles</title>--> -<!-- <para>--> -<!-- String resource bundles are contained in files with a <filename class="extension">.properties</filename> extension. The files consist of a list of entries, each with a unique name and a corresponding value. A seperate file is required for each language. Append the filename with the locale identifier (<literal>en</literal> for English, for example).--> -<!-- </para>--> -<!-- <mediaobject>--> -<!-- <imageobject>--> -<!-- <imagedata fileref="images/figu-Component_Reference-a4jloadBundle-Create_resource_bundles.png" format="PNG" width="444" />--> -<!-- </imageobject>--> -<!-- <textobject>--> -<!-- <para>--> -<!-- Resource bundles for English (<literal>en</literal>), German (<literal>de</literal>), and Italian (<literal>it</literal>). A single entry (<literal>greeting</literal>) has been localized for each bundle.--> -<!-- </para>--> -<!-- </textobject>--> -<!-- </mediaobject>--> -<!-- </step>--> -<!-- <step id="step-Component_Reference-a4jloadBundle_example-Register_bundles_in_Faces_configuration_file">--> -<!-- <title>Register bundles in Faces configuration file</title>--> -<!-- <para>--> -<!-- The resource bundles need to be registered in the Faces configuration file, <filename>faces-config.xml</filename>. The filename is defined with the <sgmltag>&lt;message-bundle&gt;</sgmltag> tag, without the locale code and without the extension. The supported locale codes are listed with <sgmltag>&lt;supported-locale&gt;</sgmltag> tags.--> -<!-- </para>--> -<!-- --> -<!--<programlisting language="XML" role="XML">--> -<!--<xi:include href="extras/exam-Component_Reference-a4jloadBundle-a4jloadBundle_example-0.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />--> -<!--</programlisting>--> -<!-- </step>--> -<!-- <step id="step-Component_Reference-a4jloadBundle_example-Create_method_to_set_locale">--> -<!-- <title>Create method to set locale</title>--> -<!-- <para>--> -<!-- The <acronym>JSF</acronym> <methodname>javax.faces.component.UIViewRoot.setLocale()</methodname> method can be used to update the locale through a Java class:--> -<!-- </para>--> -<!-- --> -<!--<programlisting language="Java" role="JAVA">--> -<!--<xi:include href="extras/exam-Component_Reference-a4jloadBundle-a4jloadBundle_example-1.js" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />--> -<!--</programlisting>--> -<!-- </step>--> -<!-- <step id="step-Component_Reference-a4jloadBundle_example-Add_a4jloadBundle_to_the_JSP_page">--> -<!-- <title>Add <sgmltag>&lt;a4j:loadBundle&gt;</sgmltag> to the <acronym>JSP</acronym> page</title>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:loadBundle&gt;</sgmltag> component is added to the application, and links to change the locale will update the displayed text.--> -<!-- </para>--> -<!-- --> -<!--<programlisting language="XML" role="XML">--> -<!--<xi:include href="extras/exam-Component_Reference-a4jloadBundle-a4jloadBundle_example-2.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />--> -<!--</programlisting>--> -<!-- <mediaobject>--> -<!-- <imageobject>--> -<!-- <imagedata fileref="images/figu-Component_Reference-a4jloadBundle-Add_a4jloadBundle_to_the_JSP_page.png" format="PNG" />--> -<!-- </imageobject>--> -<!-- <textobject>--> -<!-- <para>--> -<!-- The output text displayed on a page. It can be changed by clicking the command link for either German, English, or Italian.--> -<!-- </para>--> -<!-- </textobject>--> -<!-- </mediaobject>--> -<!-- </step>--> -<!-- </procedure>--> -<!-- --> -<!-- <para>--> -<!-- Clicking on the different links will render the localized string as appropriate.--> -<!-- </para>--> -<!-- </example>--> -<!-- </section>--> -<!-- --> -<!-- <section id="sect-Component_Reference-Resources-a4jloadScript">--> -<!-- <title><sgmltag>&lt;a4j:loadScript&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.ajax4jsf.LoadScript</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>org.ajax4jsf.LoadScript</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.ajax4jsf.component.html.HtmlLoadScript</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- renderer-type: <classname>org.ajax4jsf.LoadScriptRenderer</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:loadScript&gt;</sgmltag> component allows scripts to be loaded from external sources such as <filename>jar</filename> files.--> -<!-- </para>--> -<!-- <para>--> -<!-- The required <varname>src</varname> attribute defines the path to the script. A leading slash (<literal>/</literal>) represents the root of the web context. The <code>resource://</code> prefix can be used to access a file in the RichFaces resource framework. The path is passed to the <methodname>getResourceURL()</methodname> method of the application's <classname>ViewHandler</classname>, with the result then being passed through the <methodname>encodeResourceURL()</methodname> method of <classname>ExternalContext</classname>.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-a4jloadScript-a4jloadScript_example">--> -<!-- <title><sgmltag>&lt;a4j:loadScript&gt;</sgmltag> example</title>--> -<!-- --> -<!--<programlisting language="XML" role="XML">--> -<!--&lt;a4j:loadScript src="resource:///org/mycompany/assets/script/focus.js" /&gt;--> -<!--</programlisting>--> -<!-- </example>--> -<!-- </section>--> -<!-- --> -<!-- <section id="sect-Component_Reference-Resources-a4jloadStyle">--> -<!-- <title><sgmltag>&lt;a4j:loadStyle&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.ajax4jsf.LoadStyle</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>org.ajax4jsf.LoadStyle</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.ajax4jsf.component.html.HtmlLoadStyle</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- renderer-type: <classname>org.ajax4jsf.LoadStyleRenderer</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:loadStyle&gt;</sgmltag> component allows a style sheet to be loaded from an external source, such as a <filename>jar</filename> file. The style sheet links are inserted into the head element.--> -<!-- </para>--> -<!-- <para>--> -<!-- The required <varname>src</varname> attribute defines the path to the script. A leading slash (<literal>/</literal>) represents the root of the web context. The <code>resource://</code> prefix can be used to access a file in the RichFaces resource framework. The path is passed to the <methodname>getResourceURL()</methodname> method of the application's <classname>ViewHandler</classname>, with the result then being passed through the <methodname>encodeResourceURL()</methodname> method of <classname>ExternalContext</classname>.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-a4jloadStyle-a4jloadStyle_example">--> -<!-- <title><sgmltag>&lt;a4j:loadStyle&gt;</sgmltag> example</title>--> -<!-- --> -<!--<programlisting language="XML" role="XML">--> -<!--&lt;a4j:loadStyle src="resource:///org/mycompany/assets/script/focus.js" /&gt;--> -<!--</programlisting>--> -<!-- </example>--> -<!-- </section>--> -<!-- --> -<!-- <section id="sect-Component_Reference-Resources-a4jkeepAlive">--> -<!-- <title><sgmltag>&lt;a4j:keepAlive&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.ajax4jsf.components.KeepAlive</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>org.ajax4jsf.components.AjaxKeepAlive</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.ajax4jsf.components.AjaxKeepAlive</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;a4j:keepAlive&gt;</sgmltag> component allows the state of a managed bean to be retained between Ajax requests.--> -<!-- </para>--> -<!-- <para>--> -<!-- Managed beans can be declared with the <literal>request</literal> scope in the <filename>faces-config.xml</filename> configuration file, using the <sgmltag>&lt;managed-bean-scope&gt;</sgmltag> tag. Any references to the bean instance after the request has ended will cause the server to throw an illegal argument exception. The <sgmltag>&lt;a4j:keepAlive&gt;</sgmltag> component avoids this be maintaining the state of the whole bean object for subsequent requests.--> -<!-- </para>--> -<!-- <para>--> -<!-- The <varname>beanName</varname> attribute uses JSF Expression Language (<acronym>EL</acronym>) to define the request scope bean name to keep alive. The expression must resolve to a managed bean instance. The <varname>ajaxOnly</varname> attribute determines whether or not the value of the bean should be available during non-Ajaxx requests; if <code>ajaxOnly="true"</code>, the request-scope bean keeps its value during Ajax requests, but any non-Ajax requests will re-create the bean as a regular request-scope bean.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-a4jkeepAlive-a4jkeepAlive_example">--> -<!-- <title><sgmltag>&lt;a4j:keepAlive&gt;</sgmltag> example</title>--> -<!-- --> -<!--<programlisting language="XML" role="XML">--> -<!--&lt;a4j:keepAlive beanName="#{myClass.testBean}" /&gt;--> -<!--</programlisting>--> -<!-- </example>--> -<!-- </section>--> + <section id="sect-Component_Reference-Resources-a4jloadBundle"> + <title><sgmltag>&lt;a4j:loadBundle&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.ajax4jsf.Bundle</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.ajax4jsf.Bundle</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.ajax4jsf.component.html.AjaxLoadBundle</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;a4j:loadBundle&gt;</sgmltag> component is used to load resource bundles to aid in localization of an application. The bundles are localized to the locale of the current view, and properties are stored as a map in the current request attributes. + </para> + <para> + The <sgmltag>&lt;a4j:loadBundle&gt;</sgmltag> component allows bundles to be accessed by Ajax requests working in their own address scopes. This solves the problem of using the <acronym>JSF</acronym> <sgmltag>&lt;h:loadBundle&gt;</sgmltag> component with Ajax, where bundle information loaded with the page was unavailable for later Ajax requests. + </para> + <para> + Resource bundles are registered in the Faces configuration file, <filename>faces-config.xml</filename>. + </para> + <example id="exam-Component_Reference-a4jloadBundle-a4jloadBundle_example"> + <title><sgmltag>&lt;a4j:loadBundle&gt;</sgmltag> example</title> + <para> + This example shows a simple application capable of switching between different localized languages. + </para> + <procedure> + <step id="step-Component_Reference-a4jloadBundle_example-Create_resource_bundles"> + <title>Create resource bundles</title> + <para> + String resource bundles are contained in files with a <filename class="extension">.properties</filename> extension. The files consist of a list of entries, each with a unique name and a corresponding value. A seperate file is required for each language. Append the filename with the locale identifier (<literal>en</literal> for English, for example). + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-a4jloadBundle-Create_resource_bundles.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + Resource bundles for English (<literal>en</literal>), German (<literal>de</literal>), and Italian (<literal>it</literal>). A single entry (<literal>greeting</literal>) has been localized for each bundle. + </para> + </textobject> + </mediaobject> + </step> + <step id="step-Component_Reference-a4jloadBundle_example-Register_bundles_in_Faces_configuration_file"> + <title>Register bundles in Faces configuration file</title> + <para> + The resource bundles need to be registered in the Faces configuration file, <filename>faces-config.xml</filename>. The filename is defined with the <sgmltag>&lt;message-bundle&gt;</sgmltag> tag, without the locale code and without the extension. The supported locale codes are listed with <sgmltag>&lt;supported-locale&gt;</sgmltag> tags. + </para> + +<programlisting language="XML" role="XML"> +<xi:include href="extras/exam-Component_Reference-a4jloadBundle-a4jloadBundle_example-0.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + </step> + <step id="step-Component_Reference-a4jloadBundle_example-Create_method_to_set_locale"> + <title>Create method to set locale</title> + <para> + The <acronym>JSF</acronym> <methodname>javax.faces.component.UIViewRoot.setLocale()</methodname> method can be used to update the locale through a Java class: + </para> + +<programlisting language="Java" role="JAVA"> +<xi:include href="extras/exam-Component_Reference-a4jloadBundle-a4jloadBundle_example-1.js" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + </step> + <step id="step-Component_Reference-a4jloadBundle_example-Add_a4jloadBundle_to_the_JSP_page"> + <title>Add <sgmltag>&lt;a4j:loadBundle&gt;</sgmltag> to the <acronym>JSP</acronym> page</title> + <para> + The <sgmltag>&lt;a4j:loadBundle&gt;</sgmltag> component is added to the application, and links to change the locale will update the displayed text. + </para> + +<programlisting language="XML" role="XML"> +<xi:include href="extras/exam-Component_Reference-a4jloadBundle-a4jloadBundle_example-2.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-a4jloadBundle-Add_a4jloadBundle_to_the_JSP_page.png" format="PNG" /> + </imageobject> + <textobject> + <para> + The output text displayed on a page. It can be changed by clicking the command link for either German, English, or Italian. + </para> + </textobject> + </mediaobject> + </step> + </procedure> + + <para> + Clicking on the different links will render the localized string as appropriate. + </para> + </example> + </section> + <section id="sect-Component_Reference-Resources-a4jloadScript"> + <title><sgmltag>&lt;a4j:loadScript&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.ajax4jsf.LoadScript</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.ajax4jsf.LoadScript</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.ajax4jsf.component.html.HtmlLoadScript</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.ajax4jsf.LoadScriptRenderer</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;a4j:loadScript&gt;</sgmltag> component allows scripts to be loaded from external sources such as <filename>jar</filename> files. + </para> + <para> + The required <varname>src</varname> attribute defines the path to the script. A leading slash (<literal>/</literal>) represents the root of the web context. The <code>resource://</code> prefix can be used to access a file in the RichFaces resource framework. The path is passed to the <methodname>getResourceURL()</methodname> method of the application's <classname>ViewHandler</classname>, with the result then being passed through the <methodname>encodeResourceURL()</methodname> method of <classname>ExternalContext</classname>. + </para> + <example id="exam-Component_Reference-a4jloadScript-a4jloadScript_example"> + <title><sgmltag>&lt;a4j:loadScript&gt;</sgmltag> example</title> + +<programlisting language="XML" role="XML"> +&lt;a4j:loadScript src="resource:///org/mycompany/assets/script/focus.js" /&gt; +</programlisting> + </example> + </section> + + <section id="sect-Component_Reference-Resources-a4jloadStyle"> + <title><sgmltag>&lt;a4j:loadStyle&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.ajax4jsf.LoadStyle</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.ajax4jsf.LoadStyle</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.ajax4jsf.component.html.HtmlLoadStyle</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.ajax4jsf.LoadStyleRenderer</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;a4j:loadStyle&gt;</sgmltag> component allows a style sheet to be loaded from an external source, such as a <filename>jar</filename> file. The style sheet links are inserted into the head element. + </para> + <para> + The required <varname>src</varname> attribute defines the path to the script. A leading slash (<literal>/</literal>) represents the root of the web context. The <code>resource://</code> prefix can be used to access a file in the RichFaces resource framework. The path is passed to the <methodname>getResourceURL()</methodname> method of the application's <classname>ViewHandler</classname>, with the result then being passed through the <methodname>encodeResourceURL()</methodname> method of <classname>ExternalContext</classname>. + </para> + <example id="exam-Component_Reference-a4jloadStyle-a4jloadStyle_example"> + <title><sgmltag>&lt;a4j:loadStyle&gt;</sgmltag> example</title> + +<programlisting language="XML" role="XML"> +&lt;a4j:loadStyle src="resource:///org/mycompany/assets/script/focus.js" /&gt; +</programlisting> + </example> + </section> + + <section id="sect-Component_Reference-Resources-a4jkeepAlive"> + <title><sgmltag>&lt;a4j:keepAlive&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.ajax4jsf.components.KeepAlive</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.ajax4jsf.components.AjaxKeepAlive</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.ajax4jsf.components.AjaxKeepAlive</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;a4j:keepAlive&gt;</sgmltag> component allows the state of a managed bean to be retained between Ajax requests. + </para> + <para> + Managed beans can be declared with the <literal>request</literal> scope in the <filename>faces-config.xml</filename> configuration file, using the <sgmltag>&lt;managed-bean-scope&gt;</sgmltag> tag. Any references to the bean instance after the request has ended will cause the server to throw an illegal argument exception. The <sgmltag>&lt;a4j:keepAlive&gt;</sgmltag> component avoids this be maintaining the state of the whole bean object for subsequent requests. + </para> + <para> + The <varname>beanName</varname> attribute uses JSF Expression Language (<acronym>EL</acronym>) to define the request scope bean name to keep alive. The expression must resolve to a managed bean instance. The <varname>ajaxOnly</varname> attribute determines whether or not the value of the bean should be available during non-Ajaxx requests; if <code>ajaxOnly="true"</code>, the request-scope bean keeps its value during Ajax requests, but any non-Ajax requests will re-create the bean as a regular request-scope bean. + </para> + <example id="exam-Component_Reference-a4jkeepAlive-a4jkeepAlive_example"> + <title><sgmltag>&lt;a4j:keepAlive&gt;</sgmltag> example</title> + +<programlisting language="XML" role="XML"> +&lt;a4j:keepAlive beanName="#{myClass.testBean}" /&gt; +</programlisting> + </example> + </section> + <section id="sect-Component_Reference-Resources-a4jmediaOutput"> <title><sgmltag>&lt;a4j:mediaOutput&gt;</sgmltag></title> <itemizedlist> Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tables_and_grids.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-06-22 23:05:28 UTC (rev 17660) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-06-23 05:58:27 UTC (rev 17661) @@ -253,419 +253,418 @@ </figure> </blockquote> </section> + + <section id="sect-Component_Reference-Tables_and_grids-richcolumns"> + <title><sgmltag>&lt;rich:columns&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.richfaces.Column</classname> + </para> + </listitem> + <listitem> + <para> + tag-class: <classname>org.richfaces.taglib.ColumnsTagHandler</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;rich:columns&gt;</sgmltag> component allows for dynamic sets of columns for tables. Columns and rows can be merged, and the look and feel can be highly customized. The component gets a list from a data model and creates a corresponding set of columns in a <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component. The <sgmltag>&lt;rich:columns&gt;</sgmltag> component also supports <literal>header</literal> and <literal>footer</literal> facets. + </para> + <para> + Basic usage of the <sgmltag>&lt;rich:columns&gt;</sgmltag> component requires the <varname>value</varname> attribute, which points to the data model; the <varname>var</varname> attribute, which holds the current variable for the collection of data; and the <varname>index</varname> attribute, which holds the current counter. The <varname>id</varname> attribute is used for when the individuals rows require identifiers for Ajax events. + </para> + <example id="exam-Component_Reference-richcolumns-Basic_columns_example"> + <title>Basic columns example</title> + +<programlisting language="XML" role="XML"> +&lt;rich:dataTable value="#{dataTableScrollerBean.model}" var="model" width="750"&gt; + &lt;rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind" id="column#{ind}"&gt; + &lt;f:facet name="header"&gt; + &lt;h:outputText value="#{columns.header}" /&gt; + &lt;/f:facet&gt; + &lt;h:outputText value="#{model[ind].model} " /&gt; + &lt;h:outputText value="#{model[ind].mileage} miles " /&gt; + &lt;h:outputText value="#{model[ind].price}$" /&gt; + &lt;/rich:columns&gt; +&lt;/rich:dataTable&gt; +</programlisting> + </example> + <para> + The output can be customized to display specific columns and rows. The <varname>columns</varname> attribute specifies the number of columns. The <varname>rowspan</varname> attribute specifies the number of rows to display; if the attribute is set to <literal>0</literal>, all remaining rows in the table are displayed. The <varname>begin</varname> and <varname>end</varname> attributes are used to specify the first and last zero-based iteration items to display in the table. Columns can be adjusted using the <varname>colspan</varname>, <varname>rowspan</varname>, and <varname>breakBefore</varname> attributes the same as with the <sgmltag>&lt;rich:column&gt;</sgmltag> component. + </para> + <para> + The <sgmltag>&lt;rich:columns&gt;</sgmltag> component can be used alongside <sgmltag>&lt;rich:column&gt;</sgmltag> components. + </para> + <example id="exam-Component_Reference-richcolumns-Using_richcolumns_and_richcolumn_together"> + <title>Using <sgmltag>&lt;rich:columns&gt;</sgmltag> and <sgmltag>&lt;rich:column&gt;</sgmltag> together</title> + +<programlisting language="XML" role="XML"> +&lt;rich:dataTable value="#{dataTableScrollerBean.model}" var="model" width="500px" rows="5"&gt; + &lt;f:facet name="header"&gt; + &lt;h:outputText value="Cars Available"&gt;&lt;/h:outputText&gt; + &lt;/f:facet&gt; + &lt;rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind"&gt; + &lt;f:facet name="header"&gt; + &lt;h:outputText value="#{columns.header}" /&gt; + &lt;/f:facet&gt; + &lt;h:outputText value="#{model[ind].model} " /&gt; + &lt;/rich:columns&gt; + &lt;rich:column&gt; + &lt;f:facet name="header"&gt; + &lt;h:outputText value="Price" /&gt; + &lt;/f:facet&gt; + &lt;h:outputText value="Price" /&gt; + &lt;/rich:column&gt; + &lt;rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind"&gt; + &lt;f:facet name="header"&gt; + &lt;h:outputText value="#{columns.header}" /&gt; + &lt;/f:facet&gt; + &lt;h:outputText value="#{model[ind].mileage}$" /&gt; + &lt;/rich:columns&gt; +&lt;/rich:dataTable&gt; +</programlisting> + </example> + <para> + For details on filtering and sorting columns, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" /> and <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />. + </para> + </section> -<!-- FIXME NOT IN A2 --> -<!-- <section id="sect-Component_Reference-Tables_and_grids-richcolumns">--> -<!-- <title><sgmltag>&lt;rich:columns&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.richfaces.Column</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- tag-class: <classname>org.richfaces.taglib.ColumnsTagHandler</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;rich:columns&gt;</sgmltag> component allows for dynamic sets of columns for tables. Columns and rows can be merged, and the look and feel can be highly customized. The component gets a list from a data model and creates a corresponding set of columns in a <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component. The <sgmltag>&lt;rich:columns&gt;</sgmltag> component also supports <literal>header</literal> and <literal>footer</literal> facets.--> -<!-- </para>--> -<!-- <para>--> -<!-- Basic usage of the <sgmltag>&lt;rich:columns&gt;</sgmltag> component requires the <varname>value</varname> attribute, which points to the data model; the <varname>var</varname> attribute, which holds the current variable for the collection of data; and the <varname>index</varname> attribute, which holds the current counter. The <varname>id</varname> attribute is used for when the individuals rows require identifiers for Ajax events.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-richcolumns-Basic_columns_example">--> -<!-- <title>Basic columns example</title>--> -<!-- --> -<!--<programlisting language="XML" role="XML">--> -<!--&lt;rich:dataTable value="#{dataTableScrollerBean.model}" var="model" width="750"&gt;--> -<!-- &lt;rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind" id="column#{ind}"&gt; --> -<!-- &lt;f:facet name="header"&gt;--> -<!-- &lt;h:outputText value="#{columns.header}" /&gt;--> -<!-- &lt;/f:facet&gt;--> -<!-- &lt;h:outputText value="#{model[ind].model} " /&gt;--> -<!-- &lt;h:outputText value="#{model[ind].mileage} miles " /&gt;--> -<!-- &lt;h:outputText value="#{model[ind].price}$" /&gt; --> -<!-- &lt;/rich:columns&gt; --> -<!--&lt;/rich:dataTable&gt;--> -<!--</programlisting>--> -<!-- </example>--> -<!-- <para>--> -<!-- The output can be customized to display specific columns and rows. The <varname>columns</varname> attribute specifies the number of columns. The <varname>rowspan</varname> attribute specifies the number of rows to display; if the attribute is set to <literal>0</literal>, all remaining rows in the table are displayed. The <varname>begin</varname> and <varname>end</varname> attributes are used to specify the first and last zero-based iteration items to display in the table. Columns can be adjusted using the <varname>colspan</varname>, <varname>rowspan</varname>, and <varname>breakBefore</varname> attributes the same as with the <sgmltag>&lt;rich:column&gt;</sgmltag> component.--> -<!-- </para>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;rich:columns&gt;</sgmltag> component can be used alongside <sgmltag>&lt;rich:column&gt;</sgmltag> components.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-richcolumns-Using_richcolumns_and_richcolumn_together">--> -<!-- <title>Using <sgmltag>&lt;rich:columns&gt;</sgmltag> and <sgmltag>&lt;rich:column&gt;</sgmltag> together</title>--> -<!-- --> -<!--<programlisting language="XML" role="XML">--> -<!--&lt;rich:dataTable value="#{dataTableScrollerBean.model}" var="model" width="500px" rows="5"&gt;--> -<!-- &lt;f:facet name="header"&gt;--> -<!-- &lt;h:outputText value="Cars Available"&gt;&lt;/h:outputText&gt;--> -<!-- &lt;/f:facet&gt;--> -<!-- &lt;rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind"&gt;--> -<!-- &lt;f:facet name="header"&gt;--> -<!-- &lt;h:outputText value="#{columns.header}" /&gt;--> -<!-- &lt;/f:facet&gt;--> -<!-- &lt;h:outputText value="#{model[ind].model} " /&gt;--> -<!-- &lt;/rich:columns&gt;--> -<!-- &lt;rich:column&gt;--> -<!-- &lt;f:facet name="header"&gt;--> -<!-- &lt;h:outputText value="Price" /&gt;--> -<!-- &lt;/f:facet&gt;--> -<!-- &lt;h:outputText value="Price" /&gt;--> -<!-- &lt;/rich:column&gt;--> -<!-- &lt;rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind"&gt;--> -<!-- &lt;f:facet name="header"&gt;--> -<!-- &lt;h:outputText value="#{columns.header}" /&gt;--> -<!-- &lt;/f:facet&gt;--> -<!-- &lt;h:outputText value="#{model[ind].mileage}$" /&gt;--> -<!-- &lt;/rich:columns&gt;--> -<!--&lt;/rich:dataTable&gt;--> -<!--</programlisting>--> -<!-- </example>--> -<!-- <para>--> -<!-- For details on filtering and sorting columns, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" /> and <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />.--> -<!-- </para>--> -<!-- </section>--> -<!-- --> -<!-- <section id="sect-Component_Reference-Tables_and_grids-richdataDefinitionList">--> -<!-- <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.richfaces.DataDefinitionList</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.richfaces.component.html.HtmlDataDefinitionList</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>org.richfaces.DataDefinitionList</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- renderer-type: <classname>org.richfaces.DataDefinitionListRenderer</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- tag-class: <classname>org.richfaces.taglib.DataDefinitionListTag</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component renders a list of items with definitions. The component uses a data model for managing the list items, which can be updated dynamically.--> -<!-- </para>--> -<!-- <para>--> -<!-- The <varname>var</varname> attribute names a variable for iterating through the items in the data model. The items to iterate through are determined with the <varname>value</varname> attribute by using EL (Expression Lanugage). The <varname>first</varname> attribute specifies which item in the data model to show first, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute is used for a floating tool-tip. <xref linkend="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example" /> shows a simple example using the <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example">--> -<!-- <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> example</title>--> -<!-- --> -<!--<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Trees-richdataDefinitionList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />--> -<!--</programlisting>--> -<!-- <blockquote>--> -<!-- <figure id="figu-Component_Reference-richdataDefinitionList_example-richdataDefinitionList_example">--> -<!-- <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> example</title>--> -<!-- <mediaobject>--> -<!-- <imageobject role="html">--> -<!-- <imagedata fileref="images/figu-Component_Reference-Trees-richdataDefinitionList_example.png" format="PNG" />--> -<!-- </imageobject>--> -<!-- <imageobject role="fo">--> -<!-- <imagedata fileref="images/figu-Component_Reference-Trees-richdataDefinitionList_example.png" format="PNG" />--> -<!-- </imageobject>--> -<!-- <textobject>--> -<!-- <para>--> -<!-- A list of cars with their price and mileage displayed as a data definition.--> -<!-- </para>--> -<!-- </textobject>--> -<!-- </mediaobject>--> -<!-- </figure>--> -<!-- </blockquote>--> -<!-- </example>--> -<!-- </section>--> -<!-- --> -<!-- <section id="sect-Component_Reference-Tables_and_grids-richdataFilterSlider">--> -<!-- <title><sgmltag>&lt;rich:dataFilterSlider&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.richfaces.DataFilterSlider</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.richfaces.component.html.HtmlDataFilterSlider</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>org.richfaces.DataFilterSlider</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- renderer-type: <classname>org.richfaces.DataFilterSliderRenderer</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- tag-class: <classname>org.richfaces.taglib.dataFilterSliderTag</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;rich:dataFilterSlider&gt;</sgmltag> components is a slider control that can be used for filtering data in a table. The range and increment of the slider control are defined using the <varname>startRange</varname>, <varname>endRange</varname>, and <varname>increment</varname> attributes.--> -<!-- </para>--> -<!-- <para>--> -<!-- The slider is bound to a <classname>UIData</classname> component specified with the <varname>for</varname> attribute. The <varname>forValRef</varname> attribute refers to the <varname>value</varname> attribute used by the target component, and the <varname>filterBy</varname> attribute specifies which object member to filter according to the slider.--> -<!-- </para>--> -<!-- <para>--> -<!-- The <varname>handleValue</varname> attribute keeps the current handle position on the slider control; filtering is based on this value. The <varname>storeResults</varname> attribute allows the <sgmltag>&lt;rich:dataFilterSlider&gt;</sgmltag> component to keep the target <classname>UIData</classname> component in session.--> -<!-- </para>--> -<!-- <para>--> -<!-- The event defined with the <varname>submitOnSlide</varname> attribute is triggered when the handle value on the slider is changed.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-richdataFilterSlider-richdataFilterSlider_example">--> -<!-- <title><sgmltag>&lt;rich:dataFilterSlider&gt;</sgmltag> example</title>--> -<!-- --> -<!--<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richdataFilterSlider_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />--> -<!--</programlisting>--> -<!-- <blockquote>--> -<!-- <figure id="figu-Component_Reference-richdataFilterSlider_example-richdataFilterSlider_example">--> -<!-- <title><sgmltag>&lt;rich:dataFilterSlider&gt;</sgmltag> example</title>--> -<!-- <mediaobject>--> -<!-- <imageobject>--> -<!-- <imagedata fileref="images/figu-Component_Reference-richdataFilterSlider-richdataFilterSlider_example.png" format="PNG" />--> -<!-- </imageobject>--> -<!-- <textobject>--> -<!-- <para>--> -<!-- A table of car details, filtered using a slider.--> -<!-- </para>--> -<!-- </textobject>--> -<!-- </mediaobject>--> -<!-- </figure>--> -<!-- </blockquote>--> -<!-- </example>--> -<!-- </section>--> -<!-- --> -<!-- <section id="sect-Component_Reference-Tables_and_grids-richdataGrid">--> -<!-- <title><sgmltag>&lt;rich:dataGrid&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.richfaces.DataGrid</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.richfaces.component.html.HtmlDataGrid</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>org.richfaces.DataGrid</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- renderer-type: <classname>org.richfaces.DataGridRenderer</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- tag-class: <classname>org.richfaces.taglib.DataGridTag</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component is used to arrange data objects in a grid. Values in the grid can be updated dynamically from the data model, and Ajax updates can be limited to specific rows. The component supports <literal>header</literal>, <literal>footer</literal>, and <literal>caption</literal> facets.--> -<!-- </para>--> -<!-- <figure id="figu-Component_Reference-richdataGrid-The_richdataGrid_component">--> -<!-- <title>The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component</title>--> -<!-- <mediaobject>--> -<!-- <imageobject>--> -<!-- <imagedata fileref="images/figu-Component_Reference-richdataGrid-The_richdataGrid_component.png" format="PNG" />--> -<!-- </imageobject>--> -<!-- <textobject>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component displaying four elements in two columns, with a <literal>header</literal> facet, and <literal>footer</literal> facet containing a data-scrolling component.--> -<!-- </para>--> -<!-- </textobject>--> -<!-- </mediaobject>--> -<!-- </figure>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component requires the <varname>value</varname> attribute, which points to the data model, and the <varname>var</varname> attribute, which holds the current variable for the collection of data. The number of columns for the grid is specifed with the <varname>columns</varname> attribute, and the number of elements to layout among the columns is determined with the <varname>elements</varname> attribute. The <varname>first</varname> attribute references the zero-based element in the data model from which the grid starts.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-richdataGrid-richdataGrid_example">--> -<!-- <title><sgmltag>&lt;rich:dataGrid&gt;</sgmltag> example</title>--> -<!-- --> -<!--<programlisting language="XML" role="XML">--> -<!--<xi:include href="extras/exam-Component_Reference-richdataGrid-richdataGrid_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />--> -<!--</programlisting>--> -<!-- <blockquote>--> -<!-- <figure id="figu-Component_Reference-richdataGrid_example-richdataGrid_example">--> -<!-- <title><sgmltag>&lt;rich:dataGrid&gt;</sgmltag> example</title>--> -<!-- <mediaobject>--> -<!-- <imageobject>--> -<!-- <imagedata fileref="images/figu-Component_Reference-richdataGrid-richdataGrid_example.png" format="PNG" />--> -<!-- </imageobject>--> -<!-- <textobject>--> -<!-- <para>--> -<!-- The result of the <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> example, with the <literal>header</literal> facet, <literal>footer</literal> facet, and first element annotated.--> -<!-- </para>--> -<!-- </textobject>--> -<!-- </mediaobject>--> -<!-- </figure>--> -<!-- </blockquote>--> -<!-- </example>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component can be used with the <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component to display multiple pages of grids. Refer to <xref linkend="sect-Component_Reference-Tables_and_grids-richdataScroller" /> for details on the <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component.--> -<!-- </para>--> -<!-- <para>--> -<!-- As the component is based on the <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component, it can be partially updated with Ajax. The <varname>ajaxKeys</varname> attribute allows row keys to be defined, which are updated after an Ajax request.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-richdataGrid-ajaxKeys_example">--> -<!-- <title><varname>ajaxKeys</varname> example</title>--> -<!-- --> -<!--<programlisting language="XML" role="XML">--> -<!--&lt;rich:dataGrid value="#{dataTableScrollerBean.allCars}" var="car" ajaxKeys="#{listBean.list}" binding="#{listBean.dataGrid}" id="grid" elements="4" columns="2"&gt;--> -<!-- ...--> -<!--&lt;/rich:dataGrid&gt;--> -<!--...--> -<!--&lt;a4j:commandButton action="#{listBean.action}" reRender="grid" value="Submit"/&gt;--> -<!--</programlisting>--> -<!-- </example>--> -<!-- </section>--> -<!-- --> -<!-- <section id="sect-Component_Reference-Tables_and_grids-richdataList">--> -<!-- <title><sgmltag>&lt;rich:dataList&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.richfaces.DataList</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.richfaces.component.html.HtmlDataList</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>org.richfaces.DataList</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- renderer-type: <classname>org.richfaces.DataListRenderer</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- tag-class: <classname>org.richfaces.taglib.DataListTag</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- The <sgmltag>&lt;rich:dataList&gt;</sgmltag> component renders an unordered list of items. The component uses a data model for managing the list items, which can be updated dynamically.--> -<!-- </para>--> -<!-- <para>--> -<!-- The <varname>type</varname> attribute refers to the appearance of the bullet points. The values of the attribute correspond to the <varname>type</varname> parameter for the <sgmltag>&lt;ul&gt;</sgmltag> HTML element:--> -<!-- </para>--> -<!-- <variablelist>--> -<!-- <varlistentry>--> -<!-- <term><literal>circle</literal></term>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- Displays an unfilled circle as a bullet point.--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </varlistentry>--> -<!-- <varlistentry>--> -<!-- <term><literal>disc</literal></term>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- Displays a filled disc as a bullet point.--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </varlistentry>--> -<!-- <varlistentry>--> -<!-- <term><literal>square</literal></term>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- Displays a square as a bullet point.--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </varlistentry>--> -<!-- </variablelist>--> -<!-- <para>--> -<!-- The <varname>var</varname> attribute names a variable for iterating through the items in the data model. The items to iterate through are determined with the <varname>value</varname> attribute by using EL (Expression Lanugage). The <varname>first</varname> attribute specifies which item in the data model to show first, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute is used for a floating tool-tip. <xref linkend="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example" /> shows a simple example using the <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component.--> -<!-- </para>--> -<!-- <example id="exam-Component_Reference-richdataList-richdataList_example">--> -<!-- <title><sgmltag>&lt;rich:dataList&gt;</sgmltag> example</title>--> -<!-- --> -<!--<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-richdataList-richdataList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />--> -<!--</programlisting>--> -<!-- <blockquote>--> -<!-- <figure id="figu-Component_Reference-richdataList_example-richdataList_example">--> -<!-- <title><sgmltag>&lt;rich:dataList&gt;</sgmltag> example</title>--> -<!-- <mediaobject>--> -<!-- <imageobject>--> -<!-- <imagedata fileref="images/figu-Component_Reference-richdataList-richdataList_example.png" format="PNG" />--> -<!-- </imageobject>--> -<!-- <textobject>--> -<!-- <para>--> -<!-- A list of cars displayed in a list with bullet points.--> -<!-- </para>--> -<!-- </textobject>--> -<!-- </mediaobject>--> -<!-- </figure>--> -<!-- </blockquote>--> -<!-- </example>--> -<!-- </section>--> -<!-- --> -<!-- <section id="sect-Component_Reference-Tables_and_grids-richdataOrderedList">--> -<!-- <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag></title>--> -<!-- <itemizedlist>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-type: <classname>org.richfaces.DataOrderedList</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-class: <classname>org.richfaces.component.html.HtmlDataOrderedList</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- component-family: <classname>org.richfaces.DataOrderedList</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- renderer-type: <classname>org.richfaces.DataOrderedListRenderer</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- <listitem>--> -<!-- <para>--> -<!-- tag-class: <classname>org.richfaces.taglib.DataOrderedListTag</classname>--> -<!-- </para>--> -<!-- </listitem>--> -<!-- </itemizedlist>--> -<!-- <para>--> -<!-- Incomplete--> -<!-- </para>--> -<!-- </section>--> + <section id="sect-Component_Reference-Tables_and_grids-richdataDefinitionList"> + <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.richfaces.DataDefinitionList</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.richfaces.component.html.HtmlDataDefinitionList</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.richfaces.DataDefinitionList</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.richfaces.DataDefinitionListRenderer</classname> + </para> + </listitem> + <listitem> + <para> + tag-class: <classname>org.richfaces.taglib.DataDefinitionListTag</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component renders a list of items with definitions. The component uses a data model for managing the list items, which can be updated dynamically. + </para> + <para> + The <varname>var</varname> attribute names a variable for iterating through the items in the data model. The items to iterate through are determined with the <varname>value</varname> attribute by using EL (Expression Lanugage). The <varname>first</varname> attribute specifies which item in the data model to show first, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute is used for a floating tool-tip. <xref linkend="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example" /> shows a simple example using the <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component. + </para> + <example id="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example"> + <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> example</title> + +<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Trees-richdataDefinitionList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + <blockquote> + <figure id="figu-Component_Reference-richdataDefinitionList_example-richdataDefinitionList_example"> + <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> example</title> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/figu-Component_Reference-Trees-richdataDefinitionList_example.png" format="PNG" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/figu-Component_Reference-Trees-richdataDefinitionList_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A list of cars with their price and mileage displayed as a data definition. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + <section id="sect-Component_Reference-Tables_and_grids-richdataFilterSlider"> + <title><sgmltag>&lt;rich:dataFilterSlider&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.richfaces.DataFilterSlider</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.richfaces.component.html.HtmlDataFilterSlider</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.richfaces.DataFilterSlider</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.richfaces.DataFilterSliderRenderer</classname> + </para> + </listitem> + <listitem> + <para> + tag-class: <classname>org.richfaces.taglib.dataFilterSliderTag</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;rich:dataFilterSlider&gt;</sgmltag> components is a slider control that can be used for filtering data in a table. The range and increment of the slider control are defined using the <varname>startRange</varname>, <varname>endRange</varname>, and <varname>increment</varname> attributes. + </para> + <para> + The slider is bound to a <classname>UIData</classname> component specified with the <varname>for</varname> attribute. The <varname>forValRef</varname> attribute refers to the <varname>value</varname> attribute used by the target component, and the <varname>filterBy</varname> attribute specifies which object member to filter according to the slider. + </para> + <para> + The <varname>handleValue</varname> attribute keeps the current handle position on the slider control; filtering is based on this value. The <varname>storeResults</varname> attribute allows the <sgmltag>&lt;rich:dataFilterSlider&gt;</sgmltag> component to keep the target <classname>UIData</classname> component in session. + </para> + <para> + The event defined with the <varname>submitOnSlide</varname> attribute is triggered when the handle value on the slider is changed. + </para> + <example id="exam-Component_Reference-richdataFilterSlider-richdataFilterSlider_example"> + <title><sgmltag>&lt;rich:dataFilterSlider&gt;</sgmltag> example</title> + +<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richdataFilterSlider_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + <blockquote> + <figure id="figu-Component_Reference-richdataFilterSlider_example-richdataFilterSlider_example"> + <title><sgmltag>&lt;rich:dataFilterSlider&gt;</sgmltag> example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richdataFilterSlider-richdataFilterSlider_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A table of car details, filtered using a slider. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richdataGrid"> + <title><sgmltag>&lt;rich:dataGrid&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.richfaces.DataGrid</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.richfaces.component.html.HtmlDataGrid</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.richfaces.DataGrid</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.richfaces.DataGridRenderer</classname> + </para> + </listitem> + <listitem> + <para> + tag-class: <classname>org.richfaces.taglib.DataGridTag</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component is used to arrange data objects in a grid. Values in the grid can be updated dynamically from the data model, and Ajax updates can be limited to specific rows. The component supports <literal>header</literal>, <literal>footer</literal>, and <literal>caption</literal> facets. + </para> + <figure id="figu-Component_Reference-richdataGrid-The_richdataGrid_component"> + <title>The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richdataGrid-The_richdataGrid_component.png" format="PNG" /> + </imageobject> + <textobject> + <para> + The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component displaying four elements in two columns, with a <literal>header</literal> facet, and <literal>footer</literal> facet containing a data-scrolling component. + </para> + </textobject> + </mediaobject> + </figure> + <para> + The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component requires the <varname>value</varname> attribute, which points to the data model, and the <varname>var</varname> attribute, which holds the current variable for the collection of data. The number of columns for the grid is specifed with the <varname>columns</varname> attribute, and the number of elements to layout among the columns is determined with the <varname>elements</varname> attribute. The <varname>first</varname> attribute references the zero-based element in the data model from which the grid starts. + </para> + <example id="exam-Component_Reference-richdataGrid-richdataGrid_example"> + <title><sgmltag>&lt;rich:dataGrid&gt;</sgmltag> example</title> + +<programlisting language="XML" role="XML"> +<xi:include href="extras/exam-Component_Reference-richdataGrid-richdataGrid_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + <blockquote> + <figure id="figu-Component_Reference-richdataGrid_example-richdataGrid_example"> + <title><sgmltag>&lt;rich:dataGrid&gt;</sgmltag> example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richdataGrid-richdataGrid_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + The result of the <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> example, with the <literal>header</literal> facet, <literal>footer</literal> facet, and first element annotated. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + <para> + The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component can be used with the <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component to display multiple pages of grids. Refer to <xref linkend="sect-Component_Reference-Tables_and_grids-richdataScroller" /> for details on the <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component. + </para> + <para> + As the component is based on the <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component, it can be partially updated with Ajax. The <varname>ajaxKeys</varname> attribute allows row keys to be defined, which are updated after an Ajax request. + </para> + <example id="exam-Component_Reference-richdataGrid-ajaxKeys_example"> + <title><varname>ajaxKeys</varname> example</title> + +<programlisting language="XML" role="XML"> +&lt;rich:dataGrid value="#{dataTableScrollerBean.allCars}" var="car" ajaxKeys="#{listBean.list}" binding="#{listBean.dataGrid}" id="grid" elements="4" columns="2"&gt; + ... +&lt;/rich:dataGrid&gt; +... +&lt;a4j:commandButton action="#{listBean.action}" reRender="grid" value="Submit"/&gt; +</programlisting> + </example> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richdataList"> + <title><sgmltag>&lt;rich:dataList&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.richfaces.DataList</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.richfaces.component.html.HtmlDataList</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.richfaces.DataList</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.richfaces.DataListRenderer</classname> + </para> + </listitem> + <listitem> + <para> + tag-class: <classname>org.richfaces.taglib.DataListTag</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <sgmltag>&lt;rich:dataList&gt;</sgmltag> component renders an unordered list of items. The component uses a data model for managing the list items, which can be updated dynamically. + </para> + <para> + The <varname>type</varname> attribute refers to the appearance of the bullet points. The values of the attribute correspond to the <varname>type</varname> parameter for the <sgmltag>&lt;ul&gt;</sgmltag> HTML element: + </para> + <variablelist> + <varlistentry> + <term><literal>circle</literal></term> + <listitem> + <para> + Displays an unfilled circle as a bullet point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>disc</literal></term> + <listitem> + <para> + Displays a filled disc as a bullet point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>square</literal></term> + <listitem> + <para> + Displays a square as a bullet point. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + The <varname>var</varname> attribute names a variable for iterating through the items in the data model. The items to iterate through are determined with the <varname>value</varname> attribute by using EL (Expression Lanugage). The <varname>first</varname> attribute specifies which item in the data model to show first, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute is used for a floating tool-tip. <xref linkend="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example" /> shows a simple example using the <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component. + </para> + <example id="exam-Component_Reference-richdataList-richdataList_example"> + <title><sgmltag>&lt;rich:dataList&gt;</sgmltag> example</title> + +<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-richdataList-richdataList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + <blockquote> + <figure id="figu-Component_Reference-richdataList_example-richdataList_example"> + <title><sgmltag>&lt;rich:dataList&gt;</sgmltag> example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richdataList-richdataList_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A list of cars displayed in a list with bullet points. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richdataOrderedList"> + <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.richfaces.DataOrderedList</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.richfaces.component.html.HtmlDataOrderedList</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.richfaces.DataOrderedList</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.richfaces.DataOrderedListRenderer</classname> + </para> + </listitem> + <listitem> + <para> + tag-class: <classname>org.richfaces.taglib.DataOrderedListTag</classname> + </para> + </listitem> + </itemizedlist> + <para> + Incomplete + </para> + </section> + <section id="sect-Component_Reference-Tables_and_grids-richdataScroller"> <title><sgmltag>&lt;rich:dataScroller&gt;</sgmltag></title> <para>