Author: cluts Date: 2008-07-02 07:42:52 -0400 (Wed, 02 Jul 2008) New Revision: 9365 Modified: trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml Log: RF-3208 - added description for "attachTo" attribute; updated information for "attached" attribute; updated code example for these two attributes. Modified: trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml 2008-07-02 11:18:50 UTC (rev 9364) +++ trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml 2008-07-02 11:42:52 UTC (rev 9365) @@ -85,23 +85,29 @@ <property>&lt;rich:dropDownMenu&gt;</property> </emphasis>. </para> - <para>If a value of the <emphasis> - <property>&quot;attached&quot;</property> - </emphasis> attribute is defined as &quot;true&quot;, - the component is attached to the parent component. An example is placed below.</para> + <para>If <emphasis><property>&quot;attached&quot;</property></emphasis> value is &quot;true&quot; (default value), + component is attached to the parent component or to the component, which + <emphasis><property>&quot;id&quot;</property></emphasis> is specified in the + <emphasis><property>&quot;attachTo&quot;</property></emphasis> attribute. + An example is placed below.</para> <para> <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... + <rich:contextMenu event="oncontextmenu" attachTo="pic1" submitMode="none"> + <rich:menuItem value="Zoom In" onclick="enlarge();" id="zin"/> + <rich:menuItem value="Zoom Out" onclick="decrease();" id="zout"/> + </rich:contextMenu> <h:panelGrid columns="1" columnClasses="cent"> <h:panelGroup id="picture"> <h:graphicImage value="/richfaces/jQuery/images/pic1.png" id="pic"/> - <rich:contextMenu event="oncontextmenu" attached="true" submitMode="none"> - <rich:menuItem value="Zoom In" onclick="enlarge();" id="zin"></rich:menuItem> - <rich:menuItem value="Zoom Out" onclick="decrease();" id="zout"></rich:menuItem> - </rich:contextMenu> </h:panelGroup> </h:panelGrid> + <h:panelGrid columns="1" columnClasses="cent"> + <h:panelGroup id="picture1"> + <h:graphicImage value="/richfaces/jQuery/images/pic2.png" id="pic1"/> + </h:panelGroup> + </h:panelGrid> ...]]></programlisting> <para>The <code>&quot;enlarge()&quot;</code> and <code>&quot;decrease()&quot;</code> functions definition is placed @@ -126,13 +132,14 @@ <property>&lt;h:panelGroup&gt;</property> </emphasis> component. The <emphasis role="bold"> <property>&lt;rich:contextMenu&gt;</property> - </emphasis> component is defined as nested to <emphasis role="bold"> + </emphasis> component is not nested to <emphasis role="bold"> <property>&lt;h:panelGroup&gt;</property> - </emphasis> one and has a value of the<emphasis> - <property>&quot;attached&quot;</property> - </emphasis> attribute defined as &quot;true&quot;. Thus, - the context menu is attached to the parent component. The context menu has two items to - zoom in (zoom out) a picture by <emphasis><property>&quot;onclick&quot;</property></emphasis> event. + </emphasis> and has a value of the<emphasis> + <property>&quot;attachTo&quot;</property> + </emphasis> attribute defined as <code>&quot;pic1&quot;</code>. Thus, + the context menu is attached to the component, which + <emphasis><property>&quot;id&quot;</property></emphasis> is <code>&quot;pic1&quot;</code>. + The context menu has two items to zoom in (zoom out) a picture by <emphasis><property>&quot;onclick&quot;</property></emphasis> event. For earch item corresponding JavaScript function is defined to provide necessary action as a result of the clicking on it. For the menu is defined an <emphasis> <property>&quot;oncontextmenu&quot;</property>