Author: SeanRogers Date: 2011-04-04 20:21:23 -0400 (Mon, 04 Apr 2011) New Revision: 22365 Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtreeNode-Basic_usage.xml_sample Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Trees.xml Log: Completed part 3 of revisions for Engineering review: RFPL-1380 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml 2011-04-04 16:12:14 UTC (rev 22364) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml 2011-04-05 00:21:23 UTC (rev 22365) @@ -103,7 +103,7 @@ <section id="sect-Component_Reference-richdropDownMenu-Expanding_and_collapsing_the_menu"> <title>Expanding and collapsing the menu</title> <para> - By default, the menu drops down when the title is clicked. To drop down with a different event, use the <varname>eventShow</varname> attribute to define the event instead. + By default, the menu drops down when the title is clicked. To drop down with a different event, use the <varname>showEvent</varname> attribute to define the event instead. </para> <para> Menus can be navigated using the keyboard. Additionally, menus can be navigated programmatically using the JavaScript <acronym>API</acronym>. The JavaScript API allows the following methods: @@ -310,7 +310,7 @@ <section id="sect-Component_Reference-richmenuGroup-Basic_usage"> <title>Basic usage</title> <para> - The <sgmltag>&lt;rich:menuGroup&gt;</sgmltag> component requires the <varname>value</varname> attribute for basic usage. The <varname>value</varname> attribute is the text label for the menu item. + The <sgmltag>&lt;rich:menuGroup&gt;</sgmltag> component requires the <varname>label</varname> attribute for basic usage. The <varname>label</varname> attribute is the text label for the menu item. Alternatively, use the <literal>label</literal> facet to define content for the label. </para> <para> Additionally, the <sgmltag>&lt;rich:menuGroup&gt;</sgmltag> component must contain child <sgmltag>&lt;rich:menuItem&gt;</sgmltag> components or <sgmltag>&lt;rich:menuGroup&gt;</sgmltag> components. @@ -811,14 +811,14 @@ <section id="sect-Component_Reference-richpanelMenuGroup-Submission_modes"> <title>Submission modes</title> <para> - If the <varname>mode</varname> attribute is unspecified, the submission behavior for the group is inherited from the parent <sgmltag>&lt;rich:panelMenu&gt;</sgmltag>. Otherwise, the <varname>mode</varname> setting is used instead of the parent's behavior. Refer to <xref linkend="sect-Component_Reference-richpanelMenu-Submission_modes" /> for submission mode settings. + If the <varname>mode</varname> attribute is unspecified, the submission behavior for the group is inherited from the parent <sgmltag>&lt;rich:panelMenu&gt;</sgmltag>. Otherwise, the <varname>groupMode</varname> setting of the panel menu is used instead of the parent's behavior. Refer to <xref linkend="sect-Component_Reference-richpanelMenu-Submission_modes" /> for submission mode settings. </para> </section> <section id="sect-Component_Reference-richpanelMenuGroup-richpanelMenuGroup_server-side_events"> <title><sgmltag>&lt;rich:panelMenuGroup&gt;</sgmltag> server-side events</title> <para> - The <sgmltag>&lt;rich:panelMenuGroup&gt;</sgmltag> component fires the <literal>ActionEvent</literal> event on the server side when the menu group receives a user action. The event only fires in the <literal>server</literal> and <literal>ajax</literal> submission modes. The event provides the <varname>action</varname> attribute to specify the user action performed, and the <varname>actionListener</varname> attribute to reference the event listener. + The <sgmltag>&lt;rich:panelMenuGroup&gt;</sgmltag> component fires the <literal>ActionEvent</literal> event on the server side when the menu group receives a user action. The event only fires in the <literal>server</literal> and <literal>ajax</literal> submission modes. The event provides the <varname>action</varname> attribute to specify the user action method, and the <varname>actionListener</varname> attribute to reference the event listener. </para> </section> @@ -956,7 +956,7 @@ <section id="sect-Component_Reference-richpanelMenuItem-Submission_modes"> <title>Submission modes</title> <para> - If the <varname>mode</varname> is unspecified, the submission behavior for the item is inherited from the parent <sgmltag>&lt;rich:panelMenu&gt;</sgmltag>. Otherwise, the <varname>mode</varname> setting is used instead of the parent's behavior. + If the <varname>mode</varname> is unspecified, the submission behavior for the item is inherited from the parent <sgmltag>&lt;rich:panelMenu&gt;</sgmltag>. Otherwise, the <varname>itemMode</varname> setting from the panel menu is used instead of the parent's behavior. </para> </section> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Trees.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Trees.xml 2011-04-04 16:12:14 UTC (rev 22364) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Trees.xml 2011-04-05 00:21:23 UTC (rev 22365) @@ -122,7 +122,7 @@ <term><literal>server</literal></term> <listitem> <para> - The <sgmltag>&lt;rich:tree&gt;</sgmltag> component performs a common submission, completely re-rendering the page. + The <sgmltag>&lt;rich:tree&gt;</sgmltag> component performs a common submission, completely refreshing the page. </para> </listitem> </varlistentry> @@ -130,13 +130,13 @@ <term><literal>client</literal></term> <listitem> <para> - The <sgmltag>&lt;rich:tree&gt;</sgmltag> component updates on the client side, re-rendering itself and any additional components listed with the <varname>render</varname> attribute. + The <sgmltag>&lt;rich:tree&gt;</sgmltag> component updates on the client side through JavaScript, without any additional requests or updates. All nodes are rendered to the client during the initial page rendering. </para> </listitem> </varlistentry> </variablelist> <para> - By default, the event to expand or collapse a tree node is a mouse click. To specify a different event, use the <varname>toggleNodeEvent</varname> attribute. + By default, tree nodes are expanded and collapsed through the <guibutton>+</guibutton> and <guibutton>-</guibutton> controls. To expand or collapse a tree node using an action event such as a mouse click, specify the event with the <varname>toggleNodeEvent</varname> attribute. </para> </section> @@ -158,7 +158,7 @@ <term><literal>server</literal></term> <listitem> <para> - The <sgmltag>&lt;rich:tree&gt;</sgmltag> component performs a common submission, completely re-rendering the page. + The <sgmltag>&lt;rich:tree&gt;</sgmltag> component performs a common submission, completely refreshing the page. </para> </listitem> </varlistentry> @@ -166,7 +166,7 @@ <term><literal>client</literal></term> <listitem> <para> - The <sgmltag>&lt;rich:tree&gt;</sgmltag> component updates on the client side, re-rendering itself and any additional components listed with the <varname>render</varname> attribute. + The <sgmltag>&lt;rich:tree&gt;</sgmltag> component updates on the client side using JavaScript, without any additional requests or updates. </para> </listitem> </varlistentry> @@ -363,8 +363,15 @@ <section id="sect-Component_Reference-richtreeNode-Basic_usage"> <title>Basic usage</title> <para> - The <sgmltag>&lt;rich:treeNode&gt;</sgmltag> component must be a child of a <sgmltag>&lt;rich:tree&gt;</sgmltag> component. It does not need any attributes declared for basic usage, but can provide markup templates for tree nodes of particular types. Refer to <xref linkend="exam-Component_Reference-richtree-Basic_usage" /> for an example of basic <sgmltag>&lt;rich:treeNode&gt;</sgmltag> component usage. + The <sgmltag>&lt;rich:treeNode&gt;</sgmltag> component must be a child of a <sgmltag>&lt;rich:tree&gt;</sgmltag> component or a tree adaptor component. It does not need any attributes declared for basic usage, but can provide markup templates for tree nodes of particular types. Default markup is used if the tree node type is not specified. Refer to <xref linkend="exam-Component_Reference-richtree-Basic_usage" /> for an example of basic <sgmltag>&lt;rich:treeNode&gt;</sgmltag> component usage. </para> + <example id="exam-Component_Reference-richtreeNode-Basic_usage"> + <title>Basic usage</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richtreeNode-Basic_usage.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + The example renders a simple tree of countries. Each country node expands to show state nodes for that country, and each state node expands to show city nodes for that state. + </para> + </example> </section> <section id="sect-Component_Reference-richtreeNode-Appearance"> @@ -373,8 +380,9 @@ Refer to <xref linkend="sect-Component_Reference-richtree-Appearance" /> for the <sgmltag>&lt;rich:tree&gt;</sgmltag> component for details and examples on styling nodes and icons. Icon styling for individual <sgmltag>&lt;rich:treeNode&gt;</sgmltag> components uses the same attributes as the parent <sgmltag>&lt;rich:tree&gt;</sgmltag> component: <varname>iconLeaf</varname>, <varname>iconExpanded</varname>, and <varname>iconCollapsed</varname>. Icon-related attributes specified for child <sgmltag>&lt;rich:treeNode&gt;</sgmltag> components overwrite any global icon attributes of the parent <sgmltag>&lt;rich:tree&gt;</sgmltag> component. </para> <para> - Use the <varname>rendered</varname> attribute to determine whether the node should actually be rendered in the tree or not. Using the <varname>rendered</varname> attribute in combination with the <sgmltag>&lt;rich:treeNode&gt;</sgmltag> <varname>type</varname> attribute can allow further style differentiation between node content, as shown in <xref linkend="exam-Component_Reference-richtreeNode-rendered_attribute" />. + Use the <varname>rendered</varname> attribute to determine whether the node should actually be rendered in the tree or not. Using the <varname>rendered</varname> attribute in combination with the <sgmltag>&lt;rich:treeNode&gt;</sgmltag> <varname>type</varname> attribute can allow further style differentiation between node content. </para> + <!-- <example id="exam-Component_Reference-richtreeNode-rendered_attribute"> <title><varname>rendered</varname> attribute</title> <para> @@ -387,6 +395,7 @@ </imageobject> </mediaobject> </example> + --> </section> <section id="sect-Component_Reference-richtreeNode-Interactivity"> @@ -469,7 +478,7 @@ <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> components can further be nested in other <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> components to subsequently populate lower levels of the tree. </para> <para> - To access the current element at each iteration, use the <varname>var</varname> attribute of either the parent <sgmltag>&lt;rich:tree&gt;</sgmltag> component or the <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> component itself. <xref linkend="exam-Component_Reference-richtreeModelAdaptor-Nested_richtreeModelAdaptor_components" /> demonstrates a series of nested <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> components, each using the parent's <varname>var</varname> attribute to reference the current element. + To access the current element at each iteration, use the <varname>var</varname> attribute of either the parent <sgmltag>&lt;rich:tree&gt;</sgmltag> component<!-- or the <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> component itself-->. <xref linkend="exam-Component_Reference-richtreeModelAdaptor-Nested_richtreeModelAdaptor_components" /> demonstrates a series of nested <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> components, each using the parent's <varname>var</varname> attribute to reference the current element. </para> <example id="exam-Component_Reference-richtreeModelAdaptor-Nested_richtreeModelAdaptor_components"> <title><sgmltag>Nested &lt;rich:treeModelAdaptor&gt; components</sgmltag></title> Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtreeNode-Basic_usage.xml_sample =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtreeNode-Basic_usage.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtreeNode-Basic_usage.xml_sample 2011-04-05 00:21:23 UTC (rev 22365) @@ -0,0 +1,12 @@ +<rich:tree nodeType="#{node.type}" var="node" + value="#{treeBean.rootNodes}"> + <rich:treeNode type="country"> + #{node.name} + </rich:treeNode> + <rich:treeNode type="state"> + #{node.name} + </rich:treeNode> + <rich:treeNode type="city"> + #{node.name} + </rich:treeNode> +</rich:tree>