Author: SeanRogers Date: 2009-10-29 02:18:21 -0400 (Thu, 29 Oct 2009) New Revision: 15771 Added: root/docs/trunk/Component_Development_Kit_Guide/en-US/all-Component_Development_Kit_Guide.xml root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml root/docs/trunk/Developer_Guide/en-US/all-Developer_Guide.xml Log: Adding sources for Maven builds Added: root/docs/trunk/Component_Development_Kit_Guide/en-US/all-Component_Development_Kit_Guide.xml =================================================================== --- root/docs/trunk/Component_Development_Kit_Guide/en-US/all-Component_Development_Kit_Guide.xml (rev 0) +++ root/docs/trunk/Component_Development_Kit_Guide/en-US/all-Component_Development_Kit_Guide.xml 2009-10-29 06:18:21 UTC (rev 15771) @@ -0,0 +1,180 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Component_Development_Kit_Guide.ent"> +<!ENTITY PRODUCT "RichFaces"> +<!ENTITY VERSION "4.0"> +<!ENTITY VERSION_LONG "4.0.0.ALPHA2"> +<!ENTITY BOOKID "Component_Development_Kit_Guide"> +<!ENTITY HOLDER "Red Hat"> +<!ENTITY YEAR "2009"> +]> +<book lang="en-US" status="draft"> + <bookinfo id="book-Component_Development_Kit_Guide-Component_Development_Kit_Guide" lang="en-US"> + <title>Component Development Kit Guide</title> + <subtitle>Developing custom components for use in RichFaces 4.0.0.ALPHA2<remark> (draft)</remark> + projects</subtitle> + <productname>RichFaces</productname> + <productnumber>4.0</productnumber> + <edition>0.1</edition> + <pubsnumber>0</pubsnumber> + <abstract> + <para>This book details how to use the RichFaces Component Development +Kit to create custom components for use with the RichFaces +4.0 framework.</para></abstract> + <corpauthor> + <inlinemediaobject> + <imageobject> + <imagedata fileref="./images/rf_logo.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <phrase>Logo</phrase> + </textobject> + </inlinemediaobject> + </corpauthor> + <copyright> + <year>2009</year> + <holder>Red Hat</holder> + </copyright> + <!-- FOR PUBLICAN --><legalnotice xml:base="Common_Content/Legal_Notice.xml"> + <para> + Copyright <trademark class="copyright"/> 2009 Red Hat This material may only be distributed subject to the terms and conditions set forth in the GNU Free Documentation License (GFDL), V1.2 or later (the latest version is presently available at <ulink url="http://www.gnu.org/licenses/fdl.txt">http://www.gnu.org...>). + </para> +</legalnotice> + <authorgroup lang="en-US"> + <author> + <firstname>Sean</firstname> + <surname>Rogers</surname> + <affiliation> + <orgname>Red Hat</orgname> + <orgdiv>Engineering Content Services</orgdiv> + </affiliation> + <email&gt;serogers(a)redhat.com&lt;/email&gt; + </author> +</authorgroup> + </bookinfo> + <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> --><chapter id="chap-Component_Development_Kit_Guide-Introduction" lang="en-US"> + <title>Introduction</title> + <para> + This is a test paragraph + </para> +</chapter> + <chapter id="chap-Component_Development_Kit_Guide-Configuration" lang="en-US"> + <title>Configuration</title> + <para> + This is a test paragraph + </para> +</chapter> + <chapter id="chap-Component_Development_Kit_Guide-Creating_a_new_component" lang="en-US"> + <title>Creating a new component</title> + <para> + This is a test paragraph + </para> + <section id="sect-Component_Development_Kit_Guide-Creating_a_new_component-Creating_a_project"> + <title>Creating a project</title> + <para> + Test of a section + </para> + </section> + + <section id="sect-Component_Development_Kit_Guide-Creating_a_new_component-Building_a_component_skeleton"> + <title>Building a component skeleton</title> + <para> + Test of a section + </para> + </section> + + <section id="sect-Component_Development_Kit_Guide-Creating_a_new_component-Creating_the_UI"> + <title>Creating the UI</title> + <para> + Test of a section + </para> + </section> + + <section id="sect-Component_Development_Kit_Guide-Creating_a_new_component-Registering_resources"> + <title>Registering resources</title> + <para> + Test of a section + </para> + </section> + + <section id="sect-Component_Development_Kit_Guide-Creating_a_new_component-Extending_the_UIInput_Class"> + <title>Extending the UIInput Class</title> + <para> + Test of a section + </para> + </section> + + <section id="sect-Component_Development_Kit_Guide-Creating_a_new_component-Configuring_the_component"> + <title>Configuring the component</title> + <para> + Test of a section + </para> + </section> + + <section id="sect-Component_Development_Kit_Guide-Creating_a_new_component-Tags_and_descriptors"> + <title>Tags and descriptors</title> + <para> + Test of a section + </para> + </section> + +</chapter> + <chapter id="chap-Component_Development_Kit_Guide-Using_components_in_projects" lang="en-US"> + <title>Using components in projects</title> + <para> + This is a test paragraph + </para> +</chapter> + <chapter id="chap-Component_Development_Kit_Guide-Developer_sample" lang="en-US"> + <title>Developer sample</title> + <para> + This is a test paragraph + </para> +</chapter> + <chapter id="chap-Component_Development_Kit_Guide-Unit_testing" lang="en-US"> + <title>Unit testing</title> + <para> + This is a test paragraph + </para> +</chapter> + <chapter id="chap-Component_Development_Kit_Guide-Creating_components_in_other_environments" lang="en-US"> + <title>Creating components in other environments</title> + <para> + Creating components in other environments + </para> +</chapter> + <appendix id="appe-Component_Development_Kit_Guide-Naming_conventions" lang="en-US"> + <title>Naming conventions</title> + <para> + This is a test paragraph + </para> +</appendix> + <appendix id="appe-Component_Development_Kit_Guide-Template_tags_reference" lang="en-US"> + <title>Template tags reference</title> + <para> + This is a test paragraph + </para> +</appendix> + <appendix id="appe-Component_Development_Kit_Guide-Revision_History" lang="en-US"> + <title>Revision History</title> + <simpara> + <revhistory> + <revision> + <revnumber>1.0</revnumber> + <date/> + <author> + <firstname/> + <surname/> + <email/> + </author> + <revdescription> + <simplelist> + <member/> + </simplelist> + </revdescription> + </revision> + </revhistory> + </simpara> +</appendix> + <index/> +</book> Added: root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml (rev 0) +++ root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml 2009-10-29 06:18:21 UTC (rev 15771) @@ -0,0 +1,1073 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Component_Reference.ent"> +<!ENTITY PRODUCT "RichFaces"> +<!ENTITY VERSION "4.0"> +<!ENTITY VERSION_LONG "4.0.0.ALPHA2"> +<!ENTITY BOOKID "Component_Reference"> +<!ENTITY HOLDER "Red Hat"> +<!ENTITY YEAR "2009"> +]> +<book lang="en-US" status="draft"> + <bookinfo id="book-Component_Reference-Component_Reference" lang="en-US"> + <title>Component Reference</title> + <subtitle>A reference guide to the components of the RichFaces 4.0.0.ALPHA2<remark> (draft)</remark> + framework</subtitle> + <productname>RichFaces</productname> + <productnumber>4.0</productnumber> + <edition>0.1</edition> + <pubsnumber>0</pubsnumber> + <abstract> + <para>This book details each component in the RichFaces 4.0 +framework, including examples of their use in applications.</para></abstract> + <corpauthor> + <inlinemediaobject> + <imageobject> + <imagedata fileref="./images/rf_logo.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <phrase>Logo</phrase> + </textobject> + </inlinemediaobject> + </corpauthor> + <copyright> + <year>2009</year> + <holder>Red Hat</holder> + </copyright> + <!-- FOR PUBLICAN --><legalnotice xml:base="Common_Content/Legal_Notice.xml"> + <para> + Copyright <trademark class="copyright"/> 2009 Red Hat This material may only be distributed subject to the terms and conditions set forth in the GNU Free Documentation License (GFDL), V1.2 or later (the latest version is presently available at <ulink url="http://www.gnu.org/licenses/fdl.txt">http://www.gnu.org...>). + </para> +</legalnotice> + <authorgroup lang="en-US"> + <author> + <firstname>Sean</firstname> + <surname>Rogers</surname> + <affiliation> + <orgname>Red Hat</orgname> + <orgdiv>Engineering Content Services</orgdiv> + </affiliation> + <email&gt;serogers(a)redhat.com&lt;/email&gt; + </author> +</authorgroup> + </bookinfo> + <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> --><chapter id="chap-Component_Reference-Introduction" lang="en-US"> + <title>Introduction</title> + <para> + This book is a guide to the various components available in the RichFaces 4.0 framework. It includes descriptions of the role of the components, details on how best to use them, coded examples of their use, and basic references of their properties and attributes. + </para> + <para> + For full in-depth references for all component classes and properties, refer to the <citetitle>API Reference</citetitle> available from the RichFaces website. + </para> + <section id="sect-Component_Reference-Introduction-Libraries"> + <title>Libraries</title> + <para> + The RichFaces framework as it now stands is made up of two tag libraries: the <classname>a4j</classname> library and the <classname>rich</classname> library. The <classname>a4j</classname> tag library represents Ajax4jsf, which provides page-level Ajax support with core Ajax components. This allows developers to make use of custom Ajax behavior with existing components. The <classname>rich</classname> tag library provides Ajax support at the component level instead, and includes ready-made, self-contained components. These components don't require additional configuration in order to send requests or update. + </para> + <note> + <title>Note</title> + <para> + All components in the <classname>a4j</classname> library feature built-in Ajax support, so it is unnecessary to add the <classname>&lt;a4j:ajax&gt;</classname> behavior. + </para> + </note> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Common_Ajax_attributes" lang="en-US"> + <title>Common Ajax attributes</title> + <para> + The Ajax components in the <classname>a4j</classname> library share common attributes to perform similar functionality. Most RichFaces components in the <classname>rich</classname> library that feature built-in Ajax support share these common attributes as well. + </para> + <para> + Most attributes have default values, so they need not be explicitly set for the component to function in its default state. These attributes can be altered to customize the behavior of the component if necessary. + </para> + <section id="sect-Component_Reference-Common_Ajax_attributes-Rendering"> + <title>Rendering</title> + <section id="sect-Component_Reference-Rendering-render"> + <title><code>render</code></title> + <para> + The <code>render</code> attribute provides a reference to one or more areas on the page that need updating after an Ajax interaction. It uses the <code>UIComponent.findComponent()</code> algorithm to find the components in the component tree using their <code>id</code> attributes as a reference. Components can be referenced by their <code>id</code> attribute alone, or by a hierarchy of components' <code>id</code> attributes to make locating components more efficient. <xref linkend="exam-Component_Reference-render-render_example"/> shows both ways of referencing components. Each command button will correctly render the referenced panel grids, but the second button locates the references more efficiently with explicit hierarchy paths. + </para> + <example id="exam-Component_Reference-render-render_example"> + <title>render example</title> + +<programlisting language="xml"> +&lt;h:form id="form1"&gt; + &lt;a4j:commandButton value="Basic reference" render="infoBlock, infoBlock2" /&gt; + &lt;a4j:commandButton value="Specific reference" render=":infoBlock,:sv:infoBlock2" /&gt; +&lt;/h:form&gt; + +&lt;h:panelGrid id="infoBlock"&gt; + ... +&lt;/h:panelGrid&gt; + +&lt;f:subview id="sv"&gt; + &lt;h:panelGrid id="infoBlock2"&gt; + ... + &lt;/h:panelGrid&gt; +&lt;/f:subview&gt; +</programlisting> + </example> + <para> + The value of the <code>render</code> attribute can also be an expression written using JavaServer Faces' Expression Language (<acronym>EL</acronym>); this can either be a <type>Set</type>, <type>Collection</type>, <type>Array</type>, or <type>String</type>. + </para> + <important> + <title>Important</title> + <para> + A common problem with using <code>render</code> occurs when the referenced component has a <code>rendered</code> attribute. <acronym>JSF</acronym> does not mark the place in the browser's Document Object Model (<acronym>DOM</acronym>) where the rendered component would be placed in case the <code>rendered</code> attribute returns <literal>false</literal>. As such, when RichFaces sends the render code to the client, the page does not update as the place for the update is not known. + </para> + <para> + To work around this issue, wrap the component to be rendered in an <classname>&lt;a4j:outputPanel&gt;</classname> with <code>layout="none"</code>. The <classname>&lt;a4j:outputPanel&gt;</classname> will receive the update and render the component as required. + </para> + </important> + </section> + + <section id="sect-Component_Reference-Rendering-ajaxRendered"> + <title>ajaxRendered</title> + <para> + A component with <code>ajaxRendered="true"</code> will be re-rendered with <emphasis>every</emphasis> Ajax request, even when not referenced by the requesting component's <code>render</code> attribute. This can be useful for updating a status display or error message without explicitly requesting it. + </para> + <para> + Rendering of components in this way can be repressed by adding <code>limitRender="true"</code> to the requesting component, as described in <xref linkend="sect-Component_Reference-Rendering-limitRender"/>. + </para> + </section> + + <section id="sect-Component_Reference-Rendering-limitRender"> + <title>limitRender</title> + <para> + A component with <code>limitRender="true"</code> specified will <emphasis>not</emphasis> cause components with <code>ajaxRendered="true"</code> to re-render, and only those components listed in the <code>render</code> attribute will be updated. This essentially overrides the <code>ajaxRendered</code> attribute in other components. + </para> + <para> + <xref linkend="exam-Component_Reference-limitRender-Rendering_example"/> describes two command buttons, a panel grid rendered by the buttons, and an output panel showing error messages. When the first button is clicked, the output panel is rendered even though it is not explicitly referenced with the <code>render</code> attribute. The second button, however, uses <code>limitRender="true"</code> to override the output panel's rendering and only render the panel grid. + </para> + <example id="exam-Component_Reference-limitRender-Rendering_example"> + <title>Rendering example</title> + +<programlisting role="XML"> +&lt;h:form id="form1"&gt; + &lt;a4j:commandButton value="Normal rendering" render="infoBlock" /&gt; + &lt;a4j:commandButton value="Limited rendering" render="infoBlock" limitRender="true" /&gt; +&lt;/h:form&gt; + +&lt;h:panelGrid id="infoBlock"&gt; + ... +&lt;/h:panelGrid&gt; + +&lt;a4j:outputPanel ajaxRendered="true"&gt; + &lt;h:messages /&gt; +&lt;/a4j:outputPanel&gt; +</programlisting> + </example> + </section> + + </section> + + <section id="sect-Component_Reference-Common_Ajax_attributes-Queuing_and_traffic_control"> + <title>Queuing and traffic control</title> + <section id="sect-Component_Reference-Queuing_and_traffic_control-queue"> + <title>queue</title> + <para> + The <code>queue</code> attribute defines the name of the queue that will be used to schedule upcoming Ajax requests. Typically RichFaces does not queue Ajax requests, so if events are produced simultaneously they will arrive at the server simultaneously. This can potentially lead to unpredictable results when the responses are returned. The <code>queue</code> attribute ensures that the + </para> + </section> + + </section> + + <section id="sect-Component_Reference-Common_Ajax_attributes-Data_processing"> + <title>Data processing</title> + <section id="sect-Component_Reference-Data_processing-execute"> + <title>execute</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Data_processing-process"> + <title>process</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Data_processing-immediate"> + <title>immediate</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Data_processing-bypassUpdates"> + <title>bypassUpdates</title> + <para> + Incomplete + </para> + </section> + + </section> + + <section id="sect-Component_Reference-Common_Ajax_attributes-Action_and_navigation"> + <title>Action and navigation</title> + <section id="sect-Component_Reference-Action_and_navigation-action"> + <title>action</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Action_and_navigation-actionListener"> + <title>actionListener</title> + <para> + Incomplete + </para> + </section> + + </section> + + <section id="sect-Component_Reference-Common_Ajax_attributes-Events_and_Javascript_interactions"> + <title>Events and Javascript interactions</title> + <section id="sect-Component_Reference-Events_and_Javascript_interactions-onsubmit"> + <title>onsubmit</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Events_and_Javascript_interactions-onclick"> + <title>onclick</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Events_and_Javascript_interactions-oncomplete"> + <title>oncomplete</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Events_and_Javascript_interactions-onbegin"> + <title>onbegin</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Events_and_Javascript_interactions-onsuccess"> + <title>onsuccess</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Events_and_Javascript_interactions-onerror"> + <title>onerror</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Events_and_Javascript_interactions-data"> + <title>data</title> + <para> + Incomplete + </para> + </section> + + </section> + +</chapter> + <chapter id="chap-Component_Reference-Rich_inputs" lang="en-US"> + <title>Rich inputs</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Rich_inputs-richCalendar"> + <title>rich:Calendar</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Rich_inputs-richcolorPicker"> + <title>rich:colorPicker</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Rich_inputs-richcomboBox"> + <title>rich:comboBox</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Rich_inputs-richeditor"> + <title>rich:editor</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Rich_inputs-richfileUpload"> + <title>rich:fileUpload</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Rich_inputs-richinplaceInput"> + <title>rich:inplaceInput</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Rich_inputs-richinplaceSelect"> + <title>rich:inplaceSelect</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Rich_inputs-richinputNumberSlider"> + <title>rich:inputNumberSlider</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Rich_inputs-richinputNumberSpinner"> + <title>rich:inputNumberSpinner</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Rich_inputs-richsuggestionBox"> + <title>rich:suggestionBox</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Panels_and_containers" lang="en-US"> + <title>Panels and containers</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Panels_and_containers-a4jform"> + <title>a4j:form</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-a4joutputPanel"> + <title>a4j:outputPanel</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-a4jregion"> + <title>a4j:region</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-richmodalPanel"> + <title>rich:modalPanel</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-richpanel"> + <title>rich:panel</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-richpanelBar"> + <title>rich:panelBar</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-richpanelBarItem"> + <title>rich:panelBarItem</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-richpanelMenu"> + <title>rich:panelMenu</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-richpanelMenuGroup"> + <title>rich:panelMenuGroup</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-richpanelMenuItem"> + <title>rich:panelMenuItem</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-richsimpleTogglePanel"> + <title>rich:simpleTogglePanel</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-richtabPanel"> + <title>rich:tabPanel</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-richtab"> + <title>rich:tab</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-richtogglePanel"> + <title>rich:togglePanel</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Panels_and_containers-richtoggleControl"> + <title>rich:toggleControl</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Tables_and_grids" lang="en-US"> + <title>Tables and grids</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Tables_and_grids-richcolumn"> + <title>rich:column</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richcolumnGroup"> + <title>rich:columnGroup</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richcolumns"> + <title>rich:columns</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richdataFilterSlider"> + <title>rich:dataFilterSlider</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richdataGrid"> + <title>rich:dataGrid</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richdataScroller"> + <title>rich:dataScroller</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richdataTable"> + <title>rich:dataTable</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richextendedDataTable"> + <title>rich:extendedDataTable</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richrepeat"> + <title>rich:repeat</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richscrollableDataTable"> + <title>rich:scrollableDataTable</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-richsubTable"> + <title>rich:subTable</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-Table_filtering"> + <title>Table filtering</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Tables_and_grids-Table_sorting"> + <title>Table sorting</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Lists_and_trees" lang="en-US"> + <title>Lists and trees</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Lists_and_trees-richdataDefinitionList"> + <title>rich:dataDefinitionList</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Lists_and_trees-richdataList"> + <title>rich:dataList</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Lists_and_trees-richdataOrderedList"> + <title>rich:dataOrderedList</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Lists_and_trees-richlistShuttle"> + <title>rich:listShuttle</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Lists_and_trees-richorderingList"> + <title>rich:orderingList</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Lists_and_trees-richpickList"> + <title>rich:pickList</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Lists_and_trees-richchangeExpandListener"> + <title>rich:changeExpandListener</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Lists_and_trees-richnodeSelectListener"> + <title>rich:nodeSelectListener</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Lists_and_trees-richrecursiveTreeNodesAdapter"> + <title>rich:recursiveTreeNodesAdapter</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Lists_and_trees-richtree"> + <title>rich:tree</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Lists_and_trees-richtreeNode"> + <title>rich:treeNode</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Lists_and_trees-richtreeNodesAdapter"> + <title>rich:treeNodesAdapter</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Menus_and_toolbars" lang="en-US"> + <title>Menus and toolbars</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Menus_and_toolbars-richcontextMenu"> + <title>rich:contextMenu</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Menus_and_toolbars-richdropDownMenu"> + <title>rich:dropDownMenu</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Menus_and_toolbars-richmenuGroup"> + <title>rich:menuGroup</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Menus_and_toolbars-richmenuItem"> + <title>rich:menuItem</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Menus_and_toolbars-richmenuSeparator"> + <title>rich:menuSeparator</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Menus_and_toolbars-richtoolBar"> + <title>rich:toolBar</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Menus_and_toolbars-richtoolBarGroup"> + <title>rich:toolBarGroup</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Messages" lang="en-US"> + <title>Messages</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Messages-richmessage"> + <title>rich:message</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Messages-richmessages"> + <title>rich:messages</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Messages-richprogressBar"> + <title>rich:progressBar</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Messages-richtoolTip"> + <title>rich:toolTip</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Drag_and_drop" lang="en-US"> + <title>Drag and drop</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Drag_and_drop-richdragIndicator"> + <title>rich:dragIndicator</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Drag_and_drop-richdragSupport"> + <title>rich:dragSupport</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Drag_and_drop-richdropSupport"> + <title>rich:dropSupport</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Drag_and_drop-richdragListener"> + <title>rich:dragListener</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Drag_and_drop-richdropListener"> + <title>rich:dropListener</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Drag_and_drop-richdndParam"> + <title>rich:dndParam</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Layout_and_appearance" lang="en-US"> + <title>Layout and appearance</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Layout_and_appearance-a4jloadStyle"> + <title>a4j:loadStyle</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Layout_and_appearance-richeffect"> + <title>rich:effect</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Layout_and_appearance-richjQuery"> + <title>rich:jQuery</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Layout_and_appearance-richseparator"> + <title>rich:separator</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Layout_and_appearance-richspacer"> + <title>rich:spacer</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Layout_and_appearance-richpage"> + <title>rich:page</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Layout_and_appearance-richlayout"> + <title>rich:layout</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Layout_and_appearance-richlayoutPanel"> + <title>rich:layoutPanel</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Resource_handling" lang="en-US"> + <title>Resource handling</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Resource_handling-a4jloadBundle"> + <title>a4j:loadBundle</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Resource_handling-a4jkeepAlive"> + <title>a4j:keepAlive</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Resource_handling-a4jpoll"> + <title>a4j:poll</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Resource_handling-a4jpush"> + <title>a4j:push</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Resource_handling-a4jqueue"> + <title>a4j:queue</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Resource_handling-a4jstatus"> + <title>a4j:status</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Validation" lang="en-US"> + <title>Validation</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Validation-richajaxValidator"> + <title>rich:ajaxValidator</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Validation-richgraphValidator"> + <title>rich:graphValidator</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Validation-richbeanValidator"> + <title>rich:beanValidator</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Portals" lang="en-US"> + <title>Portals</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Portals-a4jportlet"> + <title>a4j:portlet</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Functionality_extension" lang="en-US"> + <title>Functionality extension</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Functionality_extension-a4jactionParam"> + <title>a4j:actionParam</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Functionality_extension-a4jajax"> + <title>a4j:ajax</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Functionality_extension-a4jajaxListener"> + <title>a4j:ajaxListener</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Functionality_extension-a4jinclude"> + <title>a4j:include</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Functionality_extension-a4jjsFunction"> + <title>a4j:jsFunction</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Functionality_extension-a4jloadScript"> + <title>a4j:loadScript</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Functionality_extension-a4jlog"> + <title>a4j:log</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Functionality_extension-richcomponentControl"> + <title>rich:componentControl</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Component_Reference-Other_components" lang="en-US"> + <title>Other components</title> + <para> + Incomplete + </para> + <section id="sect-Component_Reference-Other_components-a4jmediaOutput"> + <title>a4j:mediaOutput</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Other_components-richhotkey"> + <title>rich:hotkey</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Other_components-richinsert"> + <title>rich:insert</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Other_components-richpaint2D"> + <title>rich:paint2D</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Other_components-richgmap"> + <title>rich:gmap</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Component_Reference-Other_components-richvirtualEarth"> + <title>rich:virtualEarth</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <appendix id="appe-Component_Reference-Revision_History" lang="en-US"> + <title>Revision History</title> + <simpara> + <revhistory> + <revision> + <revnumber>1.0</revnumber> + <date/> + <author> + <firstname/> + <surname/> + <email/> + </author> + <revdescription> + <simplelist> + <member/> + </simplelist> + </revdescription> + </revision> + </revhistory> + </simpara> +</appendix> + <index/> +</book> Added: root/docs/trunk/Developer_Guide/en-US/all-Developer_Guide.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/all-Developer_Guide.xml (rev 0) +++ root/docs/trunk/Developer_Guide/en-US/all-Developer_Guide.xml 2009-10-29 06:18:21 UTC (rev 15771) @@ -0,0 +1,323 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> +<!ENTITY PRODUCT "RichFaces"> +<!ENTITY VERSION "4.0"> +<!ENTITY VERSION_LONG "4.0.0.ALPHA2"> +<!ENTITY BOOKID "Developer_Guide"> +<!ENTITY HOLDER "Red Hat"> +<!ENTITY YEAR "2009"> +]> +<book lang="en-US" status="draft"> + <bookinfo id="book-Developer_Guide-Developer_Guide" lang="en-US"> + <title>Developer Guide</title> + <subtitle>Developing projects using RichFaces 4.0.0.ALPHA2<remark> (draft)</remark> + </subtitle> + <productname>RichFaces</productname> + <productnumber>4.0</productnumber> + <edition>0.1</edition> + <pubsnumber>0</pubsnumber> + <abstract> + <para>This book is a comprehensive reference for getting started and +working with RichFaces 4.0. It includes details of the +architecture, the framework's use in different applications, +and skinning implementations.</para></abstract> + <corpauthor> + <inlinemediaobject> + <imageobject> + <imagedata fileref="./images/rf_logo.png" format="PNG" scalefit="1"/> + </imageobject> + <textobject> + <phrase>Logo</phrase> + </textobject> + </inlinemediaobject> + </corpauthor> + <copyright> + <year>2009</year> + <holder>Red Hat</holder> + </copyright> + <!-- FOR PUBLICAN --><legalnotice xml:base="Common_Content/Legal_Notice.xml"> + <para> + Copyright <trademark class="copyright"/> 2009 Red Hat This material may only be distributed subject to the terms and conditions set forth in the GNU Free Documentation License (GFDL), V1.2 or later (the latest version is presently available at <ulink url="http://www.gnu.org/licenses/fdl.txt">http://www.gnu.org...>). + </para> +</legalnotice> + <authorgroup lang="en-US"> + <author> + <firstname>Sean</firstname> + <surname>Rogers</surname> + <affiliation> + <orgname>Red Hat</orgname> + <orgdiv>Engineering Content Services</orgdiv> + </affiliation> + <email&gt;serogers(a)redhat.com&lt;/email&gt; + </author> +</authorgroup> + </bookinfo> + <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> --><chapter id="chap-Developer_Guide-Introduction" lang="en-US"> + <title>Introduction</title> + <para> + RichFaces is a rich component library for JavaServer Faces (<acronym>JSF</acronym>) built on the open-source Ajax4jsf framework. It allows easy integration of Ajax capabilities into enterprise application development without needing to use Javascript. + </para> +</chapter> + <chapter id="chap-Developer_Guide-Getting_started_with_RichFaces" lang="en-US"> + <title>Getting started with RichFaces</title> + <para> + Incomplete + </para> + <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Technical_Requirements"> + <title>Technical Requirements</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Installing_RichFaces"> + <title>Installing RichFaces</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Configuration"> + <title>Configuration</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Creating_a_project"> + <title>Creating a project</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Developer_Guide-RichFaces_overview" lang="en-US"> + <title>RichFaces overview</title> + <para> + Incomplete + </para> + <section id="sect-Developer_Guide-RichFaces_overview-Architecture"> + <title>Architecture</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-RichFaces_overview-Technologies"> + <title>Technologies</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-RichFaces_overview-Differences_between_JSF_and_RichFaces_mechanisms"> + <title>Differences between <acronym>JSF</acronym> and RichFaces mechanisms</title> + <para> + JavaServer Faces (<acronym>JSF</acronym>) declares render and execute processes on the client side, while RichFaces declares server-side definitions of lists. + </para> + </section> + + <section id="sect-Developer_Guide-RichFaces_overview-Restrictions"> + <title>Restrictions</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-RichFaces_overview-Using_RichFaces_with_Maven"> + <title>Using RichFaces with Maven</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-RichFaces_overview-Using_RichFaces_in_existing_JSF_projects"> + <title>Using RichFaces in existing JSF projects</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Developer_Guide-Basic_concepts" lang="en-US"> + <title>Basic concepts</title> + <para> + This chapter covers the basic concepts for using RichFaces in conjunction with Ajax and JavaServer Faces. + </para> + <section id="sect-Developer_Guide-Basic_concepts-Sending_an_Ajax_request"> + <title>Sending an Ajax request</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Basic_concepts-Receiving_events_and_updates"> + <title>Receiving events and updates</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Basic_concepts-Ajax_attributes"> + <title>Ajax attributes</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Basic_concepts-Ajax_containers"> + <title>Ajax containers</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Basic_concepts-Component_overview"> + <title>Component overview</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Developer_Guide-Advanced_features" lang="en-US"> + <title>Advanced features</title> + <para> + Incomplete + </para> + <section id="sect-Developer_Guide-Advanced_features-Additions_to_JSF2"> + <title>Additions to JSF2</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Advanced_features-Performance_optimization"> + <title>Performance optimization</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Advanced_features-Traffic_control_and_queues"> + <title>Traffic control and queues</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Advanced_features-Validation"> + <title>Validation</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Advanced_features-Filters"> + <title>Filters</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Advanced_features-Scripts_and_styles"> + <title>Scripts and styles</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Advanced_features-Error_handling"> + <title>Error handling</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Advanced_features-Managing_states"> + <title>Managing states</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Advanced_features-User_roles"> + <title>User roles</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <chapter id="chap-Developer_Guide-Skinning_and_theming" lang="en-US"> + <title>Skinning and theming</title> + <para> + Incomplete + </para> + <section id="sect-Developer_Guide-Skinning_and_theming-What_are_skins_and_themes"> + <title>What are skins and themes?</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Skinning_and_theming-Using_skins"> + <title>Using skins</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Skinning_and_theming-Customizing_skins"> + <title>Customizing skins</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Skinning_and_theming-Changing_skins_at_runtime"> + <title>Changing skins at runtime</title> + <para> + Incomplete + </para> + </section> + + <section id="sect-Developer_Guide-Skinning_and_theming-Extended_skinning"> + <title>Extended skinning</title> + <para> + Incomplete + </para> + </section> + +</chapter> + <appendix id="appe-Developer_Guide-Resources" lang="en-US"> + <title>Resources</title> + <para> + Incomplete + </para> +</appendix> + <appendix id="appe-Developer_Guide-Revision_History" lang="en-US"> + <title>Revision History</title> + <simpara> + <revhistory> + <revision> + <revnumber>1.0</revnumber> + <date/> + <author> + <firstname/> + <surname/> + <email/> + </author> + <revdescription> + <simplelist> + <member/> + </simplelist> + </revdescription> + </revision> + </revhistory> + </simpara> +</appendix> + <index/> +</book>