Author: smukhina Date: 2007-12-12 09:22:58 -0500 (Wed, 12 Dec 2007) New Revision: 4774 Modified: branches/3.1.x/samples/richfaces-demo/src/main/webapp/richfaces/contextMenu/usage.xhtml Log: http://jira.jboss.com/jira/browse/RF-1496 language on demo page is checked Modified: branches/3.1.x/samples/richfaces-demo/src/main/webapp/richfaces/contextMenu/usage.xhtml =================================================================== --- branches/3.1.x/samples/richfaces-demo/src/main/webapp/richfaces/contextMenu/usage.xhtml 2007-12-12 13:57:19 UTC (rev 4773) +++ branches/3.1.x/samples/richfaces-demo/src/main/webapp/richfaces/contextMenu/usage.xhtml 2007-12-12 14:22:58 UTC (rev 4774) @@ -8,12 +8,10 @@ <ui:composition template="/templates/component-sample.xhtml"> <ui:define name="sample"> - - - <p>RichFaces Context menu is a component that allows to organize the hierarchical cointext menus + <p>RichFaces Context menu is a component that allows to organize the hierarchical context menus similar to one that almost every desktop application has. </p> - <p>Context Menu can contains a set of Menu Items, Menu Groups and Menu Separators. + <p>Context Menu can contain a set of Menu Items, Menu Groups and Menu Separators. Usage of these components are similar to usage in RichFaces Drop Down Menu. </p> <p><b>Example:</b>To call the menu - perform the right click on the picture</p> @@ -26,33 +24,33 @@ </div> <p> - In this example menu just defined as nested to <b>panelGroup</b> with "picture" Id. - You should be carefull with such definitions, because on the client - menu component + In this example menu is just defined as nested to <b>panelGroup</b> with "picture" Id. + You should be careful with such definitions, because on the client menu component searches for the DOM element with the client Id of the parent component on the server. - If the component doesn't encodes id on the client - it will be not found by the menu and menu - will be attached to its closest parent in DOM tree. For example you should not define the menu as a child + If the component doesn't encode id on the client, it will be not found by the menu and menu + will be attached to its closest parent in a DOM tree. For example you should not define the menu as a child for images components. </p> <p>Context menu itself is an invisible panel - that appears after a particular client side event (onmouseover, onclick etc) occured on parent component. + that appears after a particular client side event (onmouseover, onclick etc) occured on a parent component. The event is defined with an <b>event</b> attribute.</p> <p> - <i><b>Note:</b> As you can see from first example the component could use "oncontextmenu" event to call the Menu on right click event. - But in this case this component should be called through <b>componentControl</b> component(as it shown at second example) rather than using a4j:support style, - because many of the components doesn't encodes this event and in case of support-like definition - the component will not work properly. + <i><b>Note:</b> As you can see from the first example the component could use "oncontextmenu" event to call the Menu on right click event. + But in this case the component should be called via <b>componentControl</b> component (as it is shown at the second example) rather than using a4j:support style. + If a4j:support style is used then many of the components don't encode this event and also in case of support-like definition the component will not work properly. </i> </p> <p> Other usefull attributes are: <ul> <li> - <b>disableDefaultMenu</b> - if true the event which defined on the menu + <b>disableDefaultMenu</b> - if it is true, the event defined on the menu will not be handled by other client handlers except context menu handler. You - may see on the first example that standard browser menu isn't called + may see on the first example that a standard browser menu isn't called after right click. </li> <li> - <b>attached</b> if true - the menu attached to parent component. In other case + <b>attached</b> - if it is true, the menu is attached to parent component. In other case it should be called via JS API (using componentControl) </li> </ul> @@ -62,13 +60,13 @@ support. </p> <p> - And the main difference from drop down menu - context menu could be defined once on the page + And the main difference from drop down menu is that a context menu could be defined once on the page and used by different components. Single instance of the menu will be created and shared between the components. </p> <p> - To customize shared menu for every component macrosubstitutions could be used. + To customize shared menu for every component, macrosubstitutions could be used. <b>ComponentControl</b> component could be used to call the instance of the menu for - the concrete component. <b>f:param</b> components could be used to add parameters to menu. + the particular component. <b>f:param</b> components could be used to add parameters to menu. </p> <p> <b>Example:</b> To call the menu - click any car row. @@ -79,7 +77,7 @@ </ui:include> <p> Pay your attention to the source code. Inside the table you may see component control that calls the menu. - Menu recreated after every call on the client and new <b>{car}</b> and <b>{model}</b> values inserted to the menu. + Menu recreated after every call on the client and new <b>{car}</b> and <b>{model}</b> values are inserted into the menu. </p> <p>Look through componentControl demo page for more information.</p> </ui:define>