[richfaces-svn-commits] JBoss Rich Faces SVN: r18942 - in modules/docs/trunk: Component_Development_Kit_Guide/src/main/docbook/en-US and 7 other directories.

Author: SeanRogers Date: 2010-08-24 00:06:04 -0400 (Tue, 24 Aug 2010) New Revision: 18942 Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jajax-a4jajax_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jkeepAlive-a4jkeepAlive_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jlog-a4jlog_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jstatus-Basic_a4jstatus_usage.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-data-Data_reference_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-limitRender-Rendering_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-render-render_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Defining_suggestion_values.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Attaching_richcomponentControl_to_a_component.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-0.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-1.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpopupPanel-Header_and_controls.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpopupPanel-richpopupPanel_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtoggleControl-richtoggleControl_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richaccordion-richaccordion.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richautocomplete-richautocomplete.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpopupPanel-Header_and_controls.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtabPanel-richtabPanel_component.png Removed: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpanelBar-richpanelBar.png Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Author_Group.xml modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Book_Info.xml modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Component_Development_Kit_Guide.ent modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Configuration.xml modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Creating_a_new_component.xml modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Creating_components_in_other_environments.xml modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Developer_sample.xml modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Introduction.xml modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Naming_conventions.xml modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Preface.xml modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Revision_History.xml modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Template_tags_reference.xml modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Unit_testing.xml modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Using_components_in_projects.xml modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Book_Info.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.ent modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Common_Ajax_attributes.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Processing_management.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Selection_and_ordering.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Validation.xml modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/Book_Info.xml modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/Developer_Guide.ent modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Book_Info.xml modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Introduction.xml modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Migration_Guide.ent modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Migration_Guide.xml modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Preface.xml modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Revision_History.xml modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Upgrading.xml modules/docs/trunk/bundle_docs.sh modules/docs/trunk/parent/pom.xml Log: Merged changes for M2 Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Author_Group.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Author_Group.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Author_Group.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE authorgroup 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"> -%BOOK_ENTITIES; ]> <authorgroup> <author> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Book_Info.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Book_Info.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Book_Info.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,12 +1,10 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE bookinfo 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"> -%BOOK_ENTITIES; ]> <bookinfo id="book-Component_Development_Kit_Guide-Component_Development_Kit_Guide"> <title>Component Development Kit Guide</title> - <subtitle>Developing custom components for use in RichFaces &VERSIONLONG;<remark> (draft)</remark> + <subtitle>Developing custom components for use in RichFaces 4<remark> (draft)</remark> projects</subtitle> <productname>RichFaces</productname> <productnumber>4.0</productnumber> @@ -14,7 +12,7 @@ <pubsnumber>1</pubsnumber> <abstract> <para>This book details how to use the RichFaces Component Development -Kit to create custom components for use with the RichFaces &VERSION; +Kit to create custom components for use with the RichFaces 4 framework.</para> </abstract> <corpauthor> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Component_Development_Kit_Guide.ent =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Component_Development_Kit_Guide.ent 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Component_Development_Kit_Guide.ent 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,6 +1,5 @@ <!ENTITY PRODUCT "RichFaces"> <!ENTITY VERSION "4.0"> -<!ENTITY VERSIONLONG "4.0.0.ALPHA2"> <!ENTITY BOOKID "Component_Development_Kit_Guide"> <!ENTITY HOLDER "Red Hat"> <!ENTITY YEAR "2009"> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Configuration.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Configuration.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Configuration.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter 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"> -%BOOK_ENTITIES; ]> <chapter id="chap-Component_Development_Kit_Guide-Configuration"> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Creating_a_new_component.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Creating_a_new_component.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Creating_a_new_component.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter 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"> -%BOOK_ENTITIES; ]> <chapter id="chap-Component_Development_Kit_Guide-Creating_a_new_component"> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Creating_components_in_other_environments.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Creating_components_in_other_environments.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Creating_components_in_other_environments.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter 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"> -%BOOK_ENTITIES; ]> <chapter id="chap-Component_Development_Kit_Guide-Creating_components_in_other_environments"> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Developer_sample.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Developer_sample.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Developer_sample.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter 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"> -%BOOK_ENTITIES; ]> <chapter id="chap-Component_Development_Kit_Guide-Developer_sample"> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Introduction.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Introduction.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Introduction.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter 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"> -%BOOK_ENTITIES; ]> <chapter id="chap-Component_Development_Kit_Guide-Introduction"> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Naming_conventions.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Naming_conventions.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Naming_conventions.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE appendix 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"> -%BOOK_ENTITIES; ]> <appendix id="appe-Component_Development_Kit_Guide-Naming_conventions"> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Preface.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Preface.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Preface.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE preface 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"> -%BOOK_ENTITIES; ]> <preface id="pref-Component_Development_Kit_Guide-Preface"> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Revision_History.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Revision_History.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Revision_History.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE appendix 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"> -%BOOK_ENTITIES; ]> <appendix id="appe-Component_Development_Kit_Guide-Revision_History"> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Template_tags_reference.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Template_tags_reference.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Template_tags_reference.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE appendix 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"> -%BOOK_ENTITIES; ]> <appendix id="appe-Component_Development_Kit_Guide-Template_tags_reference"> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Unit_testing.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Unit_testing.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Unit_testing.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter 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"> -%BOOK_ENTITIES; ]> <chapter id="chap-Component_Development_Kit_Guide-Unit_testing"> Modified: modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Using_components_in_projects.xml =================================================================== --- modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Using_components_in_projects.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Development_Kit_Guide/src/main/docbook/en-US/Using_components_in_projects.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter 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"> -%BOOK_ENTITIES; ]> <chapter id="chap-Component_Development_Kit_Guide-Using_components_in_projects"> Modified: modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt =================================================================== --- modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt 2010-08-24 04:06:04 UTC (rev 18942) @@ -54,8 +54,8 @@ - chap-Component_Reference-Panels_and_containers x- rich:modalPanel -xx rich:panel -xx rich:panelBar +-- rich:panel +-- rich:panelBar xx rich:panelBarItem x- rich:simpleTogglePanel -- rich:tabPanel @@ -68,11 +68,11 @@ -- rich:column -- rich:columnGroup -- rich:columns -x- rich:dataDefinitionList +-- rich:dataDefinitionList x- rich:dataFilterSlider -- rich:dataGrid -x- rich:dataList -x- rich:dataOrderedList +-- rich:dataList +-- rich:dataOrderedList xx rich:dataScroller -- rich:dataTable -- rich:extendedDataTable @@ -117,7 +117,7 @@ x chap-Component_Reference-Layout_and_appearance xx rich:effect -xx rich:jQuery +-- rich:jQuery xx rich:separator xx rich:spacer xx rich:page Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Book_Info.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Book_Info.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Book_Info.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -3,7 +3,7 @@ ]> <bookinfo id="book-Component_Reference-Component_Reference"> <title>Component Reference</title> - <subtitle>A reference guide to the components of the RichFaces 4.0.0<remark> (draft)</remark> + <subtitle>A reference guide to the components of the RichFaces 4<remark> (draft)</remark> framework</subtitle> <productname>RichFaces</productname> <productnumber>4.0</productnumber> @@ -28,8 +28,12 @@ <year>&YEAR;</year> <holder>&HOLDER;</holder> </copyright> - <!-- FOR PUBLICAN --><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR JDOCBOOK: --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </xi:fallback> + <!-- FOR PUBLICAN --> + <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"> + <!-- FOR JDOCBOOK --> + <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> + <xi:include href="fallback_content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </xi:fallback> </xi:include> <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </bookinfo> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.ent =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.ent 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.ent 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,6 +1,5 @@ <!ENTITY PRODUCT "RichFaces"> <!ENTITY VERSION "4.0"> -<!ENTITY VERSIONLONG "4.0.0.ALPHA2"> <!ENTITY BOOKID "Component_Reference"> <!ENTITY HOLDER "Red Hat"> <!ENTITY YEAR "2009"> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -8,70 +8,80 @@ </para> <section id="sect-Component_Reference-Actions-a4jactionParam"> <title><sgmltag>&lt;a4j:actionParam&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.ActionParameter</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HTMLActionParameter</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;a4j:actionParam&gt;</sgmltag> behavior combines the functionality of the JavaServer Faces (<acronym>JSF</acronym>) components <sgmltag>&lt;f:param&gt;</sgmltag> and <sgmltag>&lt;f:actionListener&gt;</sgmltag>. </para> - <para> - Basic usage of the <sgmltag>&lt;a4j:actionParam&gt;</sgmltag> requires three main attributes: - </para> - <itemizedlist> - <listitem> + + <section id="sect-Component_Reference-a4jactionParam-Basic_usage"> + <title>Basic usage</title> + <para> + Basic usage of the <sgmltag>&lt;a4j:actionParam&gt;</sgmltag> requires three main attributes: + </para> + <itemizedlist> + <listitem> + <para> + <varname>name</varname>, for the name of the parameter; + </para> + </listitem> + <listitem> + <para> + <varname>value</varname>, for the initial value of the parameter; and + </para> + </listitem> + <listitem> + <para> + <varname>assignTo</varname>, for defining the bean property. The property will be updated if the parent command component performs an action event during the <emphasis>Process Request</emphasis> phase. + </para> + </listitem> + </itemizedlist> + <para> + <xref linkend="exam-Component_Reference-a4jactionParam-a4jactionParam_example" /> shows a simple implementation along with the accompanying managed bean. + </para> + <example id="exam-Component_Reference-a4jactionParam-a4jactionParam_example"> + <title><sgmltag>&lt;a4j:actionParam&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <programlisting language="Java" role="JAVA"><xi:include href="extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.js" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> - <varname>name</varname>, for the name of the parameter; + When the <guibutton>Set name to Alex</guibutton> button is pressed, the application sets the <varname>name</varname> parameter of the bean to <literal>Alex</literal>, and displays the name in the output field. </para> - </listitem> - <listitem> + </example> + </section> + + <section id="sect-Component_Reference-a4jactionParam-Interoperability"> + <title>Interoperability</title> + <para> + The <sgmltag>&lt;a4j:actionParam&gt;</sgmltag> behavior can be used with non-Ajax components in addition to Ajax components. In this way, data model values can be updated without an JavaScript code on the server side. + </para> + <para> + The <varname>converter</varname> attribute can be used to specify how to convert the value before it is submitted to the data model. The property is assigned the new value during the <emphasis>Update Model</emphasis> phase. + </para> + <note> + <title>Validation failure</title> <para> - <varname>value</varname>, for the initial value of the parameter; and + If the validation of the form fails, the <emphasis>Update Model</emphasis> phase will be skipped and the property will not be updated. </para> - </listitem> - <listitem> - <para> - <varname>assignTo</varname>, for defining the bean property. The property will be updated if the parent command component performs an action event during the <emphasis>Process Request</emphasis> phase. - </para> - </listitem> - </itemizedlist> - <para> - <xref linkend="exam-Component_Reference-a4jactionParam-a4jactionParam_example" /> shows a simple implementation along with the accompanying managed bean. When the <guibutton>Set name to Alex</guibutton> button is pressed, the application sets the <varname>name</varname> parameter of the bean to <literal>Alex</literal>, and displays the name in the output field. - </para> - <example id="exam-Component_Reference-a4jactionParam-a4jactionParam_example"> - <title><sgmltag>&lt;a4j:actionParam&gt;</sgmltag> example</title> - -<programlisting language="XML" role="XML"> -<xi:include href="extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - -<programlisting language="Java" role="JAVA"> -<xi:include href="extras/exam-Component_Reference-a4jactionParam-a4jactionParam_example.js" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - </example> - <para> - The <sgmltag>&lt;a4j:actionParam&gt;</sgmltag> behavior can be used with non-Ajax components in addition to Ajax components. In this way, data model values can be updated without an JavaScript code on the server side. - </para> - <para> - The <varname>converter</varname> attribute can be used to specify how to convert the value before it is submitted to the data model. The property is assigned the new value during the <emphasis>Update Model</emphasis> phase. - </para> - <note> - <title>Validation failure</title> + </note> <para> - If the validation of the form fails, the <emphasis>Update Model</emphasis> phase will be skipped and the property will not be updated. + Variables from JavaScript functions can be used for the <varname>value</varname> attribute. In such an implementation, the <varname>noEscape</varname> attribute should be set to <literal>true</literal>. Using <code>noEscape="true"</code>, the <varname>value</varname> attribute can contain any JavaScript expression or JavaScript function invocation, and the result will be sent to the server as the <varname>value</varname> attribute. </para> - </note> - <para> - Variables from JavaScript functions can be used for the <varname>value</varname> attribute. In such an implementation, the <varname>noEscape</varname> attribute should be set to <literal>true</literal>. Using <code>noEscape="true"</code>, the <varname>value</varname> attribute can contain any JavaScript expression or JavaScript function invocation, and the result will be sent to the server as the <varname>value</varname> attribute. - </para> + </section> + + <section id="sect-Component_Reference-a4jactionParam-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.ActionParameter</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HTMLActionParameter</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> <!-- FIXME not in M2 --> @@ -109,28 +119,9 @@ <section id="sect-Component_Reference-Actions-a4jcommandButton"> <title><sgmltag>&lt;a4j:commandButton&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.CommandButton</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxCommandButton</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>javax.faces.Command</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxCommandButtonRenderer</classname> - </para> - </listitem> - </itemizedlist> + <para> + The <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> is similar to the JavaServer Faces (<acronym>JSF</acronym>) component <sgmltag>&lt;h:commandButton&gt;</sgmltag>, but additionally includes Ajax support. When the command button is clicked it submits an Ajax form, and when a response is received the command button can be dynamically rendered. + </para> <figure id="figu-Component_Reference-a4jcommandButton-a4jcommandButton"> <title><sgmltag>&lt;a4j:commandButton&gt;</sgmltag></title> <mediaobject> @@ -144,44 +135,53 @@ </textobject> </mediaobject> </figure> - <para> - The <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> is similar to the JavaServer Faces (<acronym>JSF</acronym>) component <sgmltag>&lt;h:commandButton&gt;</sgmltag>, but additionally includes Ajax support. When the command button is clicked it generates an Ajax form submit, and when a response is received the command button can be dynamically rendered. - </para> - <para> - The <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> requires only the <varname>value</varname> and <varname>render</varname> attributes to function. The <varname>value</varname> attribute specifies the text of the button and the <varname>render</varname> attribute specifies which areas are to be updated. The <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> uses the <varname>onclick</varname> event instead of the <varname>onsubmit</varname> event, but otherwise uses all common Ajax attributes as listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />. - </para> - <note> - <title>Set <code>disabledDefault="true"</code></title> + + <section id="sect-Component_Reference-a4jcommandButton-Basic_usage"> + <title>Basic usage</title> <para> - When attaching a JavaScript function to a <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> with the help of a <sgmltag>&lt;rich:componentControl&gt;</sgmltag>, do not use the <varname>attachTo</varname> attribute of <sgmltag>&lt;rich:componentControl&gt;</sgmltag>. The attribute adds event handlers using <classname>Event.observe</classname> but <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> does not include this event. + The <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> requires only the <varname>value</varname> and <varname>render</varname> attributes to function. The <varname>value</varname> attribute specifies the text of the button and the <varname>render</varname> attribute specifies which areas are to be updated. The <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> uses the <varname>onclick</varname> event instead of the <varname>onsubmit</varname> event, but otherwise uses all common Ajax attributes as listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />. </para> - </note> + <note> + <title>Set <code>disabledDefault="true"</code></title> + <para> + When attaching a JavaScript function to a <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> with the help of a <sgmltag>&lt;rich:componentControl&gt;</sgmltag>, do not use the <varname>attachTo</varname> attribute of <sgmltag>&lt;rich:componentControl&gt;</sgmltag>. The attribute adds event handlers using <classname>Event.observe</classname> but <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> does not include this event. + </para> + </note> + </section> + + <section id="sect-Component_Reference-a4jcommandButton-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.CommandButton</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxCommandButton</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>javax.faces.Command</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxCommandButtonRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> <section id="sect-Component_Reference-Actions-a4jcommandLink"> <title><sgmltag>&lt;a4j:commandLink&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.CommandLink</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxCommandLink</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>javax.faces.Command</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxCommandLinkRenderer</classname> - </para> - </listitem> - </itemizedlist> + <para> + The <sgmltag>&lt;a4j:commandLink&gt;</sgmltag> is similar to the JavaServer Faces (<acronym>JSF</acronym>) component <sgmltag>&lt;h:commandLink&gt;</sgmltag>, but additionally includes Ajax support. When the command link is clicked it generates an Ajax form submit, and when a response is received the command link can be dynamically rendered. + </para> <figure id="figu-Component_Reference-a4jcommandLink-a4jcommandLink"> <title><sgmltag>&lt;a4j:commandLink&gt;</sgmltag></title> <mediaobject> @@ -195,132 +195,166 @@ </textobject> </mediaobject> </figure> - <para> - The <sgmltag>&lt;a4j:commandLink&gt;</sgmltag> is similar to the JavaServer Faces (<acronym>JSF</acronym>) component <sgmltag>&lt;h:commandLink&gt;</sgmltag>, but additionally includes Ajax support. When the command link is clicked it generates an Ajax form submit, and when a response is received the command link can be dynamically rendered. - </para> - <para> - The <sgmltag>&lt;a4j:commandLink&gt;</sgmltag> requires only the <varname>value</varname> and <varname>render</varname> attributes to function. The <varname>value</varname> attribute specifies the text of the link and the <varname>render</varname> attribute specifies which areas are to be updated. The <sgmltag>&lt;a4j:commandLink&gt;</sgmltag> uses the <varname>onclick</varname> event instead of the <varname>onsubmit</varname> event, but otherwise uses all common Ajax attributes as listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />. - </para> + + <section id="sect-Component_Reference-a4jcommandLink-Basic_usage"> + <title>Basic usage</title> + <para> + The <sgmltag>&lt;a4j:commandLink&gt;</sgmltag> requires only the <varname>value</varname> and <varname>render</varname> attributes to function. The <varname>value</varname> attribute specifies the text of the link and the <varname>render</varname> attribute specifies which areas are to be updated. The <sgmltag>&lt;a4j:commandLink&gt;</sgmltag> uses the <varname>onclick</varname> event instead of the <varname>onsubmit</varname> event, but otherwise uses all common Ajax attributes as listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />. + </para> + </section> + + <section id="sect-Component_Reference-a4jcommandLink-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.CommandLink</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxCommandLink</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>javax.faces.Command</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxCommandLinkRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <section id="sect-Component_Reference-Actions-richcomponentControl"> <title><sgmltag>&lt;rich:componentControl&gt;</sgmltag></title> - <remark>The following reference data is taken from the old <sgmltag>&lt;rich:componentControl&gt;</sgmltag> reference. The details may be different now that the component is part of the <classname>a4j</classname> tag library.</remark> - <itemizedlist> - <listitem> + <para> + The <sgmltag>&lt;rich:componentControl&gt;</sgmltag> allows JavaScript API functions to be called on components after defined events. Initialization variants and activation events can be customized, and parameters can be passed to the target component. + </para> + + <section id="sect-Component_Reference-richcomponentControl-Basic_usage"> + <title>Basic usage</title> + <para> + The <varname>event</varname>, <varname>for</varname>, and <varname>operation</varname> attributes are all that is required to attach JavaScript functions to the parent component. The <varname>event</varname> attribute specifies the event that triggers the JavaScript API function call. The <varname>for</varname> attribute defines the target component, and the <varname>operation</varname> attribute specifies the JavaScript function to perform. + </para> + <example id="exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage"> + <title><sgmltag>&lt;rich:componentControl&gt;</sgmltag> basic usage</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> - <parameter>component-type</parameter>: <classname>org.richfaces.ComponentControl</classname> + The example contains a single command button, which when clicked shows the modal panel with the identifier <literal>ccModalPanelID</literal>. </para> - </listitem> - <listitem> + </example> + </section> + + <section id="sect-Component_Reference-richcomponentControl-Attaching_to_a_component"> + <title>Attaching to a component</title> + <para> + The <varname>attachTo</varname> attribute can be used to attach the event to a component other than the parent component. If no <varname>attachTo</varname> attribute is supplied, the <sgmltag>&lt;rich:componentControl&gt;</sgmltag> component's parent is used, as in <xref linkend="exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage" />. + </para> + <example id="exam-Component_Reference-richcomponentControl-Attaching_richcomponentControl_to_a_component"> + <title>Attaching <sgmltag>&lt;rich:componentControl&gt;</sgmltag> to a component</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcomponentControl-Attaching_richcomponentControl_to_a_component.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlComponentControl</classname> + In the example, the <literal>onclick</literal> event of the component with the identifier <literal>ccCalendarID</literal> will trigger the <literal>Expand</literal> operation for the component with the identifier <literal>doExpandCalendarID</literal>. </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.ComponentControl</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.ComponentControlRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ComponentControlTag</classname> - </para> - </listitem> - </itemizedlist> - <para> - The <sgmltag>&lt;rich:componentControl&gt;</sgmltag> allows JavaScript API functions to be called on components after defined events. Initialization variants and activation events can be customized, and parameters can be passed to the target component. - </para> - <para> - The <varname>event</varname>, <varname>for</varname>, and <varname>operation</varname> attributes are all that is required to attach JavaScript functions to the parent component. The <varname>event</varname> attribute specifies the event that triggers the JavaScript API function call. The <varname>for</varname> attribute defines the target component, and the <varname>operation</varname> attribute specifies the JavaScript function to perform. - </para> - <example id="exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage"> - <title>rich:componentControl basic usage</title> - -<programlisting language="XML" role="XML">&lt;h:commandButton value="Show Modal Panel"&gt; - &lt;!--componentControl is attached to the commandButton--&gt; - &lt;rich:componentControl for="ccModalPanelID" event="onclick" operation="show"/&gt; -&lt;/h:commandButton&gt; -</programlisting> + </example> + </section> + + <section id="sect-Component_Reference-richcomponentControl-Parameters_and_JavaScript"> + <title>Parameters and JavaScript</title> <para> - The example contains a single command button, which when clicked shows the modal panel with the identifier <literal>ccModalPanelID</literal>. + The operation can receive parameters either through the <varname>params</varname> attribute, or by using <sgmltag>&lt;f:param&gt;</sgmltag> elements. </para> - </example> - <para> - The <varname>attachTo</varname> attribute can be used to attach the event to a component other than the parent component. If no <varname>attachTo</varname> attribute is supplied, the <sgmltag>&lt;rich:componentControl&gt;</sgmltag> component's parent is used, as in <xref linkend="exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage" />. - </para> - <example id="exam-Component_Reference-richcomponentControl-Attaching_richcomponentControl_to_a_component"> - <title>Attaching <sgmltag>&lt;rich:componentControl&gt;</sgmltag> to a component</title> - -<programlisting language="XML" role="XML">&lt;rich:componentControl attachTo="doExpandCalendarID" event="onclick" operation="Expand" for="ccCalendarID" /&gt; -</programlisting> + <example id="exam-Component_Reference-richcomponentControl-Using_parameters"> + <title>Using parameters</title> + <variablelist> + <varlistentry> + <term>The <varname>params</varname> attribute</term> + <listitem> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcomponentControl-Using_parameters-0.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </listitem> + </varlistentry> + <varlistentry> + <term><sgmltag>&lt;f:param&gt;</sgmltag> elements</term> + <listitem> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcomponentControl-Using_parameters-1.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </listitem> + </varlistentry> + </variablelist> + </example> <para> - In the example, the <literal>onclick</literal> event of the component with the identifier <literal>ccCalendarID</literal> will trigger the <literal>Expand</literal> operation for the component with the identifier <literal>doExpandCalendarID</literal>. + The <varname>name</varname> attribute can be used to define a normal JavaScript function that triggers the specified operation on the target component. </para> - </example> - <para> - The operation can receive parameters either through the <varname>params</varname> attribute, or by using <sgmltag>&lt;f:param&gt;</sgmltag> elements. - </para> - <example id="exam-Component_Reference-richcomponentControl-Using_parameters"> - <title>Using parameters</title> + </section> + + + <section id="sect-Component_Reference-richcomponentControl-Timing"> + <title>Timing</title> + <para> + The <varname>attachTiming</varname> attribute can determine the page loading phase during which the <sgmltag>&lt;rich:componentControl&gt;</sgmltag> is attached to the source component: + </para> <variablelist> <varlistentry> - <term>The <varname>params</varname> attribute</term> + <term><literal>immediate</literal></term> <listitem> - -<programlisting language="XML" role="XML">&lt;rich:componentControl name="func" event="onRowClick" for="menu" operation="show" params="#{car.model}"/&gt; -</programlisting> + <para> + attached during execution of the script. + </para> </listitem> </varlistentry> <varlistentry> - <term><sgmltag>&lt;f:param&gt;</sgmltag> elements</term> + <term><literal>onavailable</literal></term> <listitem> - -<programlisting language="XML" role="XML">&lt;rich:componentControl event="onRowClick" for="menu" operation="show"&gt; - &lt;f:param value="#{car.model}" name="model"/&gt; -&lt;/rich:componentControl&gt; -</programlisting> + <para> + attached after the target component is initialized. + </para> </listitem> </varlistentry> + <varlistentry> + <term><literal>onload</literal></term> + <listitem> + <para> + attached after the page is loaded. + </para> + </listitem> + </varlistentry> </variablelist> - </example> - <para> - The <varname>name</varname> attribute can be used to define a normal JavaScript function that triggers the specified operation on the target component. - </para> - <para> - The <varname>attachTiming</varname> attribute can determine the page loading phase during which the <sgmltag>&lt;rich:componentControl&gt;</sgmltag> is attached to the source component: - </para> - <variablelist> - <varlistentry> - <term><literal>immediate</literal></term> + </section> + + <section id="sect-Component_Reference-richcomponentControl-Reference_data"> + <title>Reference data</title> + <itemizedlist> <listitem> <para> - attached during execution of the script. + <parameter>component-type</parameter>: <classname>org.richfaces.ComponentControl</classname> </para> </listitem> - </varlistentry> - <varlistentry> - <term><literal>onavailable</literal></term> <listitem> <para> - attached after the target component is initialized. + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlComponentControl</classname> </para> </listitem> - </varlistentry> - <varlistentry> - <term><literal>onload</literal></term> <listitem> <para> - attached after the page is loaded. + <parameter>component-family</parameter>: <classname>org.richfaces.ComponentControl</classname> </para> </listitem> - </varlistentry> - </variablelist> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.ComponentControlRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ComponentControlTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <!-- TODO not in M2 --> @@ -370,146 +404,149 @@ <section id="sect-Component_Reference-Actions-a4jjsFunction"> <title><sgmltag>&lt;a4j:jsFunction&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.Function</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlajaxFunction</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.ajaxFunction</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.ajaxFunctionRenderer</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;a4j:jsFunction&gt;</sgmltag> component allows Ajax requests to be performed directly from JavaScript code, and server-side data to be invoked and returned in JavaScript Object Notation (<acronym>JSON</acronym>) format to use in client-side JavaScript calls. </para> - <para> - The <sgmltag>&lt;a4j:jsFunction&gt;</sgmltag> component has all the common Ajax action attributes as listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />; the <varname>action</varname> and <varname>actionListener</varname> attributes can be invoked and parts of the page can be re-rendered after a successful call to the JavaScript function. <xref linkend="exam-Component_Reference-a4jjsFunction-a4jjsFunction_example" /> shows how an Ajax request can be initiated from the JavaScript and a partial page update performed. The JavaScript function can be invoked with the data returned by the Ajax response. - </para> - <example id="exam-Component_Reference-a4jjsFunction-a4jjsFunction_example"> - <title><sgmltag>&lt;a4j:jsFunction&gt;</sgmltag> example</title> - -<programlisting language="XML" role="XML"> -<xi:include href="extras/exam-Component_Reference-a4jjsFunction-a4jjsFunction_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - </example> - <para> - The <sgmltag>&lt;a4j:jsFunction&gt;</sgmltag> component allows the use of the <sgmltag>&lt;a4j:actionParam&gt;</sgmltag> component or the JavaServer Faces <sgmltag>&lt;f:param&gt;</sgmltag> component to pass any number of parameters for the JavaScript function. - </para> - <para> - The <sgmltag>&lt;a4j:jsFunction&gt;</sgmltag> component is similar to the <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> component, but it can be activated from the JavaScript code. This allows some server-side functionality to be invoked and the returned data to subsequently be used in a JavaScript function invoked by the <varname>oncomplete</varname> event attribute. In this way, the <sgmltag>&lt;a4j:jsFunction&gt;</sgmltag> component can be used instead of the <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> component. - </para> + + <section id="sect-Component_Reference-a4jjsFunction-Basic_usage"> + <title>Basic usage</title> + <para> + The <sgmltag>&lt;a4j:jsFunction&gt;</sgmltag> component has all the common Ajax action attributes as listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />; the <varname>action</varname> and <varname>actionListener</varname> attributes can be invoked and parts of the page can be re-rendered after a successful call to the JavaScript function. <xref linkend="exam-Component_Reference-a4jjsFunction-a4jjsFunction_example" /> shows how an Ajax request can be initiated from the JavaScript and a partial page update performed. The JavaScript function can be invoked with the data returned by the Ajax response. + </para> + <example id="exam-Component_Reference-a4jjsFunction-a4jjsFunction_example"> + <title><sgmltag>&lt;a4j:jsFunction&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jjsFunction-a4jjsFunction_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-a4jjsFunction-Parameters_and_JavaScript"> + <title>Parameters and JavaScript</title> + <para> + The <sgmltag>&lt;a4j:jsFunction&gt;</sgmltag> component allows the use of the <sgmltag>&lt;a4j:actionParam&gt;</sgmltag> component or the JavaServer Faces <sgmltag>&lt;f:param&gt;</sgmltag> component to pass any number of parameters for the JavaScript function. + </para> + <para> + The <sgmltag>&lt;a4j:jsFunction&gt;</sgmltag> component is similar to the <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> component, but it can be activated from the JavaScript code. This allows some server-side functionality to be invoked and the returned data to subsequently be used in a JavaScript function invoked by the <varname>oncomplete</varname> event attribute. In this way, the <sgmltag>&lt;a4j:jsFunction&gt;</sgmltag> component can be used instead of the <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> component. + </para> + </section> + + <section id="sect-Component_Reference-a4jjsFunction-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Function</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlajaxFunction</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.ajaxFunction</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.ajaxFunctionRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <section id="sect-Component_Reference-Actions-a4jpoll"> <title><sgmltag>&lt;a4j:poll&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.Poll</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.AjaxPoll</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.AjaxPoll</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxPollRenderer</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;a4j:poll&gt;</sgmltag> component allows periodical sending of Ajax requests to the server. It is used for repeatedly updating a page at specific time intervals. </para> - <para> - The <varname>interval</varname> attribute specifies the time in milliseconds between requests. The default for this value is 1000 ms (1 second). - </para> - <para> - The <varname>timeout</varname> attribute defines the response waiting time in milliseconds. If a response isn't received within the timeout period, the connection is aborted and the next request is sent. By default, the timeout is not set. - </para> - <para> - The <sgmltag>&lt;a4j:poll&gt;</sgmltag> component can be enabled and disabled using the <varname>enabled</varname> attribute. Using Expression Language (<acronym>EL</acronym>), the <varname>enabled</varname> attribute can point to a bean property to apply a particular attribute value. - </para> + + <section id="sect-Component_Reference-a4jpoll-Timing_options"> + <title>Timing options</title> + <para> + The <varname>interval</varname> attribute specifies the time in milliseconds between requests. The default for this value is 1000 ms (1 second). + </para> + <para> + The <varname>timeout</varname> attribute defines the response waiting time in milliseconds. If a response isn't received within the timeout period, the connection is aborted and the next request is sent. By default, the timeout is not set. + </para> + <para> + The <sgmltag>&lt;a4j:poll&gt;</sgmltag> component can be enabled and disabled using the <varname>enabled</varname> attribute. Using Expression Language (<acronym>EL</acronym>), the <varname>enabled</varname> attribute can point to a bean property to apply a particular attribute value. + </para> + </section> + + <section id="sect-Component_Reference-a4jpoll-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Poll</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.AjaxPoll</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.AjaxPoll</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxPollRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <section id="sect-Component_Reference-Actions-a4jpush"> <title><sgmltag>&lt;a4j:push&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.Push</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.AjaxPush</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.AjaxPush</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxPushRenderer</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;a4j:push&gt;</sgmltag> component periodically performs an Ajax request to the server, simulating "push" functionality. While it is not strictly pushing updates, the request is made to minimal code only, not to the <acronym>JSF</acronym> tree, checking for the presence of new messages in the queue. The request registers <classname>EventListener</classname>, which receives messages about events, but does not poll registered beans. If a message exists, a complete request is performed. This is different from the <sgmltag>&lt;a4j:poll&gt;</sgmltag> component, which performs a full request at every interval. </para> - <para> - The <varname>interval</varname> attribute specifies the time in milliseconds between checking for messages. The default for this value is 1000 ms (1 second). It is possible to set the interval value to <literal>0</literal>, in which case it is constantly checking for new messages. - </para> - <para> - The <varname>timeout</varname> attribute defines the response waiting time in milliseconds. If a response isn't received within the timeout period, the connection is aborted and the next request is sent. By default, the timeout is not set. In combination with the <varname>interval</varname> attribute, checks for the queue state can short polls or long connections. - </para> + + <section id="sect-Component_Reference-a4jpush-Timing_options"> + <title>Timing options</title> + <para> + The <varname>interval</varname> attribute specifies the time in milliseconds between checking for messages. The default for this value is 1000 ms (1 second). It is possible to set the interval value to <literal>0</literal>, in which case it is constantly checking for new messages. + </para> + <para> + The <varname>timeout</varname> attribute defines the response waiting time in milliseconds. If a response isn't received within the timeout period, the connection is aborted and the next request is sent. By default, the timeout is not set. In combination with the <varname>interval</varname> attribute, checks for the queue state can short polls or long connections. + </para> + </section> + + <section id="sect-Component_Reference-a4jpush-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Push</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.AjaxPush</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.AjaxPush</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxPushRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <section id="sect-Component_Reference-Actions-a4jajax"> <title><sgmltag>&lt;a4j:ajax&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.Ajax</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxSupport</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.ajax4jsf.Ajax</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxSupportRenderer</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;a4j:ajax&gt;</sgmltag> component allows Ajax capability to be added to any non-Ajax component. It is placed as a direct child to the component that requires Ajax support. The <sgmltag>&lt;a4j:ajax&gt;</sgmltag> component uses the common attributes listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />. </para> @@ -521,15 +558,34 @@ </note> <example id="exam-Component_Reference-a4jajax-a4jajax_example"> <title><sgmltag>&lt;a4j:ajax&gt;</sgmltag> example</title> - -<programlisting language="XML" role="XML">&lt;h:panelGrid columns="2"&gt; - &lt;h:inputText id="myinput" value="#{userBean.name}"&gt; - &lt;a4j:ajax event="onkeyup" reRender="outtext" /&gt; - &lt;/h:inputText&gt; - &lt;h:outputText id="outtext" value="#{userBean.name}" /&gt; -&lt;/h:panelGrid&gt; -</programlisting> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jajax-a4jajax_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </example> + + <section id="sect-Component_Reference-a4jajax-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Ajax</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxSupport</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.Ajax</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxSupportRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> </chapter> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Common_Ajax_attributes.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Common_Ajax_attributes.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Common_Ajax_attributes.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -18,23 +18,7 @@ </para> <example id="exam-Component_Reference-render-render_example"> <title>render example</title> - -<programlisting language="XML" role="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> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-render-render_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </example> <para> The value of the <varname>render</varname> 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>. @@ -70,21 +54,7 @@ </para> <example id="exam-Component_Reference-limitRender-Rendering_example"> <title>Rendering example</title> - -<programlisting language="XML" 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> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-limitRender-Rendering_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </example> </section> @@ -230,10 +200,7 @@ </para> <example id="exam-Component_Reference-data-Data_reference_example"> <title>Data reference example</title> - -<programlisting language="XML" role="XML"> -&lt;a4j:commandButton value="Update" data="#{userBean.name}" oncomplete="showTheName(data.name)" /&gt; -</programlisting> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-data-Data_reference_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </example> </section> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -59,110 +59,117 @@ <section id="sect-Component_Reference-Containers-a4jinclude"> <title><sgmltag>&lt;a4j:include&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.Include</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.Include</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>javax.faces.Output</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <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> + + <section id="sect-Component_Reference-a4jinclude-Basic_usage"> + <title>Basic usage</title> <para> - The page uses <sgmltag>&lt;a4j:include&gt;</sgmltag> to include the first step of the wizard: + 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> - -<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> - <listitem> + <example id="exam-Component_Reference-a4jinclude-A_wizard_using_a4jinclude"> + <title>A wizard using <sgmltag>&lt;a4j:include&gt;</sgmltag></title> <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.OutputPanel</classname> + The page uses <sgmltag>&lt;a4j:include&gt;</sgmltag> to include the first step of the wizard: </para> - </listitem> - <listitem> + <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> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxOutputPanel</classname> + 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> - </listitem> - <listitem> + <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> - <parameter>component-family</parameter>: <classname>javax.faces.Panel</classname> + The navigation is defined in the <filename>faces-config.xml</filename> configuration file: </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxOutputPanelRenderer</classname> - </para> - </listitem> - </itemizedlist> + <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-a4jinclude-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Include</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.Include</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>javax.faces.Output</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxIncludeRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> + + <section id="sect-Component_Reference-Containers-a4joutputPanel"> + <title><sgmltag>&lt;a4j:outputPanel&gt;</sgmltag></title> <para> The <sgmltag>&lt;a4j:outputPanel&gt;</sgmltag> component is used to group together components in to update them as a whole, rather than having to specify the components individually. </para> - <para> - The <varname>layout</varname> attribute can be used to determine how the component is rendered in <acronym>HTML</acronym>: - </para> - <itemizedlist> - <listitem> - <para> - <code>layout="inline"</code> is the default behavior, which will render the component as a pair of <sgmltag>&lt;span&gt;</sgmltag> tags containing the child components. - </para> - </listitem> - <listitem> - <para> - <code>layout="block"</code> will render the component as a pair of <sgmltag>&lt;div&gt;</sgmltag> tags containing the child components, which will use any defined <sgmltag>&lt;div&gt;</sgmltag> element styles. - </para> - </listitem> - <listitem> - <para> - <code>layout="none"</code> will render the component as a pair of <sgmltag>&lt;span&gt;</sgmltag> tags with an identifier equal to that of a child component. If the child component is rendered then the <sgmltag>&lt;span&gt;</sgmltag> are not included, leaving no markup representing the <sgmltag>&lt;a4j:outputPanel&gt;</sgmltag> in <acronym>HTML</acronym>. - </para> - </listitem> - </itemizedlist> - <para> - Setting <code>ajaxRendered="true"</code> will cause the <sgmltag>&lt;a4j:outputPanel&gt;</sgmltag> to be updated with each Ajax response for the page, even when not listed explicitly by the requesting component. This can in turn be overridden by specific attributes on any requesting components. - </para> + + <section id="sect-Component_Reference-a4joutputPanel-Panel_appearance"> + <title>Panel appearance</title> + <para> + The <varname>layout</varname> attribute can be used to determine how the component is rendered in <acronym>HTML</acronym>: + </para> + <itemizedlist> + <listitem> + <para> + <code>layout="inline"</code> is the default behavior, which will render the component as a pair of <sgmltag>&lt;span&gt;</sgmltag> tags containing the child components. + </para> + </listitem> + <listitem> + <para> + <code>layout="block"</code> will render the component as a pair of <sgmltag>&lt;div&gt;</sgmltag> tags containing the child components, which will use any defined <sgmltag>&lt;div&gt;</sgmltag> element styles. + </para> + </listitem> + <listitem> + <para> + <code>layout="none"</code> will render the component as a pair of <sgmltag>&lt;span&gt;</sgmltag> tags with an identifier equal to that of a child component. If the child component is rendered then the <sgmltag>&lt;span&gt;</sgmltag> are not included, leaving no markup representing the <sgmltag>&lt;a4j:outputPanel&gt;</sgmltag> in <acronym>HTML</acronym>. + </para> + </listitem> + </itemizedlist> + <para> + Setting <code>ajaxRendered="true"</code> will cause the <sgmltag>&lt;a4j:outputPanel&gt;</sgmltag> to be updated with each Ajax response for the page, even when not listed explicitly by the requesting component. This can in turn be overridden by specific attributes on any requesting components. + </para> + </section> + + <section id="sect-Component_Reference-a4joutputPanel-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.OutputPanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxOutputPanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>javax.faces.Panel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxOutputPanelRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <!-- TODO not in M2 --> @@ -225,34 +232,38 @@ <section id="sect-Component_Reference-Containers-a4jregion"> <title><sgmltag>&lt;a4j:region&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.AjaxRegion</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxRegion</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.ajax4jsf.AjaxRegion</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <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 id="sect-Component_Reference-a4jregion-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.AjaxRegion</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxRegion</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.AjaxRegion</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxRegionRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> </chapter> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -14,40 +14,222 @@ This chapter details those components which act as panels and containers to hold groups of other components. </para> - <!-- TODO not in M2 --> - <!-- - <section id="sect-Component_Reference-Panels_and_containers-richmodalPanel"> - <title><sgmltag>&lt;rich:modalPanel&gt;</sgmltag></title> + <!--<rich:accordion>--> + <section id="sect-Component_Reference-Panels_and_containers-richaccordion"> + <title><sgmltag>&lt;rich:accordion&gt;</sgmltag></title> <para> - The <sgmltag>&lt;rich:modalPanel&gt;</sgmltag> component provides a modal panel or window that blocks interaction with the rest of the application while active. It can be easily positioned on the screen, dragged to a new position by the user, and re-sized. + The <sgmltag>&lt;rich:accordion&gt;</sgmltag> is a series of panels stacked on top of each other, each collapsed such that only the header of the panel is showing. When the header of a panel is clicked, it is expanded to show the content of the panel. Clicking on a different header will collapse the previous panel and epand the selected one. Each panel contained in a <sgmltag>&lt;rich:accordion&gt;</sgmltag> component is a <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component. </para> - <important> - <title>Placement</title> + <figure id="figu-Component_Reference-richaccordion-richaccordion"> + <title>A <sgmltag>&lt;rich:accordion&gt;</sgmltag> component containing three <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richaccordion-richaccordion.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:accordion&gt;</sgmltag> component containing three <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components. Only the first panel is expanded. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richaccordion-Basic_usage"> + <title>Basic usage</title> <para> - The <sgmltag>&lt;rich:modalPanel&gt;</sgmltag> component should always be placed outside the original <sgmltag>&lt;h:form&gt;</sgmltag>, and must include its own <sgmltag>&lt;h:form&gt;</sgmltag> if performing submissions. + The <sgmltag>&lt;rich:accordion&gt;</sgmltag> component requires no attributes for basic usage. The component can contain any number of <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components as children. The headers of the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components control the expanding and collapsing when clicked. Only a single <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> can be displayed at a time. Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richaccordionItem" /> for details on the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component. </para> - </important> + </section> + + <section id="sect-Component_Reference-richaccordion-Switching_panels"> + <title>Switching panels</title> + <para> + The switching mode for performing submissions is determined by the <code>switchType</code> attribute, which can have one of the following three values: + </para> + <variablelist> + <varlistentry> + <term><literal>server</literal></term> + <listitem> + <para> + The default setting. Activation of a <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component causes the parent <sgmltag>&lt;rich:accordion&gt;</sgmltag> component to perform a common submission, completely re-rendering the page. Only one panel at a time is uploaded to the client side. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>ajax</literal></term> + <listitem> + <para> + Activation of a <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component causes the parent <sgmltag>&lt;rich:accordion&gt;</sgmltag> component to perform an Ajax form submission, and the content of the panel is rendered. Only one panel at a time is uploaded to the client side. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>client</literal></term> + <listitem> + <para> + Activation of a <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component causes the parent <sgmltag>&lt;rich:accordion&gt;</sgmltag> component to update on the client side. JavaScript changes the styles such that one panel component becomes hidden while the other is shown. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <!-- TODO + <section id="sect-Component_Reference-richaccordion-Controlling_panel_size"> + <title>Controlling panel size</title> + <para> + Unlike the <sgmltag>&lt;rich:panel&gt;</sgmltag> component, the size of the <sgmltag>&lt;rich:accordion&gt;</sgmltag> can be specified using <varname>width</varname> and <varname>height</varname> attributes. If unspecified, these values default to 100%. + </para> + </section> + --> + + <section id="sect-Component_Reference-richaccordion-richaccordion_client-side_events"> + <title><sgmltag>&lt;rich:accordion&gt;</sgmltag> client-side events</title> + <para> + In addition to the standard Ajax events and HTML events, the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component uses the client-side events common to all switchable panels: + </para> + <itemizedlist> + <listitem> + <para> + The <varname>onitemchange</varname> event points to the function to perform when the switchable item is changed. + </para> + </listitem> + <listitem> + <para> + The <varname>onbeforeitemchange</varname> event points to the function to perform when before the switchable item is changed. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richaccordion-richaccordion_server-side_events"> + <title><sgmltag>&lt;rich:accordion&gt;</sgmltag> server-side events</title> + <para> + The <sgmltag>&lt;rich:accordion&gt;</sgmltag> component uses the server-side events common to all switchable panels: + </para> + <itemizedlist> + <listitem> + <para> + The <varname>ItemChangeEvent</varname> event occurs on the server side when an item is changed through Ajax using the <literal>server</literal> mode. It can be processed using the <varname>ItemChangeListener</varname> attribute. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richaccordion-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.accordion</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAccordion</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.accordion</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.accordionRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.accordionTag</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> + + <!--<rich:accordionItem>--> + <section id="sect-Component_Reference-Panels_and_containers-richaccordionItem"> + <title><sgmltag>&lt;rich:accordionItem&gt;</sgmltag></title> <para> - By default, the modal panel can be both re-sized and re-positioned by the user. The minimum possible size for the panel can be set with the These abilities can be deactivated by setting <code>resizable</code> or <code>movable</code> to <literal>false</literal> as necessary. The state of the modal panel, including size and position on screen, can be maintained and restored after submitting and reloading by setting <code>keepVisualState="true"</code>. + The <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component is a panel for use with the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component. Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richaccordion" /> for details on the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component. </para> - <para> - If <code>showWhenRendered="true"</code> then the modal panel will display when the page is first loaded. - </para> - <example id="exam-Component_Reference-richmodalPanel-richmodalPanel_example"> - <title><sgmltag>&lt;rich:modalPanel&gt;</sgmltag> example</title> - -<programlisting language="XML" role="XML"> -&lt;a onclick="Richfaces.showModalPanel('pnl');" href="#"&gt;Show ModalPanel&lt;/a&gt; -&lt;a4j:form&gt; - &lt;rich:modalPanel id="pnl" &gt; - &lt;a onclick="Richfaces.hideModalPanel('pnl');" href="#"&gt;Hide ModalPanel&lt;/a&gt; - &lt;/rich:modalPanel&gt; -&lt;/a4j:form&gt; -</programlisting> - </example> + <figure id="figu-Component_Reference-richaccordionItem-richaccordion"> + <title>A <sgmltag>&lt;rich:accordion&gt;</sgmltag> component containing three <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richaccordion-richaccordion.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:accordion&gt;</sgmltag> component containing three <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components. Only the first panel is expanded. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richaccordionItem-Basic_usage"> + <title>Basic usage</title> + <para> + Basic usage of the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component requires the <varname>label</varname> attribute, which provides the text on the panel header. The panel header is all that is visible when the accordion item is collapsed. + </para> + <para> + Alternatively the <literal>header</literal> facet could be used in place of the <varname>label</varname> attribute. This would allow for additional styles and custom content to be applied to the tab. + </para> + </section> + + <section id="sect-Component_Reference-richaccordionItem-richaccordionItem_client-side_events"> + <title><sgmltag>&lt;rich:accordionItem&gt;</sgmltag> client-side events</title> + <para> + In addition to the standard HTML events, the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component uses the client-side events common to all switchable panel items: + </para> + <itemizedlist> + <listitem> + <para> + The <varname>onenter</varname> event points to the function to perform when the mouse enters the panel. + </para> + </listitem> + <listitem> + <para> + The <varname>onleave</varname> attribute points to the function to perform when the mouse leaves the panel. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richaccordionItem-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.accordionItem</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAccordionItem</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.accordionItem</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.accordionItemRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.accordionItemTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - --> + <!--<rich:panel>--> <section id="sect-Component_Reference-Panels_and_containers-richpanel"> <title><sgmltag>&lt;rich:panel&gt;</sgmltag></title> <para> @@ -81,25 +263,25 @@ <title>Adding a header</title> <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richpanel-Adding_a_header-0.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richpanel-Adding_a_header-1.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + Both the examples render an identical panel. + </para> + <blockquote> + <figure id="figu-Component_Reference-richpanel-Adding_a_header"> + <title>Adding a header</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richpanel-Adding_a_header.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A panel with a header that reads <phrase>"This is the panel header"</phrase> and content that reads <phrase>"This is the panel content"</phrase>. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> </example> - <para> - Both the examples render an identical panel. - </para> - <blockquote> - <figure id="figu-Component_Reference-richpanel-Adding_a_header"> - <title>Adding a header</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richpanel-Adding_a_header.png" format="PNG" /> - </imageobject> - <textobject> - <para> - A panel with a header that reads <phrase>"This is the panel header"</phrase> and content that reads <phrase>"This is the panel content"</phrase>. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> </section> <section id="sect-Component_Reference-richpanel-Reference_data"> @@ -134,65 +316,152 @@ </section> </section> - <section id="sect-Component_Reference-Panels_and_containers-richpanelBar"> - <title><sgmltag>&lt;rich:panelBar&gt;</sgmltag></title> + <!--<rich:popupPanel>--> + <section id="sect-Component_Reference-Panels_and_containers-richpopupPanel"> + <title><sgmltag>&lt;rich:popupPanel&gt;</sgmltag></title> <para> - The <sgmltag>&lt;rich:panelBar&gt;</sgmltag> is a series of panels stacked on top of each other, each collapsed such that only the header of the panel is showing. When the header of a panel is clicked, it is expanded to show the content of the panel. Clicking on a different header will collapse the previous panel and epand the selected one. Similar controls are sometimes known as "accordion" controls. Each panel contained in a <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component is a <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> component. + The <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component provides a pop-up panel or window that appears in front of the rest of the application. The <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component functions either as a modal window which blocks interaction with the rest of the application while active, or as a non-modal window. It can be positioned on the screen, dragged to a new position by the user, and re-sized. </para> - <figure id="figu-Component_Reference-richpanelBar-richpanelBar"> - <title><sgmltag>&lt;rich:panelBar&gt;</sgmltag></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richpanelBar-richpanelBar.png" format="PNG" /> - </imageobject> - <textobject> + + <section id="sect-Component_Reference-richpopupPanel-Basic_usage"> + <title>Basic usage</title> + <para> + The <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> does not require any compulsory attributes, though certain use cases require different attributes. + </para> + </section> + + <section id="sect-Component_Reference-richpopupPanel-Showing_and_hiding_the_pop-up"> + <title>Showing and hiding the pop-up</title> + <para> + If <code>show="true"</code> then the pop-up panel will display when the page is first loaded. + </para> + <para> + The <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component can be shown and hidden manually using the <code>show()</code> and <code>hide()</code> methods from the JavaScript API. These can be implemented using two different approaches: + </para> + <itemizedlist> + <listitem> <para> - A <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component displaying details on different cameras. Only the first panel is expanded. + Using the <sgmltag>&lt;rich:componentControl&gt;</sgmltag> component. For details on the component, refer to <xref linkend="sect-Component_Reference-Actions-richcomponentControl" />. </para> - </textobject> - </mediaobject> - </figure> + </listitem> + <listitem> + <para> + Using the <code>rich:component</code> function. For details on the function, refer to <xref linkend="sect-Component_Reference-Functions-richcomponent" />. + </para> + </listitem> + </itemizedlist> + <para> + For explicit referencing when using the functions, the component can be given an <varname>id</varname> identifier. The component can, however, be referenced using other means, such as through a selector. + </para> + <para> + <xref linkend="exam-Component_Reference-richpopupPanel-richpopupPanel_example" /> demonstrates basic use of both the <sgmltag>&lt;rich:componentControl&gt;</sgmltag> component and the <code>rich:component</code> function to show and hide the <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component. + </para> + <example id="exam-Component_Reference-richpopupPanel-richpopupPanel_example"> + <title><sgmltag>&lt;rich:popupPanel&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richpopupPanel-richpopupPanel_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + <important> + <title>Placement</title> + <para> + The <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component should usually be placed outside the original form, and include its own form if performing submissions. An exception to this is when using the <varname>domElementAttachment</varname> attribute, as described in <xref linkend="sect-Component_Reference-richpopupPanel-Size_and_positioning" />. + </para> + </important> + </section> - <section id="sect-Component_Reference-richpanelBar-Basic_usage"> - <title>Basic usage</title> + <section id="sect-Component_Reference-richpopupPanel-Modal_and_non-modal_panels"> + <title>Modal and non-modal panels</title> <para> - The <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component requires no attributes for basic usage. The component can contain any number of <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> components as children. The headers of the <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> components control the expanding and collapsing when clicked. Only a single <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> can be displayed at a time. + By default, the <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> appears as a modal window that blocks interaction with the other objects on the page. To implement a non-modal window instead, set <code><varname>modal</varname>="false"</code>. This will allow interaction with other objects outside the pop-up panel. </para> </section> - <section id="sect-Component_Reference-richpanelBar-Controlling_panel_size"> - <title>Controlling panel size</title> + <section id="sect-Component_Reference-richpopupPanel-Size_and_positioning"> + <title>Size and positioning</title> <para> - Unlike the <sgmltag>&lt;rich:panel&gt;</sgmltag> component, the size of the <sgmltag>&lt;rich:panelBar&gt;</sgmltag> can be specified using <varname>width</varname> and <varname>height</varname> attributes. If unspecified, these values default to 100%. + The pop-up panel can be both re-sized and re-positioned by the user. The minimum possible size for the panel can be set with the <varname>minWith</varname> and <varname>minHeight</varname> attributes. These abilities can be deactivated by setting <code>resizable</code> or <code>movable</code> to <literal>false</literal> as necessary. + <!-- + The state of the modal panel, including size and position on screen, can be maintained and restored after submitting and reloading by setting <code>keepVisualState="true"</code>. + --> </para> + <para> + The pop-up panel can be automatically sized when it is shown if the <varname>autosized</varname> attribute is set to <literal>true</literal>. + </para> + <para> + The <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component is usually rendered in front of any other objects on the page. This is achieved by attaching the component to the <sgmltag>&lt;body&gt;</sgmltag> element of the page, and setting a very high <emphasis>"z-index"</emphasis> (the stack order of the object). This approach is taken because relatively-positioned elements could still overlap the pop-up panel if they exist at higher levels of the <acronym>DOM</acronym> hierarchy, even if their z-index is less than the <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component. However, to avoid form limitation of the pop-up panel on pages where no such elements exist, the <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component can be reattached to its original <acronym>DOM</acronym> element by setting <varname>domElementAttachment</varname> to either <literal>parent</literal> or <literal>form</literal>. + </para> + <para> + Embedded objects inserted into the <acronym>HTML</acronym> with the <sgmltag>&lt;embed&gt;</sgmltag> tag will typically be rendered in front of a <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component. The <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component can be forcibly rendered in front of these objects by setting <code><varname>overlapEmbedObjects</varname>="true"</code>. + </para> + <note> + <title>Using <varname>overlapEmbedObjects</varname></title> + <para> + Due to the additional script processing required when using the <varname>overlapEmbedObjects</varname> attribute, applications can suffer from decreased performance. As such, <varname>overlapEmbedObjects</varname> should only be set to <literal>true</literal> when <sgmltag>&lt;embed&gt;</sgmltag> tags are being used. Do not set it to <literal>true</literal> for applications that do not require it. + </para> + </note> </section> - <section id="sect-Component_Reference-richpanelBar-Reference_data"> + <section id="sect-Component_Reference-richpopupPanel-Contents_of_the_pop-up"> + <title>Contents of the pop-up</title> + <para> + The <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component can contain any other rich component just like a normal panel. + </para> + <para> + Contents of the <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component which are positioned relatively may be trimmed if they extend beyond the borders of the pop-up panel. For certain in-line controls this behavior may be preferable, but for other dynamic controls it could be undesirable. If the <varname>trimOverlayedElements</varname> attribute is set to <literal>false</literal> then child components will not be trimmed if they extend beyond the borders of the pop-up panel. + </para> + </section> + + <section id="sect-Component_Reference-richpopupPanel-Header_and_controls"> + <title>Header and controls</title> + <para> + A panel header and associated controls can be added to the <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component through the use of facets. The <literal>header</literal> facet displays a title for the panel, and the <literal>controls</literal> facet can be customized to allow window controls such as a button for closing the pop-up. <xref linkend="exam-Component_Reference-richpopupPanel-Header_and_controls" /> demonstrates the use of the facets. + </para> + <example id="exam-Component_Reference-richpopupPanel-Header_and_controls"> + <title>Header and controls</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richpopupPanel-Header_and_controls.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-richpopupPanel-Header_and_controls"> + <title>Header and controls</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richpopupPanel-Header_and_controls.png" format="PNG" /> + </imageobject> + <textobject> + <para> + The <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component, rendered with a title header and a button control for closing the pop-up. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-richpopupPanel-Reference_data"> <title>Reference data</title> <itemizedlist> <listitem> <para> - <parameter>component-type</parameter>: <classname>org.richfaces.panelBar</classname> + <parameter>component-type</parameter>: <classname>org.richfaces.popupPanel</classname> </para> </listitem> <listitem> <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlPanelBar</classname> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlpopupPanel</classname> </para> </listitem> <listitem> <para> - <parameter>component-family</parameter>: <classname>org.richfaces.panelBar</classname> + <parameter>component-family</parameter>: <classname>org.richfaces.popupPanel</classname> </para> </listitem> <listitem> <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.panelBarRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.richfaces.popupPanelRenderer</classname> </para> </listitem> <listitem> <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.panelBarTag</classname> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.popupPanelTag</classname> </para> </listitem> </itemizedlist> @@ -201,20 +470,13 @@ <!-- TODO not in M2 --> <!-- - <section id="sect-Component_Reference-Panels_and_containers-richpanelBarItem"> - <title><sgmltag>&lt;rich:panelBarItem&gt;</sgmltag></title> - <para> - The <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> component is a panel for use with the <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component. - </para> - </section> - <section id="sect-Component_Reference-Panels_and_containers-richsimpleTogglePanel"> <title><sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag></title> <para> The <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> component is a collapsible panel that shows or hides content when the header bar is activated. It is a simplified version of <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component. </para> <para> - Basic usage requires only the <code>label</code> attribute to be specified, which provides the title for the header element. + Basic usage requires only the <varname>label</varname> attribute to be specified, which provides the title for the header element. </para> <para> The switching mode for performing submissions is determined by the <code>switchType</code> attribute, which can have one of the following three values: @@ -245,125 +507,457 @@ </section> --> - <!-- TODO not in M2 --> - <!-- + <!--<rich:tab>--> <section id="sect-Component_Reference-Panels_and_containers-richtab"> <title><sgmltag>&lt;rich:tab&gt;</sgmltag></title> <para> - The <sgmltag>&lt;rich:tab&gt;</sgmltag> component represents an individual tab inside a <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component, including the tab's content. Clicking on the tab header will bring its corresponding content to the front of other tabs. + The <sgmltag>&lt;rich:tab&gt;</sgmltag> component represents an individual tab inside a <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component, including the tab's content. Clicking on the tab header will bring its corresponding content to the front of other tabs. Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richtabPanel" /> for details on the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component. </para> - <para> - Basic usage of the <sgmltag>&lt;rich:tab&gt;</sgmltag> component requires the <code>label</code> attribute, which provides the text on the tab header. The content of the tab is then detailed inside the <sgmltag>&lt;rich:tab&gt;</sgmltag> tags. - </para> - <para> - An individual tab can be disabled by setting <code>disabled="true"</code>. Disabled tabs cannot be activated or switched to. - </para> - <para> - The switching mode for performing submissions can be inherited from <code>switchMode</code> attribute of the parent <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component, or set individually for each <sgmltag>&lt;rich:tab&gt;</sgmltag> component. Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richtabPanel" /> for details on the <code>switchMode</code> attribute. - </para> - <para> - There are two event handlers that are unique to the <sgmltag>&lt;rich:tab&gt;</sgmltag> component. The <code>ontabenter</code> attribute points to the function to perform when the mouse enters the tab, while the <code>ontableave</code> attribute points to the function to perform when the mouse leaves the tab. - </para> + + <figure id="figu-Component_Reference-richtab-richtabPanel_component"> + <title>A <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component containing three <sgmltag>&lt;rich:tab&gt;</sgmltag> components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richtabPanel-richtabPanel_component.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component containing three <sgmltag>&lt;rich:tab&gt;</sgmltag> components. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richtab-Basic_usage"> + <title>Basic usage</title> + <para> + Basic usage of the <sgmltag>&lt;rich:tab&gt;</sgmltag> component requires the <varname>label</varname> attribute, which provides the text on the tab header. The content of the tab is then detailed inside the <sgmltag>&lt;rich:tab&gt;</sgmltag> tags. + </para> + <para> + Alternatively the <literal>header</literal> facet could be used in place of the <varname>label</varname> attribute. This would allow for additional styles and custom content to be applied to the tab. + </para> + </section> + + <section id="sect-Component_Reference-richtab-Switching_tabs"> + <title>Switching tabs</title> + <para> + The switching mode for performing submissions can be inherited from the <varname>switchMode</varname> attribute of the parent <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component, or set individually for each <sgmltag>&lt;rich:tab&gt;</sgmltag> component. Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richtabPanel" /> for details on the <varname>switchMode</varname> attribute. + </para> + <para> + An individual tab can be disabled by setting <code><varname>disabled</varname>="true"</code>. Disabled tabs cannot be activated or switched to. + </para> + </section> + + <section id="sect-Component_Reference-richtab-richtab_client-side_events"> + <title><sgmltag>&lt;rich:tab&gt;</sgmltag> client-side events</title> + <para> + In addition to the standard HTML events, the <sgmltag>&lt;rich:tab&gt;</sgmltag> component uses the client-side events common to all switchable panel items: + </para> + <itemizedlist> + <listitem> + <para> + The <varname>onenter</varname> event points to the function to perform when the mouse enters the tab. + </para> + </listitem> + <listitem> + <para> + The <varname>onleave</varname> attribute points to the function to perform when the mouse leaves the tab. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richtab-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.tab</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlTab</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.tab</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.tabRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.tabTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - --> + <!--<rich:tabPanel>--> <section id="sect-Component_Reference-Panels_and_containers-richtabPanel"> <title><sgmltag>&lt;rich:tabPanel&gt;</sgmltag></title> <para> - The <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component provides a set of tabbed panels for displaying one panel of content at a time. The tabs can be highly customized and themed. + The <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component provides a set of tabbed panels for displaying one panel of content at a time. The tabs can be highly customized and themed. Each tab within a <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> container is a <sgmltag>&lt;rich:tab&gt;</sgmltag> component. Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richtab" /> for further details on the <sgmltag>&lt;rich:tab&gt;</sgmltag> component. </para> + <figure id="figu-Component_Reference-richtabPanel-richtabPanel_component"> + <title>A <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component containing three <sgmltag>&lt;rich:tab&gt;</sgmltag> components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richtabPanel-richtabPanel_component.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component containing three <sgmltag>&lt;rich:tab&gt;</sgmltag> components. + </para> + </textobject> + </mediaobject> + </figure> <note> <title>Form elements required</title> <para> - All <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> components should be wrapped in a form element so that content is correctly submitted. + All <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> components should be wrapped in a form element so that the contents of the tab are processed correctly during a tab change in either <literal>ajax</literal> or <literal>server</literal> mode. </para> + <para> + Alternatively, the contents of a <sgmltag>&lt;rich:tab&gt;</sgmltag> component within the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component could be wrapped in a form element, such that they will be processed using the inner submitting component only. In this case, the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component will automatically add form tags around the tab's contents, and the contents will not be processed during switching. + </para> </note> - <section id="sect-Component_Reference-richtabPanel-Basic_usage"> - <title>Basic usage</title> + + <section id="sect-Component_Reference-richtabPanel-Switching_tabs"> + <title>Switching panels</title> <para> The switching mode for performing submissions is determined by the <code>switchType</code> attribute, which can have one of the following three values: </para> + <variablelist> + <varlistentry> + <term><literal>server</literal></term> + <listitem> + <para> + The default setting. Activation of a <sgmltag>&lt;rich:tab&gt;</sgmltag> component causes the parent <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to perform a common submission, completely re-rendering the page. Only one tab at a time is uploaded to the client side. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>ajax</literal></term> + <listitem> + <para> + Activation of a <sgmltag>&lt;rich:tab&gt;</sgmltag> component causes the parent <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to perform an Ajax form submission, and the content of the tab is rendered. Only one tab at a time is uploaded to the client side. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>client</literal></term> + <listitem> + <para> + Activation of a <sgmltag>&lt;rich:tab&gt;</sgmltag> component causes the parent <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to update on the client side. JavaScript changes the styles such that one tab becomes hidden while the other is shown. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + The <code>activeItem</code> attribute holds the active tab name. + </para> + </section> + + <section id="sect-Component_Reference-richtabPanel-Tab_position_and_alignment"> + <title>Tab position and alignment</title> + <para> + The tab headers, used for switching between the tabs, can be positioned along any edge of the panel by using the <varname>headerPosition</varname> attribute. The possible values for the <varname>headerPosition</varname> attribute are as follows: + </para> + <variablelist> + <varlistentry> + <term><literal>top</literal></term> + <listitem> + <para> + The tab headers are positioned along the top of the panel. This is the default position. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>left</literal></term> + <listitem> + <para> + The tab headers are positioned along the left edge of the panel. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>right</literal></term> + <listitem> + <para> + The tab headers are positioned along the right edge of the panel. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>bottom</literal></term> + <listitem> + <para> + The tab headers are positioned along the bottom of the panel. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + The tab headers themselves can be aligned using the <code>headerAlignment</code> attribute. The possible values for the <varname>headerAlignment</varname> attribute are as follows: + </para> + <variablelist> + <varlistentry> + <term><literal>top</literal></term> + <listitem> + <para> + The tab headers are aligned to the top of the tab header position. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>left</literal></term> + <listitem> + <para> + The tab headers are aligned to the left of the tab header position. This is the default alignment. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>right</literal></term> + <listitem> + <para> + The tab headers are aligned to the right of the tab header position. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>bottom</literal></term> + <listitem> + <para> + The tab headers are aligned to the bottom of the tab header position. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>center</literal></term> + <listitem> + <para> + The tab headers are aligned in the center of the tab header position. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section id="sect-Component_Reference-richtabPanel-richtabPanel_client-side_events"> + <title><sgmltag>&lt;rich:tabPanel&gt;</sgmltag> client-side events</title> + <para> + In addition to the standard Ajax events and HTML events, the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component uses the client-side events common to all switchable panels: + </para> <itemizedlist> <listitem> <para> - <literal>server</literal>, the default setting, which causes the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to perform a common submission, completely re-rendering the page. Only one panel at a time is uploaded to the client side. + The <varname>onitemchange</varname> event points to the function to perform when the switchable item is changed. </para> </listitem> <listitem> <para> - <literal>ajax</literal>, which causes the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to perform an Ajax form submission, and the content of the panel is rendered. Only one panel at a time is uploaded to the client side. + The <varname>onbeforeitemchange</varname> event points to the function to perform when before the switchable item is changed. </para> </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richtabPanel-richtabPanel_server-side_events"> + <title><sgmltag>&lt;rich:tabPanel&gt;</sgmltag> server-side events</title> + <para> + The <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component uses the server-side events common to all switchable panels: + </para> + <itemizedlist> <listitem> <para> - <literal>client</literal>, which causes <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> components to update on the client side, re-rendering themselves and any additional components listed with the <code>render</code> attribute. + The <varname>ItemChangeEvent</varname> event occurs on the server side when an item is changed through Ajax using the <literal>server</literal> mode. It can be processed using the <varname>ItemChangeListener</varname> attribute. </para> </listitem> </itemizedlist> + </section> + + <section id="sect-Component_Reference-richtabPanel-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.tabPanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlTabPanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.tabPanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.tabPanelRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.tabPanelTag</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> + + <!--<rich:toggleControl>--> + <section id="sect-Component_Reference-Panels_and_containers-richtoggleControl"> + <title><sgmltag>&lt;rich:toggleControl&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> behavior can be attached to any interface component. It works with a <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component to switch between different <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> components. + </para> + <para> + Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richtogglePanel" /> and <xref linkend="sect-Component_Reference-Panels_and_containers-richtogglePanelItem" /> for details on how to use the components together. + </para> + + <section id="sect-Component_Reference-richtoggleControl-Basic_usage"> + <title>Basic usage</title> <para> - The <code>selectedTab</code> attribute holds the active tab name. + The <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> can be used to switch through <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> components in a <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> container. If the <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> component is positioned inside a <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component, no attributes need to be defined, as the control is assumed to switch through the <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> components of its parent. </para> + <para> + A <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> component can be located outside the <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component it needs to switch. Where this is the case, the <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> is identified using the <varname>activePanel</varname> attribute. the Cycling through components requires the <varname>for</varname> attribute, which points to the <varname>id</varname> identifier of the <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> that it controls. + </para> </section> - <section id="sect-Component_Reference-richtabPanel-Tab_alignment"> - <title>Tab alignment</title> + <section id="sect-Component_Reference-richtoggleControl-Specifying_the_next_state"> + <title>Specifying the next state</title> <para> - The tabs themselves can be aligned using the <code>headerAlignment</code> attribute. The attribute can be set to <code>left</code>, <code>center</code>, or <code>right</code>, aligning the header tabs to the left, center, or right of the top edge of the panel respectively. If no alignment is specified, left-alignment is the default behavior. + The <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> component will cycle through <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> components in the order they are defined within the view. However, the next item to switch to can be explicitly defined by including a <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> component within a <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> and using the <varname>targetItem</varname> attribute. The <varname>targetItem</varname> attribute points to the <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> to switch to when the state is next changed. <xref linkend="exam-Component_Reference-richtoggleControl-richtoggleControl_example" /> demonstrates how to specify the next switchable state in this way. </para> + <example id="exam-Component_Reference-richtoggleControl-richtoggleControl_example"> + <title><sgmltag>&lt;rich:toggleControl&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richtoggleControl-richtoggleControl_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> </section> - <section id="sect-Component_Reference-richtabPanel-Reference_data"> + <section id="sect-Component_Reference-richtoggleControl-Reference_data"> <title>Reference data</title> <itemizedlist> <listitem> <para> - <parameter>component-type</parameter>: <classname>org.richfaces.tabPanel</classname> + <parameter>component-type</parameter>: <classname>org.richfaces.ToggleControl</classname> </para> </listitem> <listitem> <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmltabPanel</classname> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlToggleControl</classname> </para> </listitem> <listitem> <para> - <parameter>component-family</parameter>: <classname>org.richfaces.tabPanel</classname> + <parameter>component-family</parameter>: <classname>org.richfaces.ToggleControl</classname> </para> </listitem> <listitem> <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.tabPanelRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.richfaces.ToggleControlRenderer</classname> </para> </listitem> <listitem> <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.tabPanelTag</classname> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ToggleControlTag</classname> </para> </listitem> </itemizedlist> </section> </section> - + + <!--<rich:togglePanel>--> <section id="sect-Component_Reference-Panels_and_containers-richtogglePanel"> <title><sgmltag>&lt;rich:togglePanel&gt;</sgmltag></title> <para> - The <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component is a wrapper component with named facets. Each facet is displayed after activating a corresponding <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> component. + The <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component is a wrapper for multiple <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> components. Each child component is displayed after being activated with the <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> behavior. </para> + <para> + Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richtoggleControl" /> and <xref linkend="sect-Component_Reference-Panels_and_containers-richtogglePanel" /> for details on how to use the components together. + </para> + <para> + The <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component is used as a base for the other switchable components, the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component and the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component. It provides an abstract switchable component without any associated markup. As such, the <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component could be customized to provide a switchable component when neither an accordion component or a tab panel component is appropriate. + </para> <section id="sect-Component_Reference-richtogglePanel-Basic_usage"> <title>Basic usage</title> <para> - The initial state of the component can be configured using the <code>initialState</code> attribute, which points to a facet name to display. Alternatively, setting <code>initialState="empty"</code>, the initial state will be blank until the user selects an option. + The initial state of the component can be configured using the <varname>activeItem</varname> attribute, which points to a child component to display. Alternatively, if no <varname>activeItem</varname> attribute is defined, the initial state will be blank until the user activates a child component using the <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> component. </para> <para> - The order in which the facets are shown can be defined using the <code>statusOrder</code> attribute, listing the facet names separated by commas, as shown in <xref linkend="exam-Component_Reference-richtogglePanel-State_order_example" />. + The child components are shown in the order in which they are defined in the view. </para> - <example id="exam-Component_Reference-richtogglePanel-State_order_example"> - <title>State order example</title> - <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richtogglePanel-State_order_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </example> </section> + <section id="sect-Component_Reference-richtogglePanel-Toggling_between_panels"> + <title>Toggling between components</title> + <para> + The switching mode for performing submissions is determined by the <code>switchType</code> attribute, which can have one of the following three values: + </para> + <itemizedlist> + <listitem> + <para> + <literal>server</literal>, the default setting, which causes the child components to perform a common submission, completely re-rendering the page. Only one panel at a time is uploaded to the client side. + </para> + </listitem> + <listitem> + <para> + <literal>ajax</literal>, which causes the child components to perform an Ajax form submission, and the content of the panel is rendered. Only one panel at a time is uploaded to the client side. + </para> + </listitem> + <listitem> + <para> + <literal>client</literal>, which causes the child components to update on the client side. JavaScript changes the styles such that one component becomes hidden while the other is shown. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richtogglePanel-Switching_panels"> + <title>Switching panels</title> + <para> + The switching mode for performing submissions is determined by the <code>switchType</code> attribute, which can have one of the following three values: + </para> + <variablelist> + <varlistentry> + <term><literal>server</literal></term> + <listitem> + <para> + The default setting. Activation of a child component causes the parent <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component to perform a common submission, completely re-rendering the page. Only one child at a time is uploaded to the client side. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>ajax</literal></term> + <listitem> + <para> + Activation of a child component causes the parent <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component to perform an Ajax form submission, and the content of the child is rendered. Only one child at a time is uploaded to the client side. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>client</literal></term> + <listitem> + <para> + Activation of a child component causes the parent <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component to update on the client side. JavaScript changes the styles such that one child component becomes hidden while the other is shown. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + <section id="sect-Component_Reference-richtogglePanel-Reference_data"> <title>Reference data</title> <itemizedlist> @@ -396,49 +990,47 @@ </section> </section> - <!-- TODO not in M2 --> - <!-- - <section id="sect-Component_Reference-Panels_and_containers-richtoggleControl"> - <title><sgmltag>&lt;rich:toggleControl&gt;</sgmltag></title> + <!--<rich:togglePanelItem>--> + <section id="sect-Component_Reference-Panels_and_containers-richtogglePanelItem"> + <title><sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag></title> <para> - The <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> component works with a <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component to switch between panel states. It can be located either inside or outside the <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component, and can be used to switch to a specific state or cycle through a set of states. + The <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> component is a switchable panel for use with the <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component. Switching between <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> components is handled by the <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> behavior. </para> <para> - Basic usage for the <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> requires the <code>for</code> attribute, which points to the <code>id</code> attribute of the <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> that it controls. The <code>value</code> attribute specifies the label of the toggle button. + Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richtoggleControl" /> and <xref linkend="sect-Component_Reference-Panels_and_containers-richtogglePanel" /> for details on how to use the components together. </para> - <para> - The <code>switchToState</code> attribute can be used to explicitly set a target panel for the toggle to activate. If no <code>switchToState</code> attribute is defined, the toggle will switch to the next panel listed in the <code>switchOrder</code> attribute of the <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> component. <xref linkend="exam-Component_Reference-richtoggleControl-Switching_panel_states" /> shows the use of the <code>switchToState</code> attribute. - </para> - <example id="exam-Component_Reference-richtoggleControl-Switching_panel_states"> - <title>Switching panel states</title> - -<programlisting language="XML" role="XML"> -&lt;rich:togglePanel id="panel" initialState="empty" switchType="client"&gt; - &lt;f:facet name="first"&gt; - &lt;h:panelGroup&gt; - &lt;rich:toggleControl for="helloForm:panel" value="Empty" switchToState="empty"/&gt; - &lt;rich:toggleControl for="helloForm:panel" value=" Second" switchToState="second"/&gt; - &lt;!-Some content-&gt; - &lt;/h:panelGroup&gt; - &lt;/f:facet&gt; - &lt;f:facet name="second"&gt; - &lt;h:panelGroup&gt; - &lt;rich:toggleControl for="helloForm:panel" value="Empty" switchToState="empty"/&gt; - &lt;rich:toggleControl for="helloForm:panel" value=" first" switchToState="first"/&gt; - &lt;!-Some content-&gt; - &lt;/h:panelGroup&gt; - &lt;/f:facet&gt; - &lt;f:facet name="empty"&gt; - &lt;h:panelGroup&gt; - &lt;rich:toggleControl for="helloForm:panel" value="first" switchToState="first"/&gt; - &lt;rich:toggleControl for="helloForm:panel" value=" second" switchToState="second"/&gt; - &lt;/h:panelGroup&gt; - &lt;/f:facet&gt; -&lt;/rich:togglePanel&gt; -</programlisting> - </example> + + <section id="sect-Component_Reference-richtogglePanelItem-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.TogglePanelItem</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlTogglePanelItem</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.TogglePanelItem</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.TogglePanelItemRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.TogglePanelItemTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - --> - + </chapter> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Processing_management.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Processing_management.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Processing_management.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -8,227 +8,249 @@ </para> <section id="sect-Component_Reference-Processing_management-a4jqueue"> <title><sgmltag>&lt;a4j:queue&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.QueueRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlQueue</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.ajax4jsf.Queue</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.ajax4jsf.taglib.html.jsp.QueueTag</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;a4j:queue&gt;</sgmltag> component manages a queue of Ajax requests to control message processing. </para> - <para> - The queue can be disabled by setting the <varname>disabled</varname> attribute to <literal>true</literal>. The <varname>size</varname> attribute specifies the number of requests that can be stored in the queue at a time; smaller queue sizes help prevent server overloads. When the queue's size is exceeded, the <varname>sizeExceededBehavior</varname> determines the way in which the queue handles the requests: - </para> - <itemizedlist> - <listitem> - <para> - <literal>dropNext</literal> drops the next request currently in the queue. - </para> - </listitem> - <listitem> - <para> - <literal>dropNew</literal> drops the incoming request. - </para> - </listitem> - <listitem> - <para> - <literal>fireNext</literal> immediately sends the next request currently in the queue. - </para> - </listitem> - <listitem> - <para> - <literal>fireNew</literal> immediately sends the incoming request. - </para> - </listitem> - </itemizedlist> - <para> - The <sgmltag>&lt;a4j:queue&gt;</sgmltag> component features several events relating to queuing actions: - </para> - <itemizedlist> - <listitem> - <para> - The <varname>oncomplete</varname> event attribute is fired after a request is completed. The request object is passed as a parameter to the event handler, so the queue is accessible using <code>request.queue</code> and the element which was the source of the request is accessible using <code>this</code>. - </para> - </listitem> - <listitem> - <para> - The <varname>onrequestqueue</varname> event attribute is fired after a new request has been added to the queue. - </para> - </listitem> - <listitem> - <para> - The <varname>onrequestdequeue</varname> event attribute is fired after a request has been removed from the queue. - </para> - </listitem> - <listitem> - <para> - The <varname>onsizeexceeded</varname> event attribute is fired when the queue has been exceeded. - </para> - </listitem> - <listitem> - <para> - The <varname>onsubmit</varname> event attribute is fired before the request is sent. - </para> - </listitem> - <listitem> - <para> - The <varname>onsuccess</varname> event attribute is fired after a successful request bu before the <acronym>DOM</acronym> is updated on the client side. - </para> - </listitem> - </itemizedlist> + + <section id="sect-Component_Reference-a4jqueue-Queue_size"> + <title>Queue size</title> + <para> + The <varname>size</varname> attribute specifies the number of requests that can be stored in the queue at a time; smaller queue sizes help prevent server overloads. When the queue's size is exceeded, the <varname>sizeExceededBehavior</varname> determines the way in which the queue handles the requests: + </para> + <itemizedlist> + <listitem> + <para> + <literal>dropNext</literal> drops the next request currently in the queue. + </para> + </listitem> + <listitem> + <para> + <literal>dropNew</literal> drops the incoming request. + </para> + </listitem> + <listitem> + <para> + <literal>fireNext</literal> immediately sends the next request currently in the queue. + </para> + </listitem> + <listitem> + <para> + <literal>fireNew</literal> immediately sends the incoming request. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-a4jqueue-a4jqueue_client-side_events"> + <title><sgmltag>&lt;a4j:queue&gt;</sgmltag> client-side events</title> + <para> + The <sgmltag>&lt;a4j:queue&gt;</sgmltag> component features several events relating to queuing actions: + </para> + <itemizedlist> + <listitem> + <para> + The <varname>oncomplete</varname> event attribute is fired after a request is completed. The request object is passed as a parameter to the event handler, so the queue is accessible using <code>request.queue</code> and the element which was the source of the request is accessible using <code>this</code>. + </para> + </listitem> + <listitem> + <para> + The <varname>onrequestqueue</varname> event attribute is fired after a new request has been added to the queue. + </para> + </listitem> + <listitem> + <para> + The <varname>onrequestdequeue</varname> event attribute is fired after a request has been removed from the queue. + </para> + </listitem> + <listitem> + <para> + The <varname>onsizeexceeded</varname> event attribute is fired when the queue has been exceeded. + </para> + </listitem> + <listitem> + <para> + The <varname>onsubmit</varname> event attribute is fired before the request is sent. + </para> + </listitem> + <listitem> + <para> + The <varname>onsuccess</varname> event attribute is fired after a successful request but before the <acronym>DOM</acronym> is updated on the client side. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-a4jqueue-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.QueueRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlQueue</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.Queue</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.ajax4jsf.taglib.html.jsp.QueueTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <section id="sect-Component_Reference-Processing_management-a4jlog"> <title><sgmltag>&lt;a4j:log&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.Log</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.AjaxLog</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.ajax4jsf.Log</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.LogRenderer</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;a4j:log&gt;</sgmltag> component generates JavaScript that opens a debug window, logging application information such as requests, responses, and <acronym>DOM</acronym> changes. </para> - <para> - The <varname>popup</varname> attribute causes the logging data to appear in a new pop-up window if set to <literal>true</literal>, or in place on the current page if set to <literal>false</literal>. The window is set to be opened by pressing the key combination <keycombo action="simul"><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>L</keycap></keycombo>; this can be partially reconfigured with the <varname>hotkey</varname> attribute, which specifies the letter key to use in combination with <keycombo><keycap>Ctrl</keycap><keycap>Shift</keycap></keycombo> instead of <keycap>L</keycap>. - </para> - <para> - The amount of data logged can be determined with the <varname>level</varname> attribute: - </para> - <itemizedlist> - <listitem> + + <section id="sect-Component_Reference-a4jlog-Log_monitoring"> + <title>Log monitoring</title><para> + The <varname>popup</varname> attribute causes the logging data to appear in a new pop-up window if set to <literal>true</literal>, or in place on the current page if set to <literal>false</literal>. The window is set to be opened by pressing the key combination <keycombo action="simul"><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>L</keycap></keycombo>; this can be partially reconfigured with the <varname>hotkey</varname> attribute, which specifies the letter key to use in combination with <keycombo><keycap>Ctrl</keycap><keycap>Shift</keycap></keycombo> instead of <keycap>L</keycap>. + </para> + <para> + The amount of data logged can be determined with the <varname>level</varname> attribute: + </para> + <itemizedlist> + <listitem> + <para> + <literal>ERROR</literal> + </para> + </listitem> + <listitem> + <para> + <literal>FATAL</literal> + </para> + </listitem> + <listitem> + <para> + <literal>INFO</literal> + </para> + </listitem> + <listitem> + <para> + <literal>WARN</literal> + </para> + </listitem> + <listitem> + <para> + <literal>ALL</literal>, the default setting, logs all data. + </para> + </listitem> + </itemizedlist> + <example id="exam-Component_Reference-a4jlog-a4jlog_example"> + <title><sgmltag>&lt;a4j:log&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-a4jlog-a4jlog_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + <note> + <title>Log renewal</title> <para> - <literal>ERROR</literal> + The log is automatically renewed after each Ajax request. It does not need to be explicitly re-rendered. </para> - </listitem> - <listitem> - <para> - <literal>FATAL</literal> - </para> - </listitem> - <listitem> - <para> - <literal>INFO</literal> - </para> - </listitem> - <listitem> - <para> - <literal>WARN</literal> - </para> - </listitem> - <listitem> - <para> - <literal>ALL</literal>, the default setting, logs all data. - </para> - </listitem> - </itemizedlist> - <example id="exam-Component_Reference-a4jlog-a4jlog_example"> - <title><sgmltag>&lt;a4j:log&gt;</sgmltag> example</title> - -<programlisting language="XML" role="XML"> -&lt;a4j:log level="ALL" popup="false" width="400" height="200" /&gt; -</programlisting> - </example> - <note> - <title>Log renewal</title> - <para> - The log is automatically renewed after each Ajax request. It does not need to be explicitly re-rendered. - </para> - </note> + </note> + </section> + + <section id="sect-Component_Reference-a4jlog-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Log</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.AjaxLog</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.Log</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.LogRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <section id="sect-Component_Reference-Processing_management-a4jstatus"> <title><sgmltag>&lt;a4j:status&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.Status</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxStatus</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>javax.faces.Panel</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxStatusRenderer</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;a4j:status&gt;</sgmltag> component displays the status of current Ajax requests; the status can be either in progress or complete. </para> - <para> - The <varname>startText</varname> attribute defines the text shown after the request has been started and is currently in progress. This text can be styled with the <varname>startStyle</varname> and <varname>startStyleClass</varname> attributes. Similarly, the <varname>stopText</varname> attribute defines the text shown once the request is complete, and text is styled with the <varname>stopStyle</varname> and <varname>stopStyleClass</varname> attributes. Alternatively, the text styles can be customized using facets, with the facet name set to either <literal>start</literal> or <literal>stop</literal> as required. If the <varname>stopText</varname> attribute is not defined, and no facet exists for the stopped state, the status is simply not shown; in this way only the progress of the request is displayed to the user. - </para> - <example id="exam-Component_Reference-a4jstatus-Basic_a4jstatus_usage"> - <title>Basic <sgmltag>&lt;a4j:status&gt;</sgmltag> usage</title> - -<programlisting language="XML" role="XML"> -&lt;a4j:status startText="In progress..." stopText="Complete" /&gt; -</programlisting> - </example> - <para> - The <sgmltag>&lt;a4j:status&gt;</sgmltag> component works for each Ajax component inside the local region. If no region is defined, every request made on the page will activate the <sgmltag>&lt;a4j:status&gt;</sgmltag> component. Alternatively, the <sgmltag>&lt;a4j:status&gt;</sgmltag> component can be linked to specific components in one of two ways: - </para> - <itemizedlist> - <listitem> - <para> - The <varname>for</varname> attribute can be used to specify the component for which the status is to be monitored. - </para> - </listitem> - <listitem> - <para> - With an <varname>id</varname> identifier attribute specified for the <sgmltag>&lt;a4j:status&gt;</sgmltag>, individual components can have their statuses monitored by referencing the identifier with their own <varname>status</varname> attributes. - </para> - </listitem> - </itemizedlist> - <example id="exam-Component_Reference-a4jstatus-Updating_a_common_a4jstatus_component"> - <title>Updating a common <sgmltag>&lt;a4j:status&gt;</sgmltag> component</title> - -<programlisting language="XML" role="XML"> -<xi:include href="extras/exam-Component_Reference-a4jstatus-Updating_a_common_a4jstatus_component.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - </example> + + <section id="sect-Component_Reference-a4jstatus-Customizing_the_text"> + <title>Customizing the text</title> + <para> + The <varname>startText</varname> attribute defines the text shown after the request has been started and is currently in progress. This text can be styled with the <varname>startStyle</varname> and <varname>startStyleClass</varname> attributes. Similarly, the <varname>stopText</varname> attribute defines the text shown once the request is complete, and text is styled with the <varname>stopStyle</varname> and <varname>stopStyleClass</varname> attributes. Alternatively, the text styles can be customized using facets, with the facet name set to either <literal>start</literal> or <literal>stop</literal> as required. If the <varname>stopText</varname> attribute is not defined, and no facet exists for the stopped state, the status is simply not shown; in this way only the progress of the request is displayed to the user. + </para> + <example id="exam-Component_Reference-a4jstatus-Basic_a4jstatus_usage"> + <title>Basic <sgmltag>&lt;a4j:status&gt;</sgmltag> usage</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jstatus-Basic_a4jstatus_usage.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-a4jstatus-Specifying_a_region"> + <title>Specifying a region</title> + <para> + The <sgmltag>&lt;a4j:status&gt;</sgmltag> component works for each Ajax component inside the local region. If no region is defined, every request made on the page will activate the <sgmltag>&lt;a4j:status&gt;</sgmltag> component. Alternatively, the <sgmltag>&lt;a4j:status&gt;</sgmltag> component can be linked to specific components in one of two ways: + </para> + <itemizedlist> + <listitem> + <para> + The <varname>for</varname> attribute can be used to specify the component for which the status is to be monitored. + </para> + </listitem> + <listitem> + <para> + With an <varname>id</varname> identifier attribute specified for the <sgmltag>&lt;a4j:status&gt;</sgmltag>, individual components can have their statuses monitored by referencing the identifier with their own <varname>status</varname> attributes. + </para> + </listitem> + </itemizedlist> + <example id="exam-Component_Reference-a4jstatus-Updating_a_common_a4jstatus_component"> + <title>Updating a common <sgmltag>&lt;a4j:status&gt;</sgmltag> component</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jstatus-Updating_a_common_a4jstatus_component.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-a4jstatus-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Status</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxStatus</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>javax.faces.Panel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxStatusRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> </chapter> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -194,39 +194,51 @@ <section id="sect-Component_Reference-Resources-a4jkeepAlive"> <title><sgmltag>&lt;a4j:keepAlive&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.ajax4jsf.components.KeepAlive</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.ajax4jsf.components.AjaxKeepAlive</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <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 (<exceptionname>IllegalArgumentException</exceptionname>). The <sgmltag>&lt;a4j:keepAlive&gt;</sgmltag> component avoids this be maintaining the state of the whole bean object for subsequent requests. + 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 (<exceptionname>IllegalArgumentException</exceptionname>). The <sgmltag>&lt;a4j:keepAlive&gt;</sgmltag> component avoids this by maintaining the state of the whole bean object for subsequent requests. </para> - <para> - The <varname>beanName</varname> attribute defines the request-scope managed bean name to keep alive. 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="testBean" /&gt; -</programlisting> - </example> + + <section id="sect-Component_Reference-a4jkeepAlive-Basic_usage"> + <title>Basic usage</title> + <para> + The <varname>beanName</varname> attribute defines the request-scope managed bean name to keep alive. + </para> + <example id="exam-Component_Reference-a4jkeepAlive-a4jkeepAlive_example"> + <title><sgmltag>&lt;a4j:keepAlive&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-a4jkeepAlive-a4jkeepAlive_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-a4jkeepAlive-Non-Ajax_requests"> + <title>Non-Ajax requests</title> + <para> + The <varname>ajaxOnly</varname> attribute determines whether or not the value of the bean should be available during non-Ajax 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> + </section> + + <section id="sect-Component_Reference-a4jkeepAlive-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.components.KeepAlive</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.components.AjaxKeepAlive</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.AjaxKeepAlive</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <!-- TODO not in M2 --> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -114,67 +114,119 @@ The <sgmltag>&lt;rich:colorPicker&gt;</sgmltag> component has the unique event handler <varname>onbeforeshow</varname>, which is triggered immediately before the color picker is opened. The <varname>showEvent</varname> attribute can be used to bind the opening of the color picker to a specific event; it is bound to the <varname>onclick</varname> event by default. </para> </section> + --> - <section id="sect-Component_Reference-Rich_inputs-richcomboBox"> - <title><sgmltag>&lt;rich:comboBox&gt;</sgmltag></title> + <!--<rich:autocomplete>--> + <section id="sect-Component_Reference-Rich_inputs-richautocomplete"> + <title><sgmltag>&lt;rich:autocomplete&gt;</sgmltag></title> <para> - The <sgmltag>&lt;rich:comboBox&gt;</sgmltag> component is a typical combo-box with built-in Ajax capabilities. It supports client-side suggestions, browser-like selection, Seam entity converter support, and customization of the look and feel. + The <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component is an auto-completing input-box with built-in Ajax capabilities. It supports client-side suggestions, browser-like selection, and customization of the look and feel. </para> - <para> - The <varname>value</varname> attribute stores the selected value for the combo-box. Suggestions shown in the drop-down list for the combo-box can be specified in one of two ways: - </para> - <itemizedlist> - <listitem> - <para> - Using the <varname>suggestionValues</varname> attribute, and defining a collection of suggestions: - </para> - <example id="exam-Component_Reference-richcomboBox-Defining_suggestion_values"> - <title>Defining suggestion values</title> - -<programlisting language="XML" role="XML"> -&lt;rich:comboBox value="#{bean.state}" suggestionValues="#{bean.suggestions}" -</programlisting> - </example> - </listitem> - <listitem> - <para> - Using the JSF components <sgmltag>&lt;f:selectItem&gt;</sgmltag> and <sgmltag>&lt;f:selectItems&gt;</sgmltag> to define a list of items: - </para> - <example id="exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect"> - <title>Defining list items for <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag></title> - -<programlisting language="XML" role="XML"> -&lt;rich:comboBox value="#{bean.item}" valueChangeListener="#{bean.selectionChanged}" &gt; - &lt;f:selectItems value="#{bean.selectItems}" /&gt; - &lt;f.selectItem itemValue="Item 1" /&gt; - &lt;f.selectItem itemValue="Item 2" /&gt; - &lt;f.selectItem itemValue="Item 3" /&gt; - &lt;f.selectItem itemValue="Item 4" /&gt; -&lt;/rich:comboBox&gt; -</programlisting> - </example> - </listitem> - </itemizedlist> - <para> - Users can type into the combo-box's text field to enter a value, which also searches through the suggestion items in the drop-down box. By default, the first suggestion item is selected as the user types. This behavior can be deactivated by setting <code>selectFirstOnUpdate="false"</code>. Setting <code>directInputSuggestions="true"</code> causes the combo-box to fill the text field box with a matching suggestion as the user types. Alternatively, the text field can be disabled by setting <code>enableManualInput="false"</code>, which forces the users to pick from items in the drop-down box. - </para> - <para> - The <sgmltag>&lt;rich:comboBox&gt;</sgmltag> component has two unique event handlers: - </para> - <itemizedlist> - <listitem> - <para> - <varname>onlistcall</varname> triggers before the drop-down list is shown, allowing the operation to be canceled. - </para> - </listitem> - <listitem> - <para> - <varname>onselect</varname> triggers when a suggestion is selected from the drop-down list, before the update request is sent. - </para> - </listitem> - </itemizedlist> + <figure id="figu-Component_Reference-richautocomplete-richautocomplete"> + <title><sgmltag>&lt;rich:autocomplete&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richautocomplete-richautocomplete.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component. The letter <wordasword>A</wordasword> has been entered, such that the suggestion list only shows those options beginning with <wordasword>A</wordasword>. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richautocomplete-Basic_usage"> + <title>Basic usage</title> + <para> + The <varname>value</varname> attribute stores the text entered by the user for the auto-complete box. Suggestions shown in the auto-complete list can be specified using the <varname>autocompleteList</varname> attribute, which points to a collection of suggestions: + </para> + <example id="exam-Component_Reference-richautocomplete-Defining_suggestion_values"> + <title>Defining suggestion values</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richautocomplete-Defining_suggestion_values.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + <!-- + <itemizedlist> + <listitem> + <para> + Using the JSF components <sgmltag>&lt;f:selectItem&gt;</sgmltag> and <sgmltag>&lt;f:selectItems&gt;</sgmltag> to define a list of items: + </para> + <example id="exam-Component_Reference-richautocomplete-Defining_list_items_for_richinplaceSelect"> + <title>Defining list items for <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag></title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richautocomplete-Defining_list_items_for_richinplaceSelect.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </listitem> + </itemizedlist> + --> + </section> + + <section id="sect-Component_Reference-richautocomplete-Interactivity_options"> + <title>Interactivity options</title> + <!-- TODO + <para> + The input box can display an instructional label before text is entered. This can be set through the <varname>defaultLabel</varname> attribute. + </para> + --> + <para> + Users can type into the combo-box's text field to enter a value, which also searches through the suggestion items in the drop-down box. By default, the first suggestion item is selected as the user types. This behavior can be deactivated by setting <code><varname>selectFirst</varname>="false"</code>. + </para> + <para> + Setting <code><varname>autoFill</varname>="true"</code> causes the combo-box to fill the text field box with a matching suggestion as the user types. + </para> + </section> + + <!-- TODO + <section id="sect-Component_Reference-richautocomplete-richautocomplete_events"> + <title><sgmltag>&lt;rich:autocomplete&gt;</sgmltag> events</title> + <para> + The <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component has two unique event handlers: + </para> + <itemizedlist> + <listitem> + <para> + <varname>onlistcall</varname> triggers before the drop-down list is shown, allowing the operation to be canceled. + </para> + </listitem> + <listitem> + <para> + <varname>onselect</varname> triggers when a suggestion is selected from the drop-down list, before the update request is sent. + </para> + </listitem> + </itemizedlist> + </section> + --> + + <section id="sect-Component_Reference-richautocomplete-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.autocomplete</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAutocomplete</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.autocomplete</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.renderkit.autocompleteRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.autocompleteTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - --> <!-- TODO not in M2 --> <!-- @@ -268,6 +320,7 @@ </section> --> + <!--<rich:inplaceInput>--> <section id="sect-Component_Reference-Rich_inputs-richinplaceInput"> <title><sgmltag>&lt;rich:inplaceInput&gt;</sgmltag></title> <para> @@ -283,18 +336,20 @@ <section id="sect-Component_Reference-richinplaceInput-Interactivity_options"> <title>Interactivity options</title> + <!-- <para> When in the initial "view" state, the starting label can be set using the <varname>defaultLabel</varname> attribute, such as <code><varname>defaultLabel</varname>="click to edit"</code>. </para> - + --> <para> - By default, the event to switch the component to the "edit" state is a single mouse click. This can be changed using the <varname>editEvent</varname> attribute to specify a different event. When switching to "edit" mode, the existing text can be automatically highlighted to make editing easier by setting <code><varname>selectOnEdit</varname>="true"</code>. + By default, the event to switch the component to the "edit" state is a single mouse click. This can be changed using the <varname>editEvent</varname> attribute to specify a different event. </para> <para> The user can confirm and save their input by pressing the <keycap>Enter</keycap> key or cancel by pressing the <keycap>Esc</keycap> key. Alternatively, buttons for confirming or canceling can be added to the component by setting <code>showControls="true"</code>. These buttons can be positioned using the <varname>controlsHorizontalPosition</varname> attribute with settings of <literal>left</literal>, <literal>right</literal>, or <literal>center</literal>, and the <varname>controlsVerticalPosition</varname> attribute with settings <literal>bottom</literal>, <literal>center</literal>, or <literal>top</literal>. The confirmation control icons can be altered using the <varname>saveControlIcon</varname> and <varname>cancelControlIcon</varname>. Further customization is possible through the use of facets. </para> </section> + <!-- TODO <section id="sect-Component_Reference-richinplaceInput-richinplaceInput_events"> <title><sgmltag>&lt;rich:inplaceInput&gt;</sgmltag> events</title> <para> @@ -323,6 +378,7 @@ </listitem> </itemizedlist> </section> + --> <section id="sect-Component_Reference-richinplaceInput-Reference_data"> <title>Reference data</title> @@ -356,6 +412,7 @@ </section> </section> + <!--<rich:inplaceSelect>--> <section id="sect-Component_Reference-Rich_inputs-richinplaceSelect"> <title><sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag></title> <para> @@ -447,15 +504,16 @@ </section> </section> + <!--<rich:inputNumberSlider>--> <section id="sect-Component_Reference-Rich_inputs-richinputNumberSlider"> <title><sgmltag>&lt;rich:inputNumberSlider&gt;</sgmltag></title> <para> - The <sgmltag>&lt;rich:inputNumberSlider&gt;</sgmltag> component provides a slider for changing numerical values. Optional features include a tool-tip to display the value while sliding, and a text field for typing the numerical value which can then be validated against the slider's range. + The <sgmltag>&lt;rich:inputNumberSlider&gt;</sgmltag> component provides a slider for changing numerical values. Optional features include control arrows to step through the values, a tool-tip to display the value while sliding, and a text field for typing the numerical value which can then be validated against the slider's range. </para> <section id="sect-Component_Reference-richinputNumberSlider-Basic_usage"> <title>Basic usage</title> <para> - Basic use of the component with no attributes specified will render a slider with a minimum value of 0, a maximum of 100, and a gradient step of 1, together with a text field for typing the desired numerical value. The slider is labeled with the minimum and maximum boundary values, and a tool-tip showing the current value is shown while sliding the slider. + Basic use of the component with no attributes specified will render a slider with a minimum value of 0, a maximum of 100, and a gradient step of 1, together with a text field for typing the desired numerical value. The slider is labeled with the minimum and maximum boundary values, and a tool-tip showing the current value is shown while sliding the slider. The <varname>value</varname> attribute is used for storing the currently selected value of the slider. </para> </section> @@ -471,7 +529,7 @@ The minimum and maximum labels on the slider can be hidden by setting <code><varname>showBoundaryValues</varname>="false"</code>. The tool-tip showing the current value can be hidden by setting <code><varname>showToolTip</varname>="false"</code>. </para> <para> - Arrow controls can be added to either side of the slider to adjust the value incrementally by setting <code>showArrows="true"</code>. Clicking the arrows move the slider indicator in that direction by the gradient step, and clicking and holding the arrows moves the indicator continuously. The time delay for each step when updating continuously can be defined using the <varname>delay</varname> attribute. + Arrow controls can be added to either side of the slider to adjust the value incrementally by setting <code><varname>showArrows</varname>="true"</code>. Clicking the arrows move the slider indicator in that direction by the gradient step, and clicking and holding the arrows moves the indicator continuously. The time delay for each step when updating continuously can be defined using the <varname>delay</varname> attribute. </para> </section> @@ -524,7 +582,10 @@ The ability to change the value by typing into the text field can be disabled by setting <code>enableManualInput="false"</code>. </para> </section> + --> + <!--<rich:suggestionBox>--> + <!-- <section id="sect-Component_Reference-Rich_inputs-richsuggestionBox"> <title><sgmltag>&lt;rich:suggestionBox&gt;</sgmltag></title> <para> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Selection_and_ordering.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Selection_and_ordering.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Selection_and_ordering.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -11,8 +11,6 @@ <para> The <sgmltag>&lt;rich:listShuttle&gt;</sgmltag> component is used for moving select items from one list into another. Items can optionally be re-ordered. It supports selection of multiple items, keyboard usage, and a customizable look and feel. </para> - <para> - </para> </section> <section id="sect-Component_Reference-Selection_and_ordering-richorderingList"> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Validation.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Validation.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Validation.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -6,35 +6,9 @@ <para> This chapter covers those components that validate user input. The components enhance <acronym>JSF</acronym> validation capabilities with Ajax support and the use of <application>Hibernate</application> validators. </para> + <section id="sect-Component_Reference-Validation-richajaxValidator"> <title><sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.ajaxValidator</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlajaxValidator</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.ajaxValidator</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.ajaxValidatorRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ajaxValidatorTag</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> component provides Ajax validation for <acronym>JSF</acronym> inputs. It is added as a child component to a <acronym>JSF</acronym> tag, and the <varname>event</varname> attribute specifies when to trigger the validation. </para> @@ -43,209 +17,242 @@ <para> This example shows the use of <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> with standard <acronym>JSF</acronym> validators. The validators check the length of the entered name, and the range of the entered age. </para> - -<programlisting language="XML" role="XML"> -<xi:include href="extras/exam-Component_Reference-richajaxValidator-richajaxValidator_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-richajaxValidator-richajaxValidator_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </example> - <para> - The <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> component can also work with custom validators made using the <acronym>JSF</acronym> Validation <acronym>API</acronym> in the <package>javax.faces.validator</package> package, or with Hibernate Validator. Refer to the <citetitle>Hibernate Validator documentation</citetitle> for details on how to use Hibernate Validator. - </para> - <example id="exam-Component_Reference-richajaxValidator-Using_richajaxValidator_with_Hibernate_Validator"> - <title>Using <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> with Hibernate Validator</title> + + <section id="sect-Component_Reference-richajaxValidator-Custom_validators"> + <title>Custom validators</title> <para> - This example shows the use of <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> with Hibernate Validator. It validates the entered name, email, and age. + The <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> component can also work with custom validators made using the <acronym>JSF</acronym> Validation <acronym>API</acronym> in the <package>javax.faces.validator</package> package, or with Hibernate Validator. Refer to the <citetitle>Hibernate Validator documentation</citetitle> for details on how to use Hibernate Validator. </para> - -<programlisting language="XML" role="XML"> -<xi:include href="extras/exam-Component_Reference-richajaxValidator-Using_richajaxValidator_with_Hibernate_Validator-0.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - <para> - The validation is performed using the <classname>ValidationBean</classname> class: - </para> - -<programlisting language="Java" role="JAVA"> -<xi:include href="extras/exam-Component_Reference-ValidationBean.js" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-Using_richajaxValidator_with_Hibernate_Validator-richajaxValidator_example_result"> - <title><sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> example result</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richajaxValidator-richajaxValidator_example_result.png" format="PNG" width="444" /> - </imageobject> - <textobject> - <para> - The result of the <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> example: three text entry fields with corresponding validation messages. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> + <example id="exam-Component_Reference-richajaxValidator-Using_richajaxValidator_with_Hibernate_Validator"> + <title>Using <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> with Hibernate Validator</title> + <para> + This example shows the use of <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> with Hibernate Validator. It validates the entered name, email, and age. + </para> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-richajaxValidator-Using_richajaxValidator_with_Hibernate_Validator-0.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + The validation is performed using the <classname>ValidationBean</classname> class: + </para> + <programlisting language="Java" role="JAVA"><xi:include href="extras/exam-Component_Reference-ValidationBean.js" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-Using_richajaxValidator_with_Hibernate_Validator-richajaxValidator_example_result"> + <title><sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> example result</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richajaxValidator-richajaxValidator_example_result.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + The result of the <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> example: three text entry fields with corresponding validation messages. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-richajaxValidator-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.ajaxValidator</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlajaxValidator</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.ajaxValidator</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.ajaxValidatorRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ajaxValidatorTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <section id="sect-Component_Reference-Validation-richbeanValidator"> <title><sgmltag>&lt;rich:beanValidator&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.beanValidator</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlbeanValidator</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.beanValidator</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.beanValidatorRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.beanValidatorTag</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;rich:beanValidator&gt;</sgmltag> component provides model-based constraints using Hibernate Validator. This allows Hibernate Validator to be used similar to its use with Seam-based applications. </para> - <para> - The <varname>summary</varname> attribute is used for displaying messages about validation errors. - </para> - <example id="exam-Component_Reference-richbeanValidator-richbeanValidator_example"> - <title><sgmltag>&lt;rich:beanValidator&gt;</sgmltag> example</title> + <section id="sect-Component_Reference-richbeanValidator-Basic_usage"> + <title>Basic usage</title> <para> - This example shows the bean-based validation of a simple form, containing the user's name, email, and age. The <sgmltag>&lt;rich:beanValidator&gt;</sgmltag> component is defined in the same way as for <acronym>JSF</acronym> validators. + The <varname>summary</varname> attribute is used for displaying messages about validation errors. </para> - -<programlisting language="XML" role="XML"> -<xi:include href="extras/exam-Component_Reference-richbeanValidator-richbeanValidator_example-0.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - <para> - The accompanying bean contains the validation data: - </para> - -<programlisting language="Java" role="JAVA"> -<xi:include href="extras/exam-Component_Reference-ValidationBean.js" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-richbeanValidator_example-richbeanValidator_example_result"> - <title><sgmltag>&lt;rich:beanValidator&gt;</sgmltag> example result</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richbeanValidator-richbeanValidator_example_result.png" format="PNG" width="444" /> - </imageobject> - <textobject> - <para> - The result of the <sgmltag>&lt;rich:beanValidator&gt;</sgmltag> example: three text entry fields with corresponding validation messages. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> + <example id="exam-Component_Reference-richbeanValidator-richbeanValidator_example"> + <title><sgmltag>&lt;rich:beanValidator&gt;</sgmltag> example</title> + <para> + This example shows the bean-based validation of a simple form, containing the user's name, email, and age. The <sgmltag>&lt;rich:beanValidator&gt;</sgmltag> component is defined in the same way as for <acronym>JSF</acronym> validators. + </para> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-richbeanValidator-richbeanValidator_example-0.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + The accompanying bean contains the validation data: + </para> + <programlisting language="Java" role="JAVA"><xi:include href="extras/exam-Component_Reference-ValidationBean.js" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-richbeanValidator_example-richbeanValidator_example_result"> + <title><sgmltag>&lt;rich:beanValidator&gt;</sgmltag> example result</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richbeanValidator-richbeanValidator_example_result.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + The result of the <sgmltag>&lt;rich:beanValidator&gt;</sgmltag> example: three text entry fields with corresponding validation messages. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-richbeanValidator-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.beanValidator</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlbeanValidator</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.beanValidator</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.beanValidatorRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.beanValidatorTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <section id="sect-Component_Reference-Validation-richgraphValidator"> <title><sgmltag>&lt;rich:graphValidator&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.graphValidator</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlgraphValidator</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.graphValidator</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.graphValidatorRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.graphValidatorTag</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;rich:graphValidator&gt;</sgmltag> component is used to wrap a group of input components for overall validation with Hibernate Validators. This is different from the <sgmltag>&lt;rich:beanValidator&gt;</sgmltag> component, which is used as a child element to individual input components. </para> - <para> - The <varname>summary</varname> attribute is used for displaying messages about validation errors. - </para> - <example id="exam-Component_Reference-richgraphValidator-richgraphValidator_example"> - <title><sgmltag>&lt;rich:graphValidator&gt;</sgmltag> example</title> + + <section id="sect-Component_Reference-richgraphValidator-Basic_usage"> + <title>Basic usage</title> <para> - This example shows the validation of a simple form, containing the user's name, email, and age. The <sgmltag>&lt;rich:graphValidator&gt;</sgmltag> component wraps the input components to validate them together. + The <varname>summary</varname> attribute is used for displaying messages about validation errors. </para> - -<programlisting language="XML" role="XML"> -<xi:include href="extras/exam-Component_Reference-richgraphValidator-richgraphValidator_example-0.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> + <example id="exam-Component_Reference-richgraphValidator-richgraphValidator_example"> + <title><sgmltag>&lt;rich:graphValidator&gt;</sgmltag> example</title> + <para> + This example shows the validation of a simple form, containing the user's name, email, and age. The <sgmltag>&lt;rich:graphValidator&gt;</sgmltag> component wraps the input components to validate them together. + </para> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-richgraphValidator-richgraphValidator_example-0.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + The accompanying bean contains the validation data: + </para> + <programlisting language="Java" role="JAVA"><xi:include href="extras/exam-Component_Reference-ValidationBean.js" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-richgraphValidator_example-richgraphValidator_example_result"> + <title><sgmltag>&lt;rich:graphValidator&gt;</sgmltag> example result</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richgraphValidator-richgraphValidator_example_result.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + The result of the <sgmltag>&lt;rich:graphValidator&gt;</sgmltag> example: three text entry fields with corresponding validation messages. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-richgraphValidator-Bean_values"> + <title>Bean values</title> <para> - The accompanying bean contains the validation data: + The optional <varname>value</varname> attribute can be used to define a value bound to the bean. The bean properties are then validated again <emphasis>after</emphasis> the model has been updated. </para> + <example id="exam-Component_Reference-richgraphValidator-Using_the_value_attribute"> + <title>Using the <varname>value</varname> attribute</title> -<programlisting language="Java" role="JAVA"> -<xi:include href="extras/exam-Component_Reference-ValidationBean.js" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-richgraphValidator_example-richgraphValidator_example_result"> - <title><sgmltag>&lt;rich:graphValidator&gt;</sgmltag> example result</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richgraphValidator-richgraphValidator_example_result.png" format="PNG" width="444" /> - </imageobject> - <textobject> - <para> - The result of the <sgmltag>&lt;rich:graphValidator&gt;</sgmltag> example: three text entry fields with corresponding validation messages. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> - <para> - The optional <varname>value</varname> attribute can be used to define a value bound to the bean. The bean properties are then validated again <emphasis>after</emphasis> the model has been updated. - </para> - <example id="exam-Component_Reference-richgraphValidator-Using_the_value_attribute"> - <title>Using the <varname>value</varname> attribute</title> - -<programlisting language="XML" role="XML"> -<xi:include href="extras/exam-Component_Reference-richgraphValidator-Using_the_value_attribute.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-Using_the_value_attribute-Result_from_using_the_value_attribute"> - <title>Result from using the <varname>value</varname> attribute</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richgraphValidator-Result_from_using_the_value_attribute.png" format="PNG" width="444" /> - </imageobject> - <textobject> - <para> - The result from the example of using the <varname>value</varname> attribute with <sgmltag>&lt;rich:graphValidator&gt;</sgmltag>. The values in the number spinners need to validate before being stored. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> + <programlisting language="XML" role="XML"> + <xi:include href="extras/exam-Component_Reference-richgraphValidator-Using_the_value_attribute.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </programlisting> + <blockquote> + <figure id="figu-Component_Reference-Using_the_value_attribute-Result_from_using_the_value_attribute"> + <title>Result from using the <varname>value</varname> attribute</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richgraphValidator-Result_from_using_the_value_attribute.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + The result from the example of using the <varname>value</varname> attribute with <sgmltag>&lt;rich:graphValidator&gt;</sgmltag>. The values in the number spinners need to validate before being stored. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-richgraphValidator-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.graphValidator</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlgraphValidator</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.graphValidator</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.graphValidatorRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.graphValidatorTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> </chapter> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jajax-a4jajax_example.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jajax-a4jajax_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jajax-a4jajax_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jajax-a4jajax_example.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1,6 @@ +<h:panelGrid columns="2"> + <h:inputText id="myinput" value="#{userBean.name}"> + <a4j:ajax event="onkeyup" reRender="outtext" /> + </h:inputText> + <h:outputText id="outtext" value="#{userBean.name}" /> +</h:panelGrid> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jkeepAlive-a4jkeepAlive_example.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jkeepAlive-a4jkeepAlive_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jkeepAlive-a4jkeepAlive_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jkeepAlive-a4jkeepAlive_example.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1 @@ +<a4j:keepAlive beanName="testBean" /> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jlog-a4jlog_example.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jlog-a4jlog_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jlog-a4jlog_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jlog-a4jlog_example.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1 @@ +<a4j:log level="ALL" popup="false" width="400" height="200" /> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jstatus-Basic_a4jstatus_usage.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jstatus-Basic_a4jstatus_usage.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jstatus-Basic_a4jstatus_usage.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jstatus-Basic_a4jstatus_usage.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1 @@ +<a4j:status startText="In progress..." stopText="Complete" /> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-data-Data_reference_example.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-data-Data_reference_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-data-Data_reference_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-data-Data_reference_example.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1 @@ +<a4j:commandButton value="Update" data="#{userBean.name}" oncomplete="showTheName(data.name)" /> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-limitRender-Rendering_example.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-limitRender-Rendering_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-limitRender-Rendering_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-limitRender-Rendering_example.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1,12 @@ +<h:form id="form1"> + <a4j:commandButton value="Normal rendering" render="infoBlock" /> + <a4j:commandButton value="Limited rendering" render="infoBlock" limitRender="true" /> +</h:form> + +<h:panelGrid id="infoBlock"> + ... +</h:panelGrid> + +<a4j:outputPanel ajaxRendered="true"> + <h:messages /> +</a4j:outputPanel> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-render-render_example.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-render-render_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-render-render_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-render-render_example.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1,14 @@ +<h:form id="form1"> + <a4j:commandButton value="Basic reference" render="infoBlock, infoBlock2" /> + <a4j:commandButton value="Specific reference" render=":infoBlock,:sv:infoBlock2" /> +</h:form> + +<h:panelGrid id="infoBlock"> + ... +</h:panelGrid> + +<f:subview id="sv"> + <h:panelGrid id="infoBlock2"> + ... + </h:panelGrid> +</f:subview> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Defining_suggestion_values.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Defining_suggestion_values.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Defining_suggestion_values.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Defining_suggestion_values.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1 @@ +<rich:autocomplete value="#{bean.state}" autocompleteList="#{bean.suggestions}" /> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1,7 @@ +<rich:comboBox value="#{bean.state}" valueChangeListener="#{bean.selectionChanged}" > + <f:selectItems value="#{bean.selectItems}" /> + <f.selectItem itemValue="Oregon" /> + <f.selectItem itemValue="Pennsylvania" /> + <f.selectItem itemValue="Rhode Island" /> + <f.selectItem itemValue="South Carolina" /> +</rich:comboBox> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Attaching_richcomponentControl_to_a_component.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Attaching_richcomponentControl_to_a_component.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Attaching_richcomponentControl_to_a_component.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Attaching_richcomponentControl_to_a_component.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1 @@ +<rich:componentControl attachTo="doExpandCalendarID" event="onclick" operation="Expand" for="ccCalendarID" /> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-0.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-0.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-0.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-0.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1 @@ +<rich:componentControl name="func" event="onRowClick" for="menu" operation="show" params="#{car.model}"/> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-1.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-1.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-1.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-Using_parameters-1.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1,3 @@ +<rich:componentControl event="onRowClick" for="menu" operation="show"> + <f:param value="#{car.model}" name="model"/> +</rich:componentControl> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1,4 @@ +<h:commandButton value="Show Modal Panel"> + <!--componentControl is attached to the commandButton--> + <rich:componentControl for="ccModalPanelID" event="onclick" operation="show"/> +</h:commandButton> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpopupPanel-Header_and_controls.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpopupPanel-Header_and_controls.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpopupPanel-Header_and_controls.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpopupPanel-Header_and_controls.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1,17 @@ +<h:commandLink value="Show pop-up"> + <rich:componentControl target="popup" operation="show" /> +</h:commandLink> +... +<a4j:form> + <rich:popupPanel id="popup" modal="false" autosized="true" resizeable="false"> + <f:facet name="header"> + <h:outputText value="The title of the panel" /> + </f:facet> + <f:facet name="controls"> + <h:graphicImage value="/pages/close.png" style="cursor:pointer" onclick="#{rich:component('popup')}.hide()" /> + </f:facet> + <p> + This is the content of the panel. + </p> + </rich:popupPanel> +</a4j:form> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpopupPanel-richpopupPanel_example.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpopupPanel-richpopupPanel_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpopupPanel-richpopupPanel_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpopupPanel-richpopupPanel_example.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1,9 @@ +<h:commandButton value="Show the panel"> + <rich:componentControl target="popup" operation="show" /> +</h:commandButton> +... +<a4j:form> + <rich:popupPanel id="popup"> + <p><a href="#" onclick="#{rich:component('popup')}.hide()">Hide the panel</a></p> + </rich:popupPanel> +</a4j:form> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtoggleControl-richtoggleControl_example.xml_sample (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtoggleControl-richtoggleControl_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtoggleControl-richtoggleControl_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtoggleControl-richtoggleControl_example.xml_sample 2010-08-24 04:06:04 UTC (rev 18942) @@ -0,0 +1,17 @@ +<rich:togglePanel id="layout" activeItem="short"> + <rich:togglePanelItem id="short"> + //content + <h:commandButton> + <rich:toggleControl targetItem="details"> // switches to details state + </h:commandButton> + </rich:togglePanelItem> + <rich:togglePanelItem id="details"> + //content + <h:commandButton> + <rich:toggleControl targetItem="short"> //switches to short state + </h:commandButton> + <rich:togglePanelItem> +</rich:togglePanel> +<h:commandButton> + <rich:toggleControl activePanel="layout"/> // cycles through the states +</h:commandButton> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richaccordion-richaccordion.png (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richaccordion-richaccordion.png) =================================================================== (Binary files differ) Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richautocomplete-richautocomplete.png (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richautocomplete-richautocomplete.png) =================================================================== (Binary files differ) Deleted: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpanelBar-richpanelBar.png =================================================================== (Binary files differ) Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpopupPanel-Header_and_controls.png (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpopupPanel-Header_and_controls.png) =================================================================== (Binary files differ) Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtabPanel-richtabPanel_component.png (from rev 18941, modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtabPanel-richtabPanel_component.png) =================================================================== (Binary files differ) Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/Book_Info.xml =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/Book_Info.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/Book_Info.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -3,7 +3,7 @@ ]> <bookinfo id="book-Developer_Guide-Developer_Guide"> <title>Developer Guide</title> - <subtitle>Developing applications using RichFaces &VERSIONLONG;<remark> (draft)</remark> + <subtitle>Developing applications using RichFaces 4<remark> (draft)</remark> </subtitle> <productname>RichFaces</productname> <productnumber>4.0</productnumber> @@ -11,7 +11,7 @@ <pubsnumber>1</pubsnumber> <abstract> <para> - Read this book for a comprehensive guide to getting started and working with RichFaces &VERSION;. It includes details of the architecture, the framework's use in different applications, and skinning implementations. + Read this book for a comprehensive guide to getting started and working with RichFaces 4. It includes details of the architecture, the framework's use in different applications, and skinning implementations. </para> </abstract> <corpauthor> Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/Developer_Guide.ent =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/Developer_Guide.ent 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/Developer_Guide.ent 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,6 +1,5 @@ <!ENTITY PRODUCT "RichFaces"> <!ENTITY VERSION "4.0"> -<!ENTITY VERSIONLONG "4.0.0.ALPHA2"> <!ENTITY BOOKID "Developer_Guide"> <!ENTITY HOLDER "Red Hat"> <!ENTITY YEAR "2009"> Modified: modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Book_Info.xml =================================================================== --- modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Book_Info.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Book_Info.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,25 +1,22 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Migration_Guide.ent"> -%BOOK_ENTITIES; ]> <bookinfo id="book-Migration_Guide-Migration_Guide"> <title>Migration Guide</title> - <subtitle>Migrating existing projects to RichFaces &VERSIONLONG;<remark> (draft)</remark> - </subtitle> + <subtitle>Migrating existing projects to RichFaces 4.0.0<remark> (draft)</remark></subtitle> <productname>RichFaces</productname> <productnumber>4.0</productnumber> <edition>0</edition> <pubsnumber>1</pubsnumber> <abstract> <para> - Read this book to take an existing <productname>RichFaces</productname> project and upgrade it for use with <productname>RichFaces</productname> &VERSION;. The book covers changes in component usage and behaviors, as well as new framework features which may affect existing <productname>RichFaces</productname> projects. + Read this book to take an existing <productname>RichFaces</productname> project and upgrade it for use with <productname>RichFaces</productname> 4. The book covers changes in component usage and behaviors, as well as new framework features which may affect existing <productname>RichFaces</productname> projects. </para> </abstract> <corpauthor> <inlinemediaobject> <imageobject> - <imagedata fileref="./images/rf_logo.png" format="PNG" /> + <imagedata fileref="./images/rf_logo.png" format="PNG" scalefit="1" width="444" /> </imageobject> <textobject> <phrase>Logo</phrase> Modified: modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml =================================================================== --- modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Migration_Guide.ent"> -%BOOK_ENTITIES; ]> <chapter id="chap-Migration_Guide-Changes_and_new_features"> <title>Changes and new features</title> @@ -63,6 +61,9 @@ <listitem> <simplelist type="vert" columns="3"> <member> + <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> + </member> + <member> <sgmltag>&lt;rich:calendar&gt;</sgmltag> </member> <member> @@ -87,16 +88,16 @@ <sgmltag>&lt;rich:progressBar&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> + <sgmltag>&lt;rich:tab&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:suggestionBox&gt;</sgmltag> + <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:tab&gt;</sgmltag> + <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> + <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> </member> <member> <sgmltag>&lt;rich:tree&gt;</sgmltag> @@ -150,6 +151,9 @@ <listitem> <simplelist type="vert" columns="3"> <member> + <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> + </member> + <member> <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> </member> <member> @@ -186,18 +190,12 @@ <sgmltag>&lt;rich:progressBar&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:scrollableDataTable&gt;</sgmltag> + <sgmltag>&lt;rich:tab&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> + <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:suggestionBox&gt;</sgmltag> - </member> - <member> - <sgmltag>&lt;rich:tab&gt;</sgmltag> - </member> - <member> <sgmltag>&lt;rich:tree&gt;</sgmltag> </member> <member> @@ -252,6 +250,9 @@ <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> </member> <member> + <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> + </member> + <member> <sgmltag>&lt;rich:calendar&gt;</sgmltag> </member> <member> @@ -279,21 +280,18 @@ <sgmltag>&lt;rich:progressBar&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:scrollableDataTable&gt;</sgmltag> + <sgmltag>&lt;rich:tab&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> + <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:suggestionBox&gt;</sgmltag> + <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:tab&gt;</sgmltag> + <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> - </member> - <member> <sgmltag>&lt;rich:tree&gt;</sgmltag> </member> </simplelist> @@ -345,6 +343,9 @@ <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> </member> <member> + <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> + </member> + <member> <sgmltag>&lt;rich:calendar&gt;</sgmltag> </member> <member> @@ -372,21 +373,18 @@ <sgmltag>&lt;rich:progressBar&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:scrollableDataTable&gt;</sgmltag> + <sgmltag>&lt;rich:tab&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> + <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:suggestionBox&gt;</sgmltag> + <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:tab&gt;</sgmltag> + <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> - </member> - <member> <sgmltag>&lt;rich:tree&gt;</sgmltag> </member> <member> @@ -502,6 +500,9 @@ <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> </member> <member> + <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> + </member> + <member> <sgmltag>&lt;rich:calendar&gt;</sgmltag> </member> <member> @@ -529,21 +530,18 @@ <sgmltag>&lt;rich:progressBar&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:scrollableDataTable&gt;</sgmltag> + <sgmltag>&lt;rich:tab&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> + <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:suggestionBox&gt;</sgmltag> + <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:tab&gt;</sgmltag> + <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> - </member> - <member> <sgmltag>&lt;rich:tree&gt;</sgmltag> </member> <member> @@ -595,6 +593,9 @@ <sgmltag>&lt;rich:ajaxValidator&gt;</sgmltag> </member> <member> + <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> + </member> + <member> <sgmltag>&lt;rich:calendar&gt;</sgmltag> </member> <member> @@ -619,15 +620,9 @@ <sgmltag>&lt;rich:panelMenuItem&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:scrollableDataTable&gt;</sgmltag> + <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> - </member> - <member> - <sgmltag>&lt;rich:suggestionBox&gt;</sgmltag> - </member> - <member> <sgmltag>&lt;rich:tab&gt;</sgmltag> </member> <member> @@ -706,9 +701,6 @@ <sgmltag>&lt;rich:progressBar&gt;</sgmltag> </member> <member> - <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> - </member> - <member> <sgmltag>&lt;rich:suggestionBox&gt;</sgmltag> </member> <member> @@ -718,6 +710,12 @@ <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> </member> <member> + <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> + </member> + <member> + <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> + </member> + <member> <sgmltag>&lt;rich:toolTip&gt;</sgmltag> </member> <member> @@ -887,7 +885,7 @@ </section> <section id="sect-Migration_Guide-Feature_changes-a4jpush_and_a4jpoll"> - <title><sgmltag>&lt;a4J:push&gt;</sgmltag> and <sgmltag>&lt;a4j:poll&gt;</sgmltag></title> + <title><sgmltag>&lt;a4j:push&gt;</sgmltag> and <sgmltag>&lt;a4j:poll&gt;</sgmltag></title> <para> Both the <sgmltag>&lt;a4j:push&gt;</sgmltag> and <sgmltag>&lt;a4j:poll&gt;</sgmltag> components now raise a client-side event. For <sgmltag>&lt;a4j:push&gt;</sgmltag>, this is the <varname>ondataavailable</varname> event, while for <sgmltag>&lt;a4j:poll&gt;</sgmltag> it is the <varname>ontimeevent</varname>. </para> @@ -926,35 +924,63 @@ </listitem> </itemizedlist> </section> - <!-- - <section id="sect-Migration_Guide-Feature_changes-richtogglePanel"> - <title>&lt;rich:togglePanel&gt;</title> + + <section id="sect-Migration_Guide-Feature_changes-richpopupPanel"> + <title>&lt;rich:popupPanel&gt;</title> <para> - Incomplete. + The <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component replaces the old <sgmltag>&lt;rich:modalPanel&gt;</sgmltag>. It allows the pop-up window to be presented as either a modal or non-modal window. </para> </section> - <section id="sect-Migration_Guide-Feature_changes-richtabPanel"> - <title>&lt;rich:tabPanel&gt;</title> + <section id="sect-Migration_Guide-Features_changes-richtogglePanel"> + <title><sgmltag>&lt;rich:togglePanel&gt;</sgmltag></title> <para> - Incomplete. + The <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> no longer uses facets for managing switchable panels. </para> </section> + </section> + + <section id="sect-Migration_Guide-Changes_and_new_features-Consolidated_or_renamed_components"> + <title>Consolidated or renamed components</title> + <para> + Several new components and behaviors have been added to <productname>RichFaces</productname> &VERSION;, some of which replace the functionality of deprecated elements. For full details on how to use these new components and behaviors, refer to the <citetitle>Component Reference</citetitle>. + </para> - <section id="sect-Migration_Guide-Feature_changes-richtoolBar"> - <title>&lt;rich:toolBar&gt;</title> + <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richautocomplete"> + <title><sgmltag>&lt;rich:autocomplete&gt;</sgmltag></title> <para> - Incomplete. + The <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component combines and replaces the old <sgmltag>&lt;rich:comboBox&gt;</sgmltag> and <sgmltag>&lt;rich:suggestionBox&gt;</sgmltag> components. </para> </section> - <section id="sect-Migration_Guide-Feature_changes-richtoolTip"> - <title>&lt;rich:toolTip&gt;</title> + <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richaccordion_and_richaccordionItem"> + <title><sgmltag>&lt;rich:accordion&gt;</sgmltag> and <sgmltag>&lt;rich:accordionItem&gt;</sgmltag></title> <para> - Incomplete. + The <sgmltag>&lt;rich:accordion&gt;</sgmltag> component replaces the old <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component. The <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component replaces the old <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> component. </para> </section> - --> + + <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richextendedDataTable"> + <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component now includes the functionality of the old <sgmltag>&lt;rich:scrollableDataTable&gt;</sgmltag> component. + </para> + </section> + + <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richpopupPanel"> + <title><sgmltag>&lt;rich:popupPanel&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component replaces the old <sgmltag>&lt;rich:modalPanel&gt;</sgmltag> component. + </para> + </section> + + <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richtogglePanel_and_richtogglePanelItem"> + <title><sgmltag>&lt;rich:togglePanel&gt;</sgmltag> and <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag></title> + <para> + The functionality of the old <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component has been divided into two separate components: the <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> and <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> components. This naming now follows the convention of other switchable panel components. + </para> + </section> + </section> <section id="sect-Migration_Guide-Changes_and_new_features-New_components_and_behaviors"> @@ -962,7 +988,6 @@ <para> Several new components and behaviors have been added to <productname>RichFaces</productname> &VERSION;, some of which replace the functionality of deprecated elements. For full details on how to use these new components and behaviors, refer to the <citetitle>Developer Guide</citetitle>. </para> - <!-- dataTable, dataLists, trees possibly included here as they may be consolidated --> <section id="sect-Migration_Guide-New_components_and_behaviors-richbusyBehavior"> <title><sgmltag>&lt;rich:busyBehavior&gt;</sgmltag></title> @@ -971,36 +996,55 @@ </para> </section> - <!-- - <section id="sect-Migration_Guide-New_components_and_behaviors-richpopupPanel"> - <title><sgmltag>&lt;rich:popupPanel&gt;</sgmltag></title> + <section id="sect-Migration_Guide-New_components_and_behaviors-richtogglePanelItem"> + <title><sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag></title> <para> - Incomplete. + The <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component now manages multiple <sgmltag>&lt;rich:togglePanelItem&gt;</sgmltag> components instead of using facets for the switchable panels. Refer to <xref linkend="sect-Migration_Guide-Consolidated_or_renamed_components-richtogglePanel_and_richtogglePanelItem" /> and the components' descriptions in the <citetitle>Component Reference</citetitle> for further details. </para> </section> - --> </section> <section id="sect-Migration_Guide-Changes_and_new_features-Deprecated_components_and_behaviors"> <title>Deprecated components and behaviors</title> <para> - Some components and behaviors have been deprecated in <productname>RichFaces</productname> &VERSION;. For the most part these items have their functionality replicated by another component or behavior. + Some components and behaviors have been deprecated in <productname>RichFaces</productname> &VERSION;. For the most part these items have their functionality replicated by another component or behavior. Refer to <xref linkend="sect-Migration_Guide-Changes_and_new_features-Consolidated_or_renamed_components" /> for further details on consolidated functionality. </para> + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-a4jpage"> <title><sgmltag>&lt;a4j:page&gt;</sgmltag></title> <para> <productname>RichFaces</productname> &VERSION; drops support for the <sgmltag>&lt;a4j:page&gt;</sgmltag> component. The component was previously used for solving incompatibility in the JavaServer Pages (<acronym>JSP</acronym>) environment with Apache MyFaces in early Ajax4jsf versions. </para> </section> - <!-- + + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richcomboBox_and_richsuggestionBox"> + <title><sgmltag>&lt;rich:comboBox&gt;</sgmltag> and <sgmltag>&lt;rich:suggestionBox&gt;</sgmltag></title> + <para> + The functionality of the old <sgmltag>&lt;rich:comboBox&gt;</sgmltag> and <sgmltag>&lt;rich:suggestionBox&gt;</sgmltag> components is now available through the <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component. + </para> + </section> + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richmodalPanel"> <title><sgmltag>&lt;rich:modalPanel&gt;</sgmltag></title> <para> - Incomplete. + The functionality of the old <sgmltag>&lt;rich:modalPanel&gt;</sgmltag> component is now available through the <sgmltag>&lt;rich:popupPanel&gt;</sgmltag> component. </para> </section> - --> + + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richpanelBar_and_richpanelBarItem"> + <title><sgmltag>&lt;rich:panelBar&gt;</sgmltag> and <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag></title> + <para> + The functionality of the old <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component is now available through the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component. The functionality of the old <sgmltag>&lt;rich:panelBarIten&gt;</sgmltag> component is now available through the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component. + </para> + </section> + + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richscrollableDataTable"> + <title><sgmltag>&lt;rich:scrollableDataTable&gt;</sgmltag></title> + <para> + The functionality of the old <sgmltag>&lt;rich:scrollableDataTable&gt;</sgmltag> component is now available through the <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component. + </para> + </section> + </section> - </chapter> Modified: modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Introduction.xml =================================================================== --- modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Introduction.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Introduction.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Migration_Guide.ent"> -%BOOK_ENTITIES; ]> <chapter id="chap-Migration_Guide-Introduction"> <title>Introduction</title> Modified: modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Migration_Guide.ent =================================================================== --- modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Migration_Guide.ent 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Migration_Guide.ent 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,6 +1,5 @@ <!ENTITY PRODUCT "RichFaces"> <!ENTITY VERSION "4.0"> -<!ENTITY VERSIONLONG "4.0.0.ALPHA2"> <!ENTITY BOOKID "Migration_Guide"> <!ENTITY HOLDER "Red Hat Inc."> <!ENTITY YEAR "2009"> Modified: modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Migration_Guide.xml =================================================================== --- modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Migration_Guide.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Migration_Guide.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?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 "Migration_Guide.ent"> -%BOOK_ENTITIES; ]> <book status="draft"> <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> Modified: modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Preface.xml =================================================================== --- modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Preface.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Preface.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Migration_Guide.ent"> -%BOOK_ENTITIES; ]> <preface id="pref-Migration_Guide-Preface"> <title>Preface</title> Modified: modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Revision_History.xml =================================================================== --- modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Revision_History.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Revision_History.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Migration_Guide.ent"> -%BOOK_ENTITIES; ]> <appendix id="appe-Migration_Guide-Revision_History"> <title>Revision History</title> Modified: modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Upgrading.xml =================================================================== --- modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Upgrading.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Upgrading.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -1,7 +1,5 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Migration_Guide.ent"> -%BOOK_ENTITIES; ]> <chapter id="chap-Migration_Guide-Upgrading"> <title>Upgrading</title> @@ -49,6 +47,7 @@ </para> </listitem> </itemizedlist> + <!-- <para> Existing projects should already contain the following libraries; if not, they will need to be included in the libraries directory as well: </para> @@ -74,6 +73,7 @@ </para> </listitem> </itemizedlist> + --> </step> <step id="step-Migration_Guide-Installation-Set_up_Maven"> <title>Set up Maven</title> Modified: modules/docs/trunk/bundle_docs.sh =================================================================== --- modules/docs/trunk/bundle_docs.sh 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/bundle_docs.sh 2010-08-24 04:06:04 UTC (rev 18942) @@ -23,19 +23,12 @@ echo "[BUNDLE_DOCS] -> Copying Migration Guide..." mkdir $DOCSDIR/$VERSION/Migration_Guide cp -r $DOCSDIR/Migration_Guide/target/docbook/publish/* $DOCSDIR/$VERSION/Migration_Guide/ - -echo "[BUNDLE_DOCS] Building CDK docs..." -cd ../.. -cd ./cdk/trunk/docs/Component_Development_Kit_Guide/ -mvn clean install - -echo "[BUNDLE_DOCS] Copying docs to bundle:" echo "[BUNDLE_DOCS] -> Copying Component Development Kit Guide..." mkdir $DOCSDIR/$VERSION/Component_Development_Kit_Guide -cp -r ./target/docbook/publish/* $DOCSDIR/$VERSION/Component_Development_Kit_Guide/ +cp -r $DOCSDIR/Component_Development_Kit_Guide/target/docbook/publish/* $DOCSDIR/$VERSION/Component_Development_Kit_Guide/ echo "[BUNDLE_DOCS] Zipping bundle..." -cd $DOCSDIR -zip -r $VERSION.zip $DOCSDIR/$VERSION +cd $DOCSDIR/$VERSION/ +zip -r $VERSION.zip * echo "[BUNDLE_DOCS] Bundle complete." Modified: modules/docs/trunk/parent/pom.xml =================================================================== --- modules/docs/trunk/parent/pom.xml 2010-08-23 23:09:34 UTC (rev 18941) +++ modules/docs/trunk/parent/pom.xml 2010-08-24 04:06:04 UTC (rev 18942) @@ -44,12 +44,12 @@ <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-docbook-xslt</artifactId> - <version>1.1.0</version> + <version>1.1.1</version> </dependency> <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-jdocbook-style</artifactId> - <version>1.1.0</version> + <version>1.1.1</version> <type>jdocbook-style</type> </dependency> </dependencies>