Author: ccowens Date: 2007-05-14 17:45:38 -0400 (Mon, 14 May 2007) New Revision: 758 Modified: trunk/docs/userguide/en/included/dragSupport.xml trunk/docs/userguide/en/included/dropDownMenu.desc.xml trunk/docs/userguide/en/included/dropDownMenu.xml trunk/docs/userguide/en/included/menuItem.desc.xml trunk/docs/userguide/en/included/menuItem.xml trunk/docs/userguide/en/included/menuSeparator.desc.xml trunk/docs/userguide/en/included/menuSeparator.xml Log: Modified: trunk/docs/userguide/en/included/dragSupport.xml =================================================================== --- trunk/docs/userguide/en/included/dragSupport.xml 2007-05-14 21:41:59 UTC (rev 757) +++ trunk/docs/userguide/en/included/dragSupport.xml 2007-05-14 21:45:38 UTC (rev 758) @@ -71,7 +71,7 @@ </section> <section> - <title>Dynamical Creation from Java Code</title> + <title>Creating the Component Dynamically from Java</title> <programlisting role="JAVA">import org.richfaces.component.html.HtmlDragSupport; ... Modified: trunk/docs/userguide/en/included/dropDownMenu.desc.xml =================================================================== --- trunk/docs/userguide/en/included/dropDownMenu.desc.xml 2007-05-14 21:41:59 UTC (rev 757) +++ trunk/docs/userguide/en/included/dropDownMenu.desc.xml 2007-05-14 21:45:38 UTC (rev 758) @@ -1,33 +1,55 @@ -<?xml version="1.0" encoding="UTF-8"?> -<section> - <sectioninfo> - <keywordset> - <keyword>dropDownMenu</keyword> - </keywordset> - </sectioninfo> - <section> -<title>Description</title> - <para>The &lt;rich:dropDownMenu&gt; component is used for a multilevel dropdown menu creation.</para> - <figure> - <title>&lt;rich:dropDownMenu&gt; component</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/dropDownMenu1.png" /> - </imageobject> - </mediaobject> - </figure> -</section> -<section> - <title>Key Features</title> - <itemizedlist> - <listitem><para>Highly customizable look and feel</para></listitem> - <listitem><para>Popup appearance event customization</para></listitem> - <listitem><para>Different submission modes</para></listitem> - <listitem><para>Possibility of complex representation elements definition</para></listitem> - <listitem><para>Disablement support</para></listitem> - <listitem><para>Smart and user defined positioning </para></listitem> - </itemizedlist> - -</section> - +<?xml version="1.0" encoding="UTF-8"?> +<section> + <sectioninfo> + <keywordset> + <keyword>dropDownMenu</keyword> + </keywordset> + </sectioninfo> + + <section> + <title>Description</title> + + <para>The &lt;rich:dropDownMenu&gt; component is used for creating + multilevel drop-down menus.</para> + + <figure> + <title>&lt;rich:dropDownMenu&gt; component</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/dropDownMenu1.png" /> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Key Features</title> + + <itemizedlist> + <listitem> + <para>Highly customizable look-and-feel</para> + </listitem> + + <listitem> + <para>Pop-up appearance event customization</para> + </listitem> + + <listitem> + <para>Different submission modes</para> + </listitem> + + <listitem> + <para>Ability to define a complex representation for elements</para> + </listitem> + + <listitem> + <para>Support for disabling</para> + </listitem> + + <listitem> + <para>Smart user-defined positioning</para> + </listitem> + </itemizedlist> + </section> </section> \ No newline at end of file Modified: trunk/docs/userguide/en/included/dropDownMenu.xml =================================================================== --- trunk/docs/userguide/en/included/dropDownMenu.xml 2007-05-14 21:41:59 UTC (rev 757) +++ trunk/docs/userguide/en/included/dropDownMenu.xml 2007-05-14 21:45:38 UTC (rev 758) @@ -1,368 +1,498 @@ <?xml version="1.0" encoding="UTF-8"?> <section> - <sectioninfo> - <keywordset> - <keyword>dropDownMenu</keyword> - </keywordset> - </sectioninfo> - - <table> - <title>Component identification parameters</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Name</entry> - <entry>Value</entry> - </row> - </thead> - <tbody> - <row> - <entry>component-type</entry> - <entry>org.richfaces.DropDownMenu</entry> - </row> - <row> - <entry>component-class</entry> - <entry>org.richfaces.component.html.HtmlDropDownMenu</entry> - </row> - <row> - <entry>component-family</entry> - <entry>org.richfaces.DropDownMenu</entry> - </row> - <row> - <entry>renderer-type</entry> - <entry>org.richfaces.DropDownMenuRenderer</entry> - </row> - <row> - <entry>tag-class</entry> - <entry>org.richfaces.taglib.DropDownMenuTag</entry> - </row> - </tbody> - </tgroup> - </table> - - <section> - <title>Creation on a page</title> - <para>To create the simplest variant on a page use the following syntax:</para> - <programlisting role="xml"><![CDATA[... - <rich:dropDownMenu value="Item1"> - <!--Nested menu components--> - </rich:dropDownMenu> -...]]></programlisting> - </section> - - <section> - <title>Dynamical Creation from Java Code</title> - <programlisting role="java"><![CDATA[... + <sectioninfo> + <keywordset> + <keyword>dropDownMenu</keyword> + </keywordset> + </sectioninfo> + + <table> + <title>Component identification parameters</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + + <entry>Value</entry> + </row> + </thead> + + <tbody> + <row> + <entry>component-type</entry> + + <entry>org.richfaces.DropDownMenu</entry> + </row> + + <row> + <entry>component-class</entry> + + <entry>org.richfaces.component.html.HtmlDropDownMenu</entry> + </row> + + <row> + <entry>component-family</entry> + + <entry>org.richfaces.DropDownMenu</entry> + </row> + + <row> + <entry>renderer-type</entry> + + <entry>org.richfaces.DropDownMenuRenderer</entry> + </row> + + <row> + <entry>tag-class</entry> + + <entry>org.richfaces.taglib.DropDownMenuTag</entry> + </row> + </tbody> + </tgroup> + </table> + + <section> + <title>Creating the Component with a Page Tag</title> + + <para>Here is a simple example in a page:</para> + + <programlisting role="xml">... + &lt;rich:dropDownMenu value="Item1"&gt; + &lt;!--Nested menu components--&gt; + &lt;/rich:dropDownMenu&gt; +...</programlisting> + </section> + + <section> + <title>Creating the Component Dynamically from Java</title> + + <programlisting role="java">... org.richfaces.component.html.HtmlDropDownMenu myMenu = new org.richfaces.component.html.HtmlDropDownMenu(); -...]]></programlisting> - </section> - - <section> - <title>Details of Usage</title> - <para> - All attributes except the &quot;value&quot; are not required. The &quot;value&quot; attribute defines a representation text. - </para> - <para> - Also instead of the &quot;value&quot; attribute you can use the &quot;label&quot; facet. - </para> - <para> - Example. - </para> - <programlisting role="xml"><![CDATA[... - <f:facet name="label"> - <h:graphicImage value="/images/img1.gif"/> - </f:facet> -...]]></programlisting> - <para> - Use the &quot;event&quot; attribute to define an event on the representation element that triggers a menu appearance. An example of a menu appearance on a click could be seen below. - </para> - <programlisting role="xml"><![CDATA[... - <rich:dropDownMenu event="onclick" value="Item1"> - <!--Nested menu components--> - </rich:dropDownMenu> -...]]></programlisting> - <para> - Switching mode could be chosen with the &lt;rich:dropDownMenu&gt; attribute &quot;mode&quot; with three possible parameters. - </para> - <itemizedlist> - <listitem><para>Server (on default)</para></listitem> - </itemizedlist> - <para> - The common submission of a form is performed and a page is completely refreshed. - </para> - <itemizedlist> - <listitem><para>Ajax</para></listitem> - </itemizedlist> - <para> - Ajax form submission is performed, additionally specified elements in the &quot;reRender&quot; attribute are reRendered. - </para> - <itemizedlist> - <listitem><para>None</para></listitem> - </itemizedlist> - <para> - The&quot;action&quot; and &quot;actionListener&quot; item&apos;s attributes are ignored. Menu items don&apos;t fire any submits itself. Behavior is fully defined by the components nested into items. - </para> - <note><title>Note:</title> - As the &lt;rich:dropDownMenu&gt; component doesn&apos;t provide its own form, use it in &lt;form&gt;...&lt;/h:form&gt;. - </note> - <para> - The &quot;direction&quot; and &quot;jointPoint&quot; attributes are used for the definition ways of menu appearance as it&apos;s shown in the example below. - </para> - <para> - Possible values for the &quot;direction&quot; attribute are: - </para> - <itemizedlist> - <listitem><para>top-left - a menu attached to the top-right corner of the label;</para></listitem> - <listitem><para>top-right - a menu attached to the top-left corner of the label;</para></listitem> - <listitem><para>bottom-left - a menu attached to the bottom-right corner of the label;</para></listitem> - <listitem><para>bottom-right - a menu attached to the bottom-left corner of the label;</para></listitem> - <listitem><para>auto - a smart positioning activation.</para></listitem> - </itemizedlist> - <para> - Possible values for the &quot;jointPoint&quot; attribute are: - </para> - <itemizedlist> - <listitem><para>tr - top-right point of the label element;</para></listitem> - <listitem><para>tl - top-left point of the label element;</para></listitem> - <listitem><para>br - bottom-right point of the label element;</para></listitem> - <listitem><para>bl - bottom-left point of the label element;</para></listitem> - <listitem><para>auto - smart positioning activation.</para></listitem> - </itemizedlist> - <para> - On default the &quot;direction&quot; and &quot;jointPoint&quot; attributes define as &quot;auto&quot;. - </para> - <para> - Example. - </para> - <programlisting role="xml"><![CDATA[... - <rich:dropDownMenu value="Item1" direction="bottom-right" jointPoint="tr"> - <!--Nested menu components--> - </rich:dropDownMenu> -...]]></programlisting> - <para> - As a result: - </para> - <figure> - <title>Using the &quot;direction&quot; and &quot;joinPoint&quot; attributes</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/dropDownMenu2.png" /> - </imageobject> - </mediaobject> - </figure> - <para> - You can correct an offset of the popup list relatively to the label using following attributes: &quot;horizontalOffset&quot; and &quot;verticalOffset&quot;. - </para> - <para> - Example. - </para> - <programlisting role="xml"><![CDATA[... - <rich:dropDownMenu value="Item1" direction="bottom-right" jointPoint="tr" horizontalOffset="-15" verticalOffset="0"> - <!--Nested menu components--> - </rich:dropDownMenu> -...]]> +...</programlisting> + </section> + + <section> + <title>Details of Usage</title> + + <para>All attributes except "value" are optional. The "value" attribute + defines text to be represented. If you can use the "label" facet, you can + even not use the "value" attribute.</para> + + <para>Here is an example:</para> + + <programlisting role="xml">... + &lt;f:facet name="label"&gt; + &lt;h:graphicImage value="/images/img1.gif"/&gt; + &lt;/f:facet&gt; +...</programlisting> + + <para>Use the "event" attribute to define an event for the represented + element that triggers a menu appearance. An example of a menu appearance + on a click can be seen below.</para> + + <programlisting role="xml">... + &lt;rich:dropDownMenu event="onclick" value="Item1"&gt; + &lt;!--Nested menu components--&gt; + &lt;/rich:dropDownMenu&gt; +...</programlisting> + + <para>The &lt;rich:dropDownMenu&gt; "mode" attribute can be set to three + possible parameters:</para> + + <itemizedlist> + <listitem> + <para>Server (default)</para> + </listitem> + </itemizedlist> + + <para>The standard form submission is performed and the page is completely + refreshed.</para> + + <itemizedlist> + <listitem> + <para>Ajax</para> + </listitem> + </itemizedlist> + + <para>An AJAX form submission is performed, and specified elements in the + "reRender" attribute are rerendered.</para> + + <itemizedlist> + <listitem> + <para>None</para> + </listitem> + </itemizedlist> + + <para>The "action" and "actionListener" item's attributes are ignored. + Menu items don't fire any submits themselves. The behavior is fully + defined by the components nested inside items.</para> + + <note><title>Note:</title> As the &lt;rich:dropDownMenu&gt; component + doesn't provide its own form, use it between &lt;h:form&gt; and + &lt;/h:form&gt; tags.</note> + + <para>The "direction" and "jointPoint" attributes are used for defining + aspects of menu appearance.</para> + + <para>Possible values for the "direction" attribute are:</para> + + <itemizedlist> + <listitem> + <para>top-left - a menu attached to the top-right corner of the + label</para> + </listitem> + + <listitem> + <para>top-right - a menu attached to the top-left corner of the + label</para> + </listitem> + + <listitem> + <para>bottom-left - a menu attached to the bottom-right corner of the + label</para> + </listitem> + + <listitem> + <para>bottom-right - a menu attached to the bottom-left corner of the + label</para> + </listitem> + + <listitem> + <para>auto - a smart positioning activation</para> + </listitem> + </itemizedlist> + + <para>Possible values for the "jointPoint" attribute are:</para> + + <itemizedlist> + <listitem> + <para>tr - top-right point of the label element</para> + </listitem> + + <listitem> + <para>tl - top-left point of the label element</para> + </listitem> + + <listitem> + <para>br - bottom-right point of the label element</para> + </listitem> + + <listitem> + <para>bl - bottom-left point of the label element</para> + </listitem> + + <listitem> + <para>auto - smart positioning activation</para> + </listitem> + </itemizedlist> + + <para>By default, the "direction" and "jointPoint" attributes are set to + "auto".</para> + + <para>Here is an example:</para> + + <programlisting role="xml">... + &lt;rich:dropDownMenu value="Item1" direction="bottom-right" jointPoint="tr"&gt; + &lt;!--Nested menu components--&gt; + &lt;/rich:dropDownMenu&gt; +...</programlisting> + + <para>This is the result:</para> + + <figure> + <title>Using the "direction" and "joinPoint" attributes</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/dropDownMenu2.png" /> + </imageobject> + </mediaobject> + </figure> + + <para>You can correct an offset of the pop-up list relative to the label + using the following attributes: "horizontalOffset" and + "verticalOffset".</para> + + <para>Here is an example:</para> + + <programlisting role="xml">... + &lt;rich:dropDownMenu value="Item1" direction="bottom-right" jointPoint="tr" horizontalOffset="-15" verticalOffset="0"&gt; + &lt;!--Nested menu components--&gt; + &lt;/rich:dropDownMenu&gt; +... </programlisting> - <para> - As a result: - </para> - <figure> - <title>Using the &quot;horizontalOffset&quot; and &quot;verticalOffset&quot; attributes</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/dropDownMenu3.png" /> - </imageobject> - </mediaobject> - </figure> - </section> - - <section> - <title> Look and Feel Customization</title> - <para> - For skinnability implementation, the components use a style class redefinition method. Default style classes are mapped on skin parameters. - </para> - <para> - There are two ways to redefine appearance of all dropDownMenus at once: - </para> - <itemizedlist> - <listitem><para>Redefine corresponding skin parameters.</para></listitem> - <listitem><para>Add to user&apos;s stylesheets style classes used by a dropDownMenu.</para></listitem> - </itemizedlist> - </section> - <section> - <title>Skin parameters redefinition</title> - <table> - <title>Label Skin parameters redefinition</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Skin parameters for label div element</entry> - <entry>CSS properties</entry> - </row> - </thead> - <tbody> - <row> - <entry>generalFamilyFont</entry> - <entry>font-family</entry> - </row> - <row> - <entry>generalSizeFont</entry> - <entry>font-size</entry> - </row> - </tbody> - </tgroup> - </table> - <table> - <title>Label Skin parameters redefinition</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Skin parameters for selected label element</entry> - <entry>CSS properties</entry> - </row> - </thead> - <tbody> - <row> - <entry>panelBorderColor</entry> - <entry>border-color</entry> - </row> - <row> - <entry>controlBackgroundColor</entry> - <entry>background-color</entry> - </row> - <row> - <entry>generalTextColor</entry> - <entry>background-colorcolor</entry> - </row> - </tbody> - </tgroup> - </table> - <table> - <title>Popup Skin parameters redefinition</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Skin parameters for border element</entry> - <entry>CSS properties</entry> - </row> - </thead> - <tbody> - <row> - <entry>panelBorderColor</entry> - <entry>border-color</entry> - </row> - <row> - <entry>additionalBackgroundColor</entry> - <entry>background-color</entry> - </row> - </tbody> - </tgroup> - </table> - <table> - <title>Popup Skin parameters redefinition</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Skin parameters for background element</entry> - <entry>CSS properties</entry> - </row> - </thead> - <tbody> - <row> - <entry>additionalBackgroundColor</entry> - <entry>border-top-color</entry> - </row> - <row> - <entry>additionalBackgroundColor</entry> - <entry>border-left-color</entry> - </row> - <row> - <entry>additionalBackgroundColor</entry> - <entry>border-right-color</entry> - </row> - </tbody> - </tgroup> - </table> - </section> - <section> - <title> Definition custom style classes </title> - <para> - On the screenshot, there are classes names that define element label. - </para> - <figure> - <title>Classes names</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/dropDownMenu4.png" /> - </imageobject> - </mediaobject> - </figure> - <table> - <title>Classes names that define element label</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Rich-label-text-decor</entry> - <entry>Defines the text style of a representation element</entry> - </row> - <row> - <entry>Rich-ddmenu-label</entry> - <entry>Defines the class for wrapping div element of a representation element</entry> - </row> - <row> - <entry>Rich-ddmenu-label-select</entry> - <entry>Defines the class for wrapping div element of the selected representation element</entry> - </row> - <row> - <entry>Rich-ddmenu-label-unselect</entry> - <entry>Defines the class for wrapping div element of a representation element that isn&apos;t selected</entry> - </row> - </tbody> - </tgroup> - </table> - <para> - On the screenshot, there are classes names that define element popup. - </para> - <figure> - <title>Classes names</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/dropDownMenu5.png" /> - </imageobject> - </mediaobject> - </figure> - <table> - <title>Classes names that define element popup</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Rich-menu-list-border</entry> - <entry>Defines a class for borders elements</entry> - </row> - <row> - <entry>Rich-menu-list-border</entry> - <entry>Defines the class for a general background list</entry> - </row> - </tbody> - </tgroup> - </table> - <para> - In order to redefine style for all dropDownMenus on a page using CSS, it&apos;s enough to create classes with the same names and define the necessary properties in them. - </para> - <para> - To change style peculiarities of the particular dropDownMenus define your own style classes in the corresponding simple dropDownMenu attributes. - </para> - </section> - </section> + <para>This is the result:</para> + + <figure> + <title>Using the "horizontalOffset" and "verticalOffset" + attributes</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/dropDownMenu3.png" /> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Look-and-Feel Customization</title> + + <para>For skinability implementation, the components use a style class + redefinition method. Default style classes are mapped on skin + parameters.</para> + + <para>There are two ways to redefine the appearance of all dropDownMenus + at once:</para> + + <itemizedlist> + <listitem> + <para>Redefine the corresponding skin parameters</para> + </listitem> + + <listitem> + <para>Add to a user's stylesheets style classes used by a + dropDownMenu</para> + </listitem> + </itemizedlist> + </section> + + <section> + <title> Redefinition of Skin Parameters</title> + + <table> + <title>Label Skin parameters redefinition</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Skin parameters for label div element</entry> + + <entry>CSS properties</entry> + </row> + </thead> + + <tbody> + <row> + <entry>generalFamilyFont</entry> + + <entry>font-family</entry> + </row> + + <row> + <entry>generalSizeFont</entry> + + <entry>font-size</entry> + </row> + </tbody> + </tgroup> + </table> + + <table> + <title>Label Skin parameters redefinition</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Skin parameters for selected label element</entry> + + <entry>CSS properties</entry> + </row> + </thead> + + <tbody> + <row> + <entry>panelBorderColor</entry> + + <entry>border-color</entry> + </row> + + <row> + <entry>controlBackgroundColor</entry> + + <entry>background-color</entry> + </row> + + <row> + <entry>generalTextColor</entry> + + <entry>background-colorcolor</entry> + </row> + </tbody> + </tgroup> + </table> + + <table> + <title>Popup Skin parameters redefinition</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Skin parameters for border element</entry> + + <entry>CSS properties</entry> + </row> + </thead> + + <tbody> + <row> + <entry>panelBorderColor</entry> + + <entry>border-color</entry> + </row> + + <row> + <entry>additionalBackgroundColor</entry> + + <entry>background-color</entry> + </row> + </tbody> + </tgroup> + </table> + + <table> + <title>Popup Skin parameters redefinition</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Skin parameters for background element</entry> + + <entry>CSS properties</entry> + </row> + </thead> + + <tbody> + <row> + <entry>additionalBackgroundColor</entry> + + <entry>border-top-color</entry> + </row> + + <row> + <entry>additionalBackgroundColor</entry> + + <entry>border-left-color</entry> + </row> + + <row> + <entry>additionalBackgroundColor</entry> + + <entry>border-right-color</entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Definition of Custom Style Classes</title> + + <para>In the screenshot, there are classes names that define the element + label.</para> + + <figure> + <title>Classes names</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/dropDownMenu4.png" /> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Classes names that define element label</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Class name</entry> + + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Rich-label-text-decor</entry> + + <entry>Defines the text style of a representation element</entry> + </row> + + <row> + <entry>Rich-ddmenu-label</entry> + + <entry>Defines the class for wrapping div element of a + representation element</entry> + </row> + + <row> + <entry>Rich-ddmenu-label-select</entry> + + <entry>Defines the class for wrapping div element of the selected + representation element</entry> + </row> + + <row> + <entry>Rich-ddmenu-label-unselect</entry> + + <entry>Defines the class for wrapping div element of a + representation element that isn't selected</entry> + </row> + </tbody> + </tgroup> + </table> + + <para>In the screenshot, there are classes names that define an element + pop-up.</para> + + <figure> + <title>Classes names</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/dropDownMenu5.png" /> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Classes names that define element popup</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Class name</entry> + + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Rich-menu-list-border</entry> + + <entry>Defines a class for borders elements</entry> + </row> + + <row> + <entry>Rich-menu-list-border</entry> + + <entry>Defines the class for a general background list</entry> + </row> + </tbody> + </tgroup> + </table> + + <para>In order to redefine the style for all drop-down menus on a page + using CSS, it's enough to create classes with the same names and define + the necessary properties in them.</para> + + <para>To change the style peculiarities of the particular drop-down menus + define your own style classes in the corresponding dropDownMenu + attributes.</para> + </section> +</section> \ No newline at end of file Modified: trunk/docs/userguide/en/included/menuItem.desc.xml =================================================================== --- trunk/docs/userguide/en/included/menuItem.desc.xml 2007-05-14 21:41:59 UTC (rev 757) +++ trunk/docs/userguide/en/included/menuItem.desc.xml 2007-05-14 21:45:38 UTC (rev 758) @@ -7,7 +7,7 @@ </sectioninfo> <section> <title>Description</title> - <para>The <emphasis role="bold">&lt;rich:menuItem&gt;</emphasis> component is used for definition the single item inside of popup list.</para> + <para>The <emphasis role="bold">&lt;rich:menuItem&gt;</emphasis> component is used for the definition of a single item inside a pop-up list.</para> <figure> <title>&lt;rich:menuItem&gt; component</title> <mediaobject> @@ -20,9 +20,9 @@ <section> <title>Key Features</title> <itemizedlist> - <listitem><para>Highly customizable look and feel</para></listitem> + <listitem><para>Highly customizable look-and-feel</para></listitem> <listitem><para>Different submission modes</para></listitem> - <listitem><para>Disablement support</para></listitem> + <listitem><para>Support for disabling</para></listitem> <listitem><para>Custom content support</para></listitem> </itemizedlist> Modified: trunk/docs/userguide/en/included/menuItem.xml =================================================================== --- trunk/docs/userguide/en/included/menuItem.xml 2007-05-14 21:41:59 UTC (rev 757) +++ trunk/docs/userguide/en/included/menuItem.xml 2007-05-14 21:45:38 UTC (rev 758) @@ -41,8 +41,8 @@ </table> <section> - <title>Creation on a page</title> - <para>To create the simplest variant on a page use the following syntax:</para> + <title>Creating the Component with a Page Tag</title> + <para>Here is a simple example in a page:</para> <programlisting role="xml"><![CDATA[... <rich:dropDownMenu> ... @@ -53,7 +53,7 @@ </section> <section> - <title>Dynamical Creation from Java Code</title> + <title>Creating the Component Dynamically from Java</title> <programlisting role="java"><![CDATA[... org.richfaces.component.html.HtmlMenuItem myItem = new org.richfaces.component.html.HtmlMenuItem (); ...]]></programlisting> @@ -62,13 +62,13 @@ <section> <title>Details of Usage</title> <para> - The &quot;value&quot; attribute defines text representation for an item element. + The &quot;value&quot; attribute defines the text representation for an item element. </para> <para> - The &quot;icon&quot; attribute defines an icon. The &quot;iconDisabled&quot; attribute defines an icon for a disabled item. Also you can use the &quot;icon&quot; and &quot;iconDisabled&quot; facets. If the facets are defined, the corresponding &quot;icon&quot; and &quot;iconDisabled&quot; attributes are ignored and the facets content is shown as an icon. It could be used for items checkboxes implementation. + There are two icon-related attributes. The &quot;icon&quot; attribute defines an icon. The &quot;iconDisabled&quot; attribute defines an icon for a disabled item. Also you can use the &quot;icon&quot; and &quot;iconDisabled&quot; facets. If the facets are defined, the corresponding &quot;icon&quot; and &quot;iconDisabled&quot; attributes are ignored and the facets content is shown as an icon. It could be used for an item check box implementation. </para> <para> - Example. + Here is an example: </para> <programlisting role="xml"><![CDATA[... <f:facet name="icon"> @@ -76,32 +76,41 @@ </f:facet> ...]]></programlisting> + <para>The &lt;rich: menuItem&gt; "mode" attribute can be set to three + possible parameters:</para> + + <itemizedlist> + <listitem> + <para>Server (default)</para> + </listitem> + </itemizedlist> + + <para>The standard form submission is performed and the page is completely + refreshed.</para> + + <itemizedlist> + <listitem> + <para>Ajax</para> + </listitem> + </itemizedlist> + + <para>An AJAX form submission is performed, and specified elements in the + "reRender" attribute are rerendered.</para> + + <itemizedlist> + <listitem> + <para>None</para> + </listitem> + </itemizedlist> + + <para>The "action" and "actionListener" item's attributes are ignored. + Menu items don't fire any submits themselves. The behavior is fully + defined by the components nested inside items.</para> <para> - A switching mode could be chosen with the &lt;rich: menuItem&gt; attribute &quot;mode&quot; with three possible parameters. + For example, you can put any content into an item, but, in this case, you should set the &quot;mode&quot; attribute as &quot;none&quot;. </para> - <itemizedlist> - <listitem><para>Server (on default)</para></listitem> - </itemizedlist> <para> - The common submission of the form is performed and a page is completely refreshed. - </para> - <itemizedlist> - <listitem><para>Ajax</para></listitem> - </itemizedlist> - <para> - Ajax form submission is performed, additionally specified elements in the &quot;reRender&quot; attribute are reRendered. - </para> - <itemizedlist> - <listitem><para>None</para></listitem> - </itemizedlist> - <para> - The &quot;action&quot; and &quot;actionListener&quot; items attributes are ignored. Menu items don&apos;t fire any submits itself. Behavior is fully defined by components nested to items. - </para> - <para> - For example, you can put any content into an item but in this case you should set the &quot;mode&quot; attribute as &quot;none&quot;. - </para> - <para> - Example. + Here is an example: </para> <programlisting role="xml"><![CDATA[... <rich:dropDownMenu> @@ -113,10 +122,10 @@ <rich:dropDownMenu> ...]]></programlisting> <para> - You can use the &quot;disabled&quot; attribute to set item state. + You can use the &quot;disabled&quot; attribute to set the item state. </para> <para> - Example. + Here is an example: </para> <programlisting role="xml"><![CDATA[... <rich:dropDownMenu> @@ -126,22 +135,22 @@ </section> <section> - <title> Look and Feel Customization</title> + <title> Look-and-Feel Customization</title> <para> - For skinnability implementation, the components use a style class redefinition method. Default style classes are mapped on skin parameters. + For skinability implementation, the components use a style class redefinition method. Default style classes are mapped on skin parameters. </para> <para> - There are two ways to redefine appearance of all menuItems at once: + There are two ways to redefine the appearance of all menuItems at once: </para> <itemizedlist> - <listitem><para>Redefine corresponding skin parameters.</para></listitem> - <listitem><para>Add to user&apos;s stylesheets style classes used by a menuItem.</para></listitem> + <listitem><para>Redefine the corresponding skin parameters</para></listitem> + <listitem><para>Add to user&apos;s stylesheets style classes used by a menuItem</para></listitem> </itemizedlist> </section> <section> <title>Skin parameters redefinition</title> <table> - <title>Label Skin parameters redefinition</title> + <title>Label skin parameters redefinition</title> <tgroup cols="2"> <thead> <row> @@ -163,7 +172,7 @@ </table> <table> - <title>Label Skin parameters redefinition</title> + <title>Label skin parameters redefinition</title> <tgroup cols="2"> <thead> <row> @@ -185,7 +194,7 @@ </table> <table> - <title>Label Skin parameters redefinition</title> + <title>Label skin parameters redefinition</title> <tgroup cols="2"> <thead> <row> @@ -203,7 +212,7 @@ </table> <table> - <title>Label Skin parameters redefinition</title> + <title>Label skin parameters redefinition</title> <tgroup cols="2"> <thead> <row> @@ -222,12 +231,12 @@ </section> <section> - <title> Definition custom style classes </title> + <title> Definition of Custom Style Classes </title> <para> - On the screenshot, there are classes names that define item element appearance. + In the screenshot, the classes names that define item element appearance are shown. </para> <figure> - <title>Classes names</title> + <title>Class names</title> <mediaobject> <imageobject> <imagedata fileref="images/menuItem2.png" /> @@ -235,7 +244,7 @@ </mediaobject> </figure> <table> - <title>Classes names that define item element appearance.</title> + <title>Class names that define item element appearance.</title> <tgroup cols="2"> <thead> <row> @@ -260,10 +269,10 @@ </tgroup> </table> <para> - All listed elements except of general are defined for disabled, enabled and hovered modes. + All listed elements except the general ones are defined for disabled, enabled, and hovered modes. </para> <table> - <title>Classes names for modes</title> + <title>Class names for modes</title> <tgroup cols="2"> <thead> <row> @@ -306,17 +315,17 @@ <entry>Defines properties for the text</entry> </row> <row> - <entry>Rich-menu-item-icon-selectedr</entry> + <entry>Rich-menu-item-icon-selected</entry> <entry>Defines properties for the left icon element</entry> </row> </tbody> </tgroup> </table> <para> - In order to redefine style for all menuItems on a page using CSS, it&apos;s enough to create classes with the same names and define the necessary properties in them. + In order to redefine the style for all menuItems on a page using CSS, it&apos;s enough to create classes with the same names and define the necessary properties in them. </para> <para> - To change style peculiarities of the particular menuItems define your own style classes in the corresponding simple menuItem attributes. + To change the style of particular menuItems define your own style classes in the corresponding menuItem attributes. </para> </section> </section> Modified: trunk/docs/userguide/en/included/menuSeparator.desc.xml =================================================================== --- trunk/docs/userguide/en/included/menuSeparator.desc.xml 2007-05-14 21:41:59 UTC (rev 757) +++ trunk/docs/userguide/en/included/menuSeparator.desc.xml 2007-05-14 21:45:38 UTC (rev 758) @@ -7,7 +7,7 @@ </sectioninfo> <section> <title>Description</title> - <para>The &lt;rich:menuSeparator&gt; component is used for definition of a horizontal separator that can be placed between groups or items.</para> + <para>The &lt;rich:menuSeparator&gt; component is used for the definition of a horizontal separator that can be placed between groups or items.</para> <figure> <title>&lt;rich:menuSeparator&gt;</title> <mediaobject> Modified: trunk/docs/userguide/en/included/menuSeparator.xml =================================================================== --- trunk/docs/userguide/en/included/menuSeparator.xml 2007-05-14 21:41:59 UTC (rev 757) +++ trunk/docs/userguide/en/included/menuSeparator.xml 2007-05-14 21:45:38 UTC (rev 758) @@ -41,8 +41,8 @@ </table> <section> - <title>Creation on a page</title> - <para>To create the simplest variant on a page use the following syntax:</para> + <title>Creating the Component with a Page Tag</title> + <para>Here is a simple example in a page:</para> <programlisting role="xml"><![CDATA[... <rich:dropDownMenu/> ... @@ -53,29 +53,29 @@ </section> <section> - <title>Dynamical Creation from Java Code</title> + <title>Creating the Component Dynamically from Java</title> <programlisting role="java"><![CDATA[... org.richfaces.component.html.HtmlMenuSeparator mySep = new org.richfaces.component.html.HtmlMenuSeparator (); ...]]></programlisting> </section> <section> - <title> Look and Feel Customization</title> + <title>Look-and-Feel Customization</title> <para> - For skinnability implementation, the components use a style class redefinition method. Default style classes are mapped on skin parameters. + For skinability implementation, the components use a style class redefinition method. Default style classes are mapped on skin parameters. </para> <para> - There are two ways to redefine appearance of all menuSeparators at once: + There are two ways to redefine the appearance of all menuSeparators at once: </para> <itemizedlist> - <listitem><para>Redefine corresponding skin parameters.</para></listitem> - <listitem><para>Add to user&apos;s stylesheets style classes used by a menuSeparator.</para></listitem> + <listitem><para>Redefine the corresponding skin parameters</para></listitem> + <listitem><para>Add to user&apos;s stylesheets style classes used by a menuSeparator</para></listitem> </itemizedlist> </section> <section> - <title>Skin parameters redefinition</title> + <title>Redefinition of Skin Parameters</title> <table> - <title>Label Skin parameters redefinition</title> + <title>Label skin parameters redefinition</title> <tgroup cols="2"> <thead> <row> @@ -93,9 +93,9 @@ </table> </section> <section> - <title> Definition custom style classes </title> + <title>Definition of Custom Style Classes</title> <para> - On the screenshot, there are classes names that define separator element appearance. + In the screenshot, there are the classes names that define separator element appearance. </para> <figure> <title>Classes names</title> @@ -123,10 +123,10 @@ </tgroup> </table> <para> - In order to redefine style for all menuSeparators on a page using CSS, it&apos;s enough to create classes with the same names and define the necessary properties in them. + In order to redefine a style for all menuSeparators in a page using CSS, it&apos;s enough to create classes with the same names and define the necessary properties in them. </para> <para> - To change style peculiarities of the particular menuSeparators define your own style classes in the corresponding simple menuSeparator attributes. + To change the style peculiarities of the particular menuSeparators, define your own style classes in the corresponding menuSeparator attributes. </para> </section> </section>