[richfaces-svn-commits] JBoss Rich Faces SVN: r19220 - in modules/docs/branches/M3_draft: Migration_Guide/src/main/docbook/en-US and 1 other directory.

Author: SeanRogers Date: 2010-09-15 23:46:10 -0400 (Wed, 15 Sep 2010) New Revision: 19220 Modified: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml modules/docs/branches/M3_draft/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml Log: Added rich:collapsiblePanel (RF-8830) Modified: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml =================================================================== --- modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2010-09-15 23:43:35 UTC (rev 19219) +++ modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2010-09-16 03:46:10 UTC (rev 19220) @@ -468,44 +468,151 @@ </section> </section> - <!-- TODO not in M2 --> - <!-- - <section id="sect-Component_Reference-Panels_and_containers-richsimpleTogglePanel"> - <title><sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag></title> + <!--<rich:collapsiblePanel>--> + <section id="sect-Component_Reference-Panels_and_containers-richcollapsiblePanel"> + <title><sgmltag>&lt;rich:collapsiblePanel&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. + The <sgmltag>&lt;rich:collapsiblePanel&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 <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: - </para> - <itemizedlist> - <listitem> - <para> - <literal>server</literal>, the default setting, which causes the <sgmltag>&lt;rich:simpleTogglePanel&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> - <listitem> - <para> - <literal>ajax</literal>, which causes the <sgmltag>&lt;rich:simpleTogglePanel&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> - <listitem> - <para> - <literal>client</literal>, which causes <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> components to update on the client side, re-rendering themselves and any additional components listed with the <code>render</code> attribute. - </para> - </listitem> - </itemizedlist> - <para> - If the <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> component uses <code>opened="true"</code>, the panel is open and expanded, otherwise it is closed and collapsed. - </para> - <para> - The <code>openMarker</code> and <code>closeMarker</code> attributes can be used to define custom icons for the expanding header. - </para> + <figure id="figu-Component_Reference-richcollapsiblePanel-richcollapsiblePanel"> + <title><sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richcollapsiblePanel-richcollapsiblePanel.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component displaying details on a camera model. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richcollapsiblePanel-Basic_usage"> + <title>Basic usage</title> + <para> + Basic usage requires only the <varname>label</varname> attribute to be specified, which provides the title for the header element. + </para> + </section> + + <section id="sect-Component_Reference-richcollapsiblePanel-Expanding_and_collapsing_the_panel"> + <title>Expanding and collapsing the panel</title> + <para> + If the <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component uses <code><varname>expanded</varname>="true"</code>, the panel is open and expanded, otherwise it is closed and collapsed. + </para> + <para> + The <varname>toggleElement</varname> attribute is used to specify which user interface element triggers the expansion when clicked. It can have one of the following values: + </para> + <variablelist> + <varlistentry> + <term><literal>heading</literal></term> + <listitem> + <para> + This is the default setting. Clicking anywhere on the header of the panel will cause it to expand or collapse. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>panel</literal></term> + <listitem> + <para> + Clicking anywhere on the entire panel will cause it to expand or collapse. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>control</literal></term> + <listitem> + <para> + The panel can only be expanded or collapsed by clicking on the control in the right-hand side of the header. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + The switching mode for performing submissions is determined by the <varname>switchType</varname> attribute, which can have one of the following three values: + </para> + <variablelist> + <varlistentry> + <term><literal>server</literal></term> + <listitem> + <para> + This is the default setting. The <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component performs 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> + The <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component performs an Ajax form submission, and only 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> + The <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component updates on the client side, re-rendering itself and any additional components listed with the <varname>render</varname> attribute. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section id="sect-Component_Reference-richcollapsiblePanel-Appearance"> + <title>Appearance</title> + <para> + The appearance of the <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component can be customized using facets. The <literal>headerExpanded</literal> and <literal>headerCollapsed</literal> facets are used to style the appearance of the panel when it is expanded and collapsed respectively. The <literal>expandControl</literal> facet styles the control in the panel header used for expanding, and the <literal>collapseControl</literal> facet styles the control for collapsing. + </para> + </section> + + <section id="sect-Component_Reference-richcollapsiblePanel-richcollapsiblePanel_server-side_events"> + <title><sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> server-side events</title> + <para> + The <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component uses the following unique server-side events: + </para> + <itemizedlist> + <listitem> + <para> + The <varname>ChangeExpandEvent</varname> event occurs on the server side when the <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component is expanded or collapsed through Ajax using the <literal>server</literal> mode. It can be processed using the <varname>ChangeExpandListener</varname> attribute. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richcollapsiblePanel-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.collapsiblePanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlcollapsiblePanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.collapsiblePanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.collapsiblePanelRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.collapsiblePanelTag</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> - --> <!--<rich:tab>--> <section id="sect-Component_Reference-Panels_and_containers-richtab"> @@ -906,30 +1013,6 @@ <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> Modified: modules/docs/branches/M3_draft/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml =================================================================== --- modules/docs/branches/M3_draft/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml 2010-09-15 23:43:35 UTC (rev 19219) +++ modules/docs/branches/M3_draft/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml 2010-09-16 03:46:10 UTC (rev 19220) @@ -4,12 +4,12 @@ <chapter id="chap-Migration_Guide-Changes_and_new_features"> <title>Changes and new features</title> <para> - There have been several changes made to the RichFaces framework for version &VERSION; that may affect migrated projects. + There have been several changes made to the RichFaces framework for version 4 that may affect migrated projects. </para> <section id="sect-Migration_Guide-Changes_and_new_features-JSF_2_integration"> <title>JSF 2 integration</title> <para> - RichFaces &VERSION; has full support for JavaServer Faces (<acronym>JSF</acronym>) 2. Due to limited support for JavaServer Pages (JSP) in JSF2, RichFaces no longer fully supports JSP either. + RichFaces 4 has full support for JavaServer Faces (<acronym>JSF</acronym>) 2. Due to limited support for JavaServer Pages (JSP) in JSF2, RichFaces no longer fully supports JSP either. </para> </section> @@ -25,7 +25,7 @@ <term><varname>process</varname></term> <listitem> <para> - Changed to <varname>execute</varname> in &VERSION;. + Changed to <varname>execute</varname> in 4. </para> <variablelist> <varlistentry> @@ -115,7 +115,7 @@ <term><varname>reRender</varname></term> <listitem> <para> - Changed to <varname>render</varname> in &VERSION;. + Changed to <varname>render</varname> in 4. </para> <variablelist> <varlistentry> @@ -211,7 +211,7 @@ <term><varname>eventsQueue</varname></term> <listitem> <para> - Changed to <varname>queue</varname> in &VERSION;. + Changed to <varname>queue</varname> in 4. </para> <variablelist> <varlistentry> @@ -304,7 +304,7 @@ <term><varname>limitToList</varname></term> <listitem> <para> - Changed to <varname>limitRender</varname> in &VERSION;. + Changed to <varname>limitRender</varname> in 4. </para> <variablelist> <varlistentry> @@ -400,7 +400,7 @@ <term><varname>onbeforedomupdate</varname></term> <listitem> <para> - Changed to <varname>onsuccess</varname> in &VERSION;. + Changed to <varname>onsuccess</varname> in 4. </para> <variablelist> <varlistentry> @@ -458,7 +458,7 @@ <term><varname>ignoreDupResponses</varname></term> <listitem> <para> - Deprecated. Functionality moved to <varname>queue</varname> in &VERSION;. + Deprecated. Functionality moved to <varname>queue</varname> in 4. </para> <variablelist> <varlistentry> @@ -557,7 +557,7 @@ <term><varname>requestDelay</varname></term> <listitem> <para> - Deprecated. Functionality moved to <varname>queue</varname> in &VERSION;. + Deprecated. Functionality moved to <varname>queue</varname> in 4. </para> <variablelist> <varlistentry> @@ -638,7 +638,7 @@ <term><varname>ajaxSingle</varname></term> <listitem> <para> - Deprecated. Use <code>execute="@this"</code> in &VERSION; instead. + Deprecated. Use <code>execute="@this"</code> in 4 instead. </para> <variablelist> <varlistentry> @@ -779,7 +779,7 @@ <section id="sect-Migration_Guide-Changes_and_new_features-Feature_changes"> <title>Feature changes</title> <para> - Features have been altered or added to existing components and behaviors in the <productname>RichFaces</productname> &VERSION; framework. Refer to the <citetitle>Developer Guide</citetitle> for full details on how to make use of any new features. + Features have been altered or added to existing components and behaviors in the <productname>RichFaces</productname> 4 framework. Refer to the <citetitle>Developer Guide</citetitle> for full details on how to make use of any new features. </para> <section id="sect-Migration_Guide-Feature_changes-Server_side_process_and_render_mechanisms"> <title>Server-side process and render mechanisms</title> @@ -943,7 +943,7 @@ <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>. + Several new components and behaviors have been added to <productname>RichFaces</productname> 4, 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-Consolidated_or_renamed_components-richautocomplete"> @@ -960,6 +960,13 @@ </para> </section> + <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richcollapsiblePanel"> + <title><sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component replaces the old <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> component. + </para> + </section> + <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richextendedDataTable"> <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag></title> <para> @@ -999,7 +1006,7 @@ <section id="sect-Migration_Guide-Changes_and_new_features-New_components_and_behaviors"> <title>New components and behaviors</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>Developer Guide</citetitle>. + Several new components and behaviors have been added to <productname>RichFaces</productname> 4, 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> <section id="sect-Migration_Guide-New_components_and_behaviors-richbusyBehavior"> @@ -1020,13 +1027,13 @@ <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. Refer to <xref linkend="sect-Migration_Guide-Changes_and_new_features-Consolidated_or_renamed_components" /> for further details on consolidated functionality. + Some components and behaviors have been deprecated in <productname>RichFaces</productname> 4. 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. + <productname>RichFaces</productname> 4 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> @@ -1037,6 +1044,13 @@ </para> </section> + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richdataList_richdataDefinitionList_and_richdataOrderedList"> + <title><sgmltag>&lt;rich:dataList&gt;</sgmltag>, <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag>, and <sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag></title> + <para> + The functionality of the old <sgmltag>&lt;rich:dataList&gt;</sgmltag>, <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag>, and <sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> components is now available through the <sgmltag>&lt;rich:list&gt;</sgmltag> component. + </para> + </section> + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richmodalPanel"> <title><sgmltag>&lt;rich:modalPanel&gt;</sgmltag></title> <para> @@ -1058,6 +1072,13 @@ </para> </section> + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richsimpleTogglePanel"> + <title><sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag></title> + <para> + The functionality of the old <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> component is now available through the <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component. + </para> + </section> + </section> </chapter>