[richfaces-svn-commits] JBoss Rich Faces SVN: r15846 - in root/docs/trunk/Component_Reference/en-US: images and 1 other directory.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Fri Nov 6 01:56:53 EST 2009
Author: SeanRogers
Date: 2009-11-06 01:56:53 -0500 (Fri, 06 Nov 2009)
New Revision: 15846
Added:
root/docs/trunk/Component_Reference/en-US/images/panelMenuGroupIcons.png
Modified:
root/docs/trunk/Component_Reference/en-US/Book_Info.xml
root/docs/trunk/Component_Reference/en-US/Component_Reference.xml
root/docs/trunk/Component_Reference/en-US/Panels_and_containers.xml
root/docs/trunk/Component_Reference/en-US/Preface.xml
root/docs/trunk/Component_Reference/en-US/Rich_inputs.xml
root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml
Log:
Worked on Rich Inputs and Panels and Containers
Modified: root/docs/trunk/Component_Reference/en-US/Book_Info.xml
===================================================================
--- root/docs/trunk/Component_Reference/en-US/Book_Info.xml 2009-11-06 00:27:52 UTC (rev 15845)
+++ root/docs/trunk/Component_Reference/en-US/Book_Info.xml 2009-11-06 06:56:53 UTC (rev 15846)
@@ -27,7 +27,7 @@
<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:include>
+ <!-- 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:include>
</xi:fallback>
</xi:include>
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
Modified: root/docs/trunk/Component_Reference/en-US/Component_Reference.xml
===================================================================
--- root/docs/trunk/Component_Reference/en-US/Component_Reference.xml 2009-11-06 00:27:52 UTC (rev 15845)
+++ root/docs/trunk/Component_Reference/en-US/Component_Reference.xml 2009-11-06 06:56:53 UTC (rev 15846)
@@ -4,7 +4,7 @@
<book status="draft">
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
- <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> --><xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
+ <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> --><xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="Common_Ajax_attributes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="Rich_inputs.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="Panels_and_containers.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
Modified: root/docs/trunk/Component_Reference/en-US/Panels_and_containers.xml
===================================================================
--- root/docs/trunk/Component_Reference/en-US/Panels_and_containers.xml 2009-11-06 00:27:52 UTC (rev 15845)
+++ root/docs/trunk/Component_Reference/en-US/Panels_and_containers.xml 2009-11-06 06:56:53 UTC (rev 15846)
@@ -5,108 +5,219 @@
<chapter id="chap-Component_Reference-Panels_and_containers">
<title>Panels and containers</title>
<para>
- Incomplete
+ This chapter details those components which act as panels and containers to hold groups of other components.
</para>
<section id="sect-Component_Reference-Panels_and_containers-a4jform">
- <title>a4j:form</title>
+ <title><a4j:form></title>
<para>
- Incomplete
+ The <classname><a4j:form></classname> builds on the functionality of the JavaServer Faces (<acronym>JSF</acronym>) component <classname><h:form></classname>, adding Ajax capabilities to the form.
</para>
+ <note>
+ <title>Note</title>
+ <para>
+ The <acronym>JSF</acronym> component <classname><h:form></classname>, on which the <classname><a4j:form></classname> component is based, had an issue whereby the <classname><h:commandLink></classname> component could not be re-rendered without re-rendering the entire form. <classname><a4j:form></classname> and <classname><a4j:commandLink></classname> fix this issue.
+ </para>
+ </note>
+ <para>
+ The <classname><a4j:form></classname> component can add indirect Ajax support to non-Ajax components on the form by setting <code>ajaxSubmit="true"</code>. It then uses the standard Ajax component attributes and updates components specified with the <code>render</code> attribute.
+ </para>
+ <important>
+ <title>Important</title>
+ <para>
+ <classname><a4j:form></classname> should not use <code>ajaxSubmit="true"</code> if it contains other Ajax-capable components.
+ </para>
+ <para>
+ Additionally, due to security reasons the file upload form element cannot be indirectly made Ajax-capable with <classname><a4j:form></classname>.
+ </para>
+ </important>
</section>
<section id="sect-Component_Reference-Panels_and_containers-a4joutputPanel">
- <title>a4j:outputPanel</title>
+ <title><a4j:outputPanel></title>
<para>
- Incomplete
+ The <classname><a4j:outputPanel></classname> 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 <code>layout</code> 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 <code><span></code> tags containing the child components.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <code>layout="block"</code> will render the component as a pair of <code><div></code> tags containing the child components, which will use any defined <code><div></code> element styles.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <code>layout="none"</code> will render the component as a pair of <code><span></code> tags with an identifier equal to that of a child component. If the child component is rendered then the <code><span></code> are not included, leaving no markup representing the <classname><a4j:outputPanel></classname> in <acronym>HTML</acronym>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Setting <code>ajaxRendered="true"</code> will cause the <classname><a4j:outputPanel></classname> 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-Panels_and_containers-a4jregion">
- <title>a4j:region</title>
+ <title><a4j:region></title>
<para>
- Incomplete
+ The <classname><a4j:region></classname> 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 <classname><a4j:region></classname>, the entire view functions as a region.
</para>
+ <para>
+ The whole form is still submitted to the server, but only the specified region is processed. Regions can be nested, in which case only the immediate region of the component initiating the request will be processed.
+ </para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richmodalPanel">
- <title>rich:modalPanel</title>
+ <title><rich:modalPanel></title>
<para>
- Incomplete
+ The <classname><rich:modalPanel></classname> 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.
</para>
+ <important>
+ <title>Important</title>
+ <para>
+ The <classname><rich:modalPanel></classname> component should always be placed outside the original <classname><h:form></classname>, and must include its own <classname><h:form></classname> if performing submits.
+ </para>
+ </important>
+ <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>.
+ </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><rich:modalPanel> example</title>
+
+<programlisting language="xml">
+<a onclick="Richfaces.showModalPanel('pnl');" href="#">Show ModalPanel</a>
+<a4j:form>
+ <rich:modalPanel id="pnl" >
+ <a onclick="Richfaces.hideModalPanel('pnl');" href="#">Hide ModalPanel</a>
+ </rich:modalPanel>
+</a4j:form>
+</programlisting>
+ </example>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richpanel">
- <title>rich:panel</title>
+ <title><rich:panel></title>
<para>
- Incomplete
+ The <classname><rich:panel></classname> component is a bordered panel with an optional header.
</para>
+ <para>
+ No attributes need to be listed for basic usage. To add a header to the panel, use the <code>header</code> attribute to specify the text to appear in the header. Alternatively the header can be constructed using a header facet.
+ </para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richpanelBar">
- <title>rich:panelBar</title>
+ <title><rich:panelBar></title>
<para>
- Incomplete
+ The <classname><rich:panelBar></classname> 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. Another name for the component is "accordion". Each panel in contained in a <classname><rich:panelBar></classname> component is a <classname><rich:panelBarItem></classname> component.
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richpanelBarItem">
- <title>rich:panelBarItem</title>
+ <title><rich:panelBarItem></title>
<para>
- Incomplete
+ The <classname><rich:panelBarItem></classname> component is a panel for use with the <classname><rich:panelBar></classname> component.
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richpanelMenu">
- <title>rich:panelMenu</title>
+ <title><rich:panelMenu></title>
<para>
- Incomplete
+ The <classname><rich:panelMenu></classname> component can be used in conjunction with <classname><rich:panelMenuItem></classname> and <classname><rich:panelMenuGroup></classname> to create an expanding, hierarchical menu. The <classname><rich:panelMenu></classname> component's appearance can be highly customized, and the hierarchy can stretch to any number of sub-levels.
</para>
+ <para>
+ The <code>selectedChild</code> attribute is used to point to the name of the currently selected menu item.
+ </para>
+ <para>
+ By default, the event to expand the menu is a mouse click. This can be changed by setting <code>event</code> to specify the preferred event. Several sub-menus can be expanded a once unless the <code>expandSingle</code> is set to <literal>true</literal>, which only allows one sub-menu at a time to be expanded.
+ </para>
+ <para>
+ The <code>mode</code> attribute defines the submission mode for normal menu items, and the <code>expandMode</code> attribute defines the submission mode for menu items that expand and collapse. The settings for these attributes apply to the entire menu unless a menu item defines its own individual <code>mode</code> or <code>expandMode</code>. The values for <code>mode</code> and <code>expandMode</code> are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>server</literal>, the default setting, which submits the form normally and completely refreshes the page;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>ajax</literal>, which performs an Ajax form submission, and re-renders elements specified with the <code>render</code> attribute; and
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>none</literal>, which causes the <code>action</code> and <code>actionListener</code> items to be ignored, and the behavior is fully defined by the nested components instead of responses from submissions.
+ </para>
+ </listitem>
+ </itemizedlist>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richpanelMenuGroup">
- <title>rich:panelMenuGroup</title>
+ <title><rich:panelMenuGroup></title>
<para>
- Incomplete
+ The <classname><rich:panelMenuGroup></classname> component defines a group of <classname><rich:panelMenuItem></classname> components inside a <classname><rich:panelMenu></classname>.
</para>
+ <para>
+ If the <code>expandMode</code> is unspecified, the submission behavior for the group is inherited from the parent <classname><rich:panelMenu></classname>. Otherwise, the <code>expandMode</code> setting is used instead of the parent's behavior.
+ </para>
+ <para>
+ Icons for menu items can be chosen from a set of standard icons. There are three attributes that relate to the different menu states that the icon represents: <code>iconExpanded</code>, <code>iconCollapsed</code>, and <code>iconDisabled</code>. The standard icons are shown in <xref linkend="figu-Component_Reference-richpanelMenuGroup-Standard_icons" />.
+ </para>
+ <figure id="figu-Component_Reference-richpanelMenuGroup-Standard_icons">
+ <title>Standard icons</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/panelMenuGroupIcons.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </figure>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richpanelMenuItem">
- <title>rich:panelMenuItem</title>
+ <title><rich:panelMenuItem></title>
<para>
Incomplete
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richsimpleTogglePanel">
- <title>rich:simpleTogglePanel</title>
+ <title><rich:simpleTogglePanel></title>
<para>
Incomplete
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richtabPanel">
- <title>rich:tabPanel</title>
+ <title><rich:tabPanel></title>
<para>
Incomplete
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richtab">
- <title>rich:tab</title>
+ <title><rich:tab></title>
<para>
Incomplete
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richtogglePanel">
- <title>rich:togglePanel</title>
+ <title><rich:togglePanel></title>
<para>
Incomplete
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richtoggleControl">
- <title>rich:toggleControl</title>
+ <title><rich:toggleControl></title>
<para>
Incomplete
</para>
Modified: root/docs/trunk/Component_Reference/en-US/Preface.xml
===================================================================
--- root/docs/trunk/Component_Reference/en-US/Preface.xml 2009-11-06 00:27:52 UTC (rev 15845)
+++ root/docs/trunk/Component_Reference/en-US/Preface.xml 2009-11-06 06:56:53 UTC (rev 15846)
@@ -4,10 +4,10 @@
<preface id="pref-Component_Reference-Preface">
<title>Preface</title>
- <!-- FOR JDOCBOOK --><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR PUBLICAN --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
+ <!-- FOR JDOCBOOK --><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR PUBLICAN --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
</xi:fallback>
</xi:include>
- <!-- PUBLICAN'S ORIGINAL XINCLUDES --><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.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/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
+ <!-- PUBLICAN'S ORIGINAL XINCLUDES --><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.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/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
</xi:fallback>
</xi:include>
</xi:fallback>
Modified: root/docs/trunk/Component_Reference/en-US/Rich_inputs.xml
===================================================================
--- root/docs/trunk/Component_Reference/en-US/Rich_inputs.xml 2009-11-06 00:27:52 UTC (rev 15845)
+++ root/docs/trunk/Component_Reference/en-US/Rich_inputs.xml 2009-11-06 06:56:53 UTC (rev 15846)
@@ -113,8 +113,9 @@
<para>
Using the <code>suggestionValues</code> attribute, and defining a collection of suggestions:
</para>
- <example>
+ <example id="exam-Component_Reference-richcomboBox-Defining_suggestion_values">
<title>Defining suggestion values</title>
+
<programlisting language="XML">
<rich:comboBox value="#{bean.state}" suggestionValues="#{bean.suggestions}"
</programlisting>
@@ -177,8 +178,9 @@
<para>
Basic usage requires the <code>uploadData</code> attribute, pointing to the collection of uploaded files.
</para>
- <example>
+ <example id="exam-Component_Reference-richfileUpload-Basic_usage_of_richfileUpload">
<title>Basic usage of <rich:fileUpload></title>
+
<programlisting language="XML">
<rich:fileUpload uploadData="#{bean.data}" />
</programlisting>
Modified: root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml
===================================================================
--- root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml 2009-11-06 00:27:52 UTC (rev 15845)
+++ root/docs/trunk/Component_Reference/en-US/all-Component_Reference.xml 2009-11-06 06:56:53 UTC (rev 15846)
@@ -34,7 +34,7 @@
<year>2009</year>
<holder>Red Hat</holder>
</copyright>
- <!-- FOR PUBLICAN --><legalnotice xml:base="Common_Content/Legal_Notice.xml">
+ <!-- FOR PUBLICAN --><legalnotice xml:base="Common_Content/Legal_Notice.xml">
<para>
Copyright <trademark class="copyright"/> 2009 Red Hat This material may only be distributed subject to the terms and conditions set forth in the GNU Free Documentation License (GFDL), V1.2 or later (the latest version is presently available at <ulink url="http://www.gnu.org/licenses/fdl.txt">http://www.gnu.org/licenses/fdl.txt</ulink>).
</para>
@@ -51,7 +51,7 @@
</author>
</authorgroup>
</bookinfo>
- <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> --><chapter id="chap-Component_Reference-Introduction" lang="en-US">
+ <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> --><chapter id="chap-Component_Reference-Introduction" lang="en-US">
<title>Introduction</title>
<para>
This book is a guide to the various components available in the RichFaces 4.0 framework. It includes descriptions of the role of the components, details on how best to use them, coded examples of their use, and basic references of their properties and attributes.
@@ -417,7 +417,7 @@
<para>
Using the <code>suggestionValues</code> attribute, and defining a collection of suggestions:
</para>
- <example>
+ <example id="exam-Component_Reference-richcomboBox-Defining_suggestion_values">
<title>Defining suggestion values</title>
<programlisting language="XML">
@@ -482,7 +482,7 @@
<para>
Basic usage requires the <code>uploadData</code> attribute, pointing to the collection of uploaded files.
</para>
- <example>
+ <example id="exam-Component_Reference-richfileUpload-Basic_usage_of_richfileUpload">
<title>Basic usage of <rich:fileUpload></title>
<programlisting language="XML">
@@ -709,108 +709,219 @@
<chapter id="chap-Component_Reference-Panels_and_containers" lang="en-US">
<title>Panels and containers</title>
<para>
- Incomplete
+ This chapter details those components which act as panels and containers to hold groups of other components.
</para>
<section id="sect-Component_Reference-Panels_and_containers-a4jform">
- <title>a4j:form</title>
+ <title><a4j:form></title>
<para>
- Incomplete
+ The <classname><a4j:form></classname> builds on the functionality of the JavaServer Faces (<acronym>JSF</acronym>) component <classname><h:form></classname>, adding Ajax capabilities to the form.
</para>
+ <note>
+ <title>Note</title>
+ <para>
+ The <acronym>JSF</acronym> component <classname><h:form></classname>, on which the <classname><a4j:form></classname> component is based, had an issue whereby the <classname><h:commandLink></classname> component could not be re-rendered without re-rendering the entire form. <classname><a4j:form></classname> and <classname><a4j:commandLink></classname> fix this issue.
+ </para>
+ </note>
+ <para>
+ The <classname><a4j:form></classname> component can add indirect Ajax support to non-Ajax components on the form by setting <code>ajaxSubmit="true"</code>. It then uses the standard Ajax component attributes and updates components specified with the <code>render</code> attribute.
+ </para>
+ <important>
+ <title>Important</title>
+ <para>
+ <classname><a4j:form></classname> should not use <code>ajaxSubmit="true"</code> if it contains other Ajax-capable components.
+ </para>
+ <para>
+ Additionally, due to security reasons the file upload form element cannot be indirectly made Ajax-capable with <classname><a4j:form></classname>.
+ </para>
+ </important>
</section>
<section id="sect-Component_Reference-Panels_and_containers-a4joutputPanel">
- <title>a4j:outputPanel</title>
+ <title><a4j:outputPanel></title>
<para>
- Incomplete
+ The <classname><a4j:outputPanel></classname> 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 <code>layout</code> 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 <code><span></code> tags containing the child components.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <code>layout="block"</code> will render the component as a pair of <code><div></code> tags containing the child components, which will use any defined <code><div></code> element styles.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <code>layout="none"</code> will render the component as a pair of <code><span></code> tags with an identifier equal to that of a child component. If the child component is rendered then the <code><span></code> are not included, leaving no markup representing the <classname><a4j:outputPanel></classname> in <acronym>HTML</acronym>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Setting <code>ajaxRendered="true"</code> will cause the <classname><a4j:outputPanel></classname> 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-Panels_and_containers-a4jregion">
- <title>a4j:region</title>
+ <title><a4j:region></title>
<para>
- Incomplete
+ The <classname><a4j:region></classname> 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 <classname><a4j:region></classname>, the entire view functions as a region.
</para>
+ <para>
+ The whole form is still submitted to the server, but only the specified region is processed. Regions can be nested, in which case only the immediate region of the component initiating the request will be processed.
+ </para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richmodalPanel">
- <title>rich:modalPanel</title>
+ <title><rich:modalPanel></title>
<para>
- Incomplete
+ The <classname><rich:modalPanel></classname> 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.
</para>
+ <important>
+ <title>Important</title>
+ <para>
+ The <classname><rich:modalPanel></classname> component should always be placed outside the original <classname><h:form></classname>, and must include its own <classname><h:form></classname> if performing submits.
+ </para>
+ </important>
+ <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>.
+ </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><rich:modalPanel> example</title>
+
+<programlisting language="xml">
+<a onclick="Richfaces.showModalPanel('pnl');" href="#">Show ModalPanel</a>
+<a4j:form>
+ <rich:modalPanel id="pnl" >
+ <a onclick="Richfaces.hideModalPanel('pnl');" href="#">Hide ModalPanel</a>
+ </rich:modalPanel>
+</a4j:form>
+</programlisting>
+ </example>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richpanel">
- <title>rich:panel</title>
+ <title><rich:panel></title>
<para>
- Incomplete
+ The <classname><rich:panel></classname> component is a bordered panel with an optional header.
</para>
+ <para>
+ No attributes need to be listed for basic usage. To add a header to the panel, use the <code>header</code> attribute to specify the text to appear in the header. Alternatively the header can be constructed using a header facet.
+ </para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richpanelBar">
- <title>rich:panelBar</title>
+ <title><rich:panelBar></title>
<para>
- Incomplete
+ The <classname><rich:panelBar></classname> 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. Another name for the component is "accordion". Each panel in contained in a <classname><rich:panelBar></classname> component is a <classname><rich:panelBarItem></classname> component.
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richpanelBarItem">
- <title>rich:panelBarItem</title>
+ <title><rich:panelBarItem></title>
<para>
- Incomplete
+ The <classname><rich:panelBarItem></classname> component is a panel for use with the <classname><rich:panelBar></classname> component.
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richpanelMenu">
- <title>rich:panelMenu</title>
+ <title><rich:panelMenu></title>
<para>
- Incomplete
+ The <classname><rich:panelMenu></classname> component can be used in conjunction with <classname><rich:panelMenuItem></classname> and <classname><rich:panelMenuGroup></classname> to create an expanding, hierarchical menu. The <classname><rich:panelMenu></classname> component's appearance can be highly customized, and the hierarchy can stretch to any number of sub-levels.
</para>
+ <para>
+ The <code>selectedChild</code> attribute is used to point to the name of the currently selected menu item.
+ </para>
+ <para>
+ By default, the event to expand the menu is a mouse click. This can be changed by setting <code>event</code> to specify the preferred event. Several sub-menus can be expanded a once unless the <code>expandSingle</code> is set to <literal>true</literal>, which only allows one sub-menu at a time to be expanded.
+ </para>
+ <para>
+ The <code>mode</code> attribute defines the submission mode for normal menu items, and the <code>expandMode</code> attribute defines the submission mode for menu items that expand and collapse. The settings for these attributes apply to the entire menu unless a menu item defines its own individual <code>mode</code> or <code>expandMode</code>. The values for <code>mode</code> and <code>expandMode</code> are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>server</literal>, the default setting, which submits the form normally and completely refreshes the page;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>ajax</literal>, which performs an Ajax form submission, and re-renders elements specified with the <code>render</code> attribute; and
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>none</literal>, which causes the <code>action</code> and <code>actionListener</code> items to be ignored, and the behavior is fully defined by the nested components instead of responses from submissions.
+ </para>
+ </listitem>
+ </itemizedlist>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richpanelMenuGroup">
- <title>rich:panelMenuGroup</title>
+ <title><rich:panelMenuGroup></title>
<para>
- Incomplete
+ The <classname><rich:panelMenuGroup></classname> component defines a group of <classname><rich:panelMenuItem></classname> components inside a <classname><rich:panelMenu></classname>.
</para>
+ <para>
+ If the <code>expandMode</code> is unspecified, the submission behavior for the group is inherited from the parent <classname><rich:panelMenu></classname>. Otherwise, the <code>expandMode</code> setting is used instead of the parent's behavior.
+ </para>
+ <para>
+ Icons for menu items can be chosen from a set of standard icons. There are three attributes that relate to the different menu states that the icon represents: <code>iconExpanded</code>, <code>iconCollapsed</code>, and <code>iconDisabled</code>. The standard icons are shown in <xref linkend="figu-Component_Reference-richpanelMenuGroup-Standard_icons"/>.
+ </para>
+ <figure id="figu-Component_Reference-richpanelMenuGroup-Standard_icons">
+ <title>Standard icons</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/panelMenuGroupIcons.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richpanelMenuItem">
- <title>rich:panelMenuItem</title>
+ <title><rich:panelMenuItem></title>
<para>
Incomplete
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richsimpleTogglePanel">
- <title>rich:simpleTogglePanel</title>
+ <title><rich:simpleTogglePanel></title>
<para>
Incomplete
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richtabPanel">
- <title>rich:tabPanel</title>
+ <title><rich:tabPanel></title>
<para>
Incomplete
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richtab">
- <title>rich:tab</title>
+ <title><rich:tab></title>
<para>
Incomplete
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richtogglePanel">
- <title>rich:togglePanel</title>
+ <title><rich:togglePanel></title>
<para>
Incomplete
</para>
</section>
<section id="sect-Component_Reference-Panels_and_containers-richtoggleControl">
- <title>rich:toggleControl</title>
+ <title><rich:toggleControl></title>
<para>
Incomplete
</para>
Added: root/docs/trunk/Component_Reference/en-US/images/panelMenuGroupIcons.png
===================================================================
(Binary files differ)
Property changes on: root/docs/trunk/Component_Reference/en-US/images/panelMenuGroupIcons.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
More information about the richfaces-svn-commits
mailing list