[richfaces-svn-commits] JBoss Rich Faces SVN: r670 - trunk/docs/userguide/en/included.

Author: smukhina Date: 2007-05-07 09:35:11 -0400 (Mon, 07 May 2007) New Revision: 670 Added: trunk/docs/userguide/en/included/dropDownMenu.desc.xml trunk/docs/userguide/en/included/dropDownMenu.xml trunk/docs/userguide/en/included/menuGroup.desc.xml trunk/docs/userguide/en/included/menuGroup.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: Added: trunk/docs/userguide/en/included/dropDownMenu.desc.xml =================================================================== --- trunk/docs/userguide/en/included/dropDownMenu.desc.xml (rev 0) +++ trunk/docs/userguide/en/included/dropDownMenu.desc.xml 2007-05-07 13:35:11 UTC (rev 670) @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <sectioninfo> + - <keywordset> + <keyword>dropDownMenu</keyword> + </keywordset> + </sectioninfo> + + <para>The &lt;rich:dropDownMenu&gt; component is used for creation multilevel dropdown menu.</para> + <figure> + <title>&lt;rich:dropDownMenu&gt; component</title> + - <mediaobject> + - <imageobject> + <imagedata fileref="images/dropDownMenu1.gif" /> + </imageobject> + </mediaobject> + </figure> + +<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 definition of complex representation elements</para></listitem> + <listitem><para>Disablement support</para></listitem> + <listitem><para>Smart and user defined positioning </para></listitem> + </itemizedlist> + +</section> + +</section> \ No newline at end of file Added: trunk/docs/userguide/en/included/dropDownMenu.xml =================================================================== --- trunk/docs/userguide/en/included/dropDownMenu.xml (rev 0) +++ trunk/docs/userguide/en/included/dropDownMenu.xml 2007-05-07 13:35:11 UTC (rev 670) @@ -0,0 +1,384 @@ +<?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[ + ... + 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 representation text. + </para> + <para> + Also instead of &quot;value&quot; attribute you can use &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 &quot;event&quot; attribute to define the event on the representation element that triggers the menu&apos;s appearance. The example of appearance menu by click see 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 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> + &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 to items. + </para> + <note><title>Note:</title> + As the &lt;rich:dropDownMenu&gt; component do not provide 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&apos;s 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 – menu attached to top-right corner of the label;</para></listitem> + <listitem><para>top-right – menu attached to top-left corner of the label;</para></listitem> + <listitem><para>bottom-left – menu attached to bottom-right corner of the label;</para></listitem> + <listitem><para>bottom-right – menu attached to bottom-left corner of the label;</para></listitem> + <listitem><para>auto – smart positioning activated.</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 activated.</para></listitem> + </itemizedlist> + <para> + On default the &quot;direction&quot; and &quot;jointPoint&quot; attributes define as "auto". + </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 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> + <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> + Skin parameters redefinition: + </para> + <para> + For skinnability implementation the components uses style class redefinition method. Default style classes are mapped on skin parameters. + </para> + <para> + To redefine appearance of all dropDownMenus at once there are two ways: + </para> + <itemizedlist> + <listitem><para>Redefine corresponding skin parameters.</para></listitem> + <listitem><para>Add to user&apos;s stylesheets style classes used by panel.</para></listitem> + </itemizedlist> + <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&apos; names that define element label. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/dropDownMenu4.png" /> + </imageobject> + </mediaobject> + <table> + <title>Classes&apos; 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 representation element</entry> + </row> + <row> + <entry>Rich-ddmenu-label</entry> + <entry>Defines the class for wrapping div element at representation element</entry> + </row> + <row> + <entry>Rich-ddmenu-label-select</entry> + <entry>Defines the class for wrapping div element at selected representation element</entry> + </row> + <row> + <entry>Rich-ddmenu-label-unselect</entry> + <entry>Defines the class for wrapping div element at not selected representation element</entry> + </row> + </tbody> + </tgroup> + </table> + <para> + On the screenshot, there are classes&apos; names that define element popup. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/dropDownMenu5.gif" /> + </imageobject> + </mediaobject> + <table> + <title>Classes&apos; 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 the class for elements of borders</entry> + </row> + <row> + <entry>Rich-menu-list-border</entry> + <entry>Defines the class for general background list</entry> + </row> + </tbody> + </tgroup> + </table> + <para> + In order to redefine style for all &lt;dropDownMenus&gt; on the page with using CSS it&apos;s enough to create classes with the same names and define in its necessary properties. + </para> + <para> + To change style peculiarities of the particular &lt;dropDownMenus&gt; define your own style classes in the corresponding simple toggle panels attributes. + </para> + </section> + </section> + Added: trunk/docs/userguide/en/included/menuGroup.desc.xml =================================================================== --- trunk/docs/userguide/en/included/menuGroup.desc.xml (rev 0) +++ trunk/docs/userguide/en/included/menuGroup.desc.xml 2007-05-07 13:35:11 UTC (rev 670) @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <sectioninfo> + - <keywordset> + <keyword>menuGroup</keyword> + </keywordset> + </sectioninfo> + + <para>The &lt;rich:menuGroup&gt; component is used for definition an expandable group of items inside of popup list or another group.</para> + <figure> + <title>&lt;rich:menuGroup&gt; component</title> + - <mediaobject> + - <imageobject> + <imagedata fileref="images/menuGroup1.png" /> + </imageobject> + </mediaobject> + </figure> + +<section> + <title>Key Features</title> + <itemizedlist> + <listitem><para>Highly customizable look and feel</para></listitem> + <listitem><para>Grouping any menu's items set</para></listitem> + <listitem><para>Popup appearance event customization</para></listitem> + <listitem><para>Disablement support</para></listitem> + <listitem><para>Smart and user defined positioning</para></listitem> + </itemizedlist> + +</section> + +</section> \ No newline at end of file Added: trunk/docs/userguide/en/included/menuGroup.xml =================================================================== --- trunk/docs/userguide/en/included/menuGroup.xml (rev 0) +++ trunk/docs/userguide/en/included/menuGroup.xml 2007-05-07 13:35:11 UTC (rev 670) @@ -0,0 +1,131 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <sectioninfo> + <keywordset> + <keyword>menuGroup</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.MenuGroup</entry> + </row> + <row> + <entry>component-class</entry> + <entry>oorg.richfaces.component.html.HtmlMenuGroup</entry> + </row> + <row> + <entry>component-family</entry> + <entry>org.richfaces.DropDownMenu</entry> + </row> + <row> + <entry>renderer-type</entry> + <entry>org.richfaces.MenuGroupRenderer</entry> + </row> + <row> + <entry>tag-class</entry> + <entry>org.richfaces.taglib.MenuGroupTag</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="Active"> + ... + <rich: menuGroup value="Active"> + <!—Nested menu components--> + </rich:menuGroup> + ... + </rich:dropDownMenu > + ... + ]]> + </programlisting> + </section> + + <section> + <title>Dynamical Creation from Java Code</title> + <programlisting role="java"> + <![CDATA[ + ... + org.richfaces.component.html.HtmlMenuGroup myGroup = new org.richfaces.component.html.HtmlMenuGroup (); + ... + ]]> + </programlisting> + </section> + + <section> + <title>Details of Usage</title> + <para> + The &quot;value&quot; attribute defines representation text of the group element on the page. + </para> + <para> + The &quot;icon&quot; attribute defines an icon. The &quot;iconDisabled&quot; attribute defines an icon for disabled group. Also you can use the &quot;icon&quot; and &quot;iconDisabled&quot; facets. If the facets are defined, corresponding of the &quot;icon&quot; and &quot;iconDisabled&quot; attributes are ignored and facets content is shown as icon. You can use it for realization checkboxes for groups. + </para> + <para> + Example. + </para> + <programlisting role="xml"> + <![CDATA[ + ... + <f:facet name="icon"> + <h:selectBooleanCheckbox value="#{bean.property}"/> + </f:facet> + ... + ]]> + </programlisting> + <para> + The &quot;iconFolder&quot; and &quot;iconFolderDisabled&quot; attributes are defined for using icons as folder icon. The &quot;iconFolder&quot; and &quot;iconFolderDisabled&quot; facets use content as folder icon representation. + </para> + <para> + The &quot;direction&quot; attribute is used for the definition ways of menu&apos;s appearance as it&apos;s shown in the example below. + </para> + <para>Possible values are:</para> + <itemizedlist> + <listitem><para>left – submenu attached to left side of the menu;</para></listitem> + <listitem><para>right – submenu attached to right side of the menu;</para></listitem> + <listitem><para>auto – smart positioning activated.</para></listitem> + </itemizedlist> + <para> + On default the &quot;direction&quot; attribute defines as &quot;auto&quot;. + </para> + <para> + + </para> + <programlisting role="xml"> + <![CDATA[ + ... + <rich:menuGroup value="Active" direction="left" + <!—Nested menu components--> + </rich:menuGroup> + ... + ]]> + </programlisting> + <para> + As a result: + </para> + <figure> + <title>Using the &quot;direction&quot; attribute</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/menuGroup2.png" /> + </imageobject> + </mediaobject> + </figure> + </section> + </section> Added: trunk/docs/userguide/en/included/menuItem.desc.xml =================================================================== --- trunk/docs/userguide/en/included/menuItem.desc.xml (rev 0) +++ trunk/docs/userguide/en/included/menuItem.desc.xml 2007-05-07 13:35:11 UTC (rev 670) @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <sectioninfo> + <keywordset> + <keyword>menuItem</keyword> + </keywordset> + </sectioninfo> + + <para>The &lt;rich:menuItem&gt; component is used for definition the single item inside of popup list.</para> + <figure> + <title>&lt;rich:menuItem&gt; component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/menuItem1.png" /> + </imageobject> + </mediaobject> + </figure> + +<section> + <title>Key Features</title> + <itemizedlist> + <listitem><para>Highly customizable look and feel</para></listitem> + <listitem><para>Different submission modes</para></listitem> + <listitem><para>Disablement support</para></listitem> + <listitem><para>Custom content support</para></listitem> + </itemizedlist> + +</section> + +</section> \ No newline at end of file Added: trunk/docs/userguide/en/included/menuItem.xml =================================================================== --- trunk/docs/userguide/en/included/menuItem.xml (rev 0) +++ trunk/docs/userguide/en/included/menuItem.xml 2007-05-07 13:35:11 UTC (rev 670) @@ -0,0 +1,147 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <sectioninfo> + <keywordset> + <keyword>menuItem</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.MenuItem</entry> + </row> + <row> + <entry>component-class</entry> + <entry>org.richfaces.component.html.HtmlMenuItem</entry> + </row> + <row> + <entry>component-family</entry> + <entry>org.richfaces.DropDownMenu</entry> + </row> + <row> + <entry>renderer-type</entry> + <entry>org.richfaces.MenuItemRenderer</entry> + </row> + <row> + <entry>tag-class</entry> + <entry>org.richfaces.taglib.MenuItemTag</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> + ... + <rich:menuItem value="Active"/> + ... + <rich:dropDownMenu> + ... + ]]> + </programlisting> + </section> + + <section> + <title>Dynamical Creation from Java Code</title> + <programlisting role="java"> + <![CDATA[ + ... + org.richfaces.component.html.HtmlMenuItem myItem = new org.richfaces.component.html.HtmlMenuItem (); + ... + ]]> + </programlisting> + </section> + + <section> + <title>Details of Usage</title> + <para> + The &quot;Value&quot; attribute defines representation text for the item element. + </para> + <para> + The &quot;Icon&quot; attribute defines icon. The &quot;IconDisabled&quot; attribute defines icon for disabled item. Also you can use the &quot;Icon&quot; and &quot;IconDisabled&quot; facets. If the facets are defined, corresponding of the &quot;Icon&quot; and &quot;IconDisabled&quot; attributes are ignored and facets content is shown as icon. You can use it for realization checkboxes for items. + </para> + <para> + Example. + </para> + <programlisting role="xml"> + <![CDATA[ + ... + <f:facet name="icon"> + <h:selectBooleanCheckbox value="#{bean.property}"/> + </f:facet> + ... + ]]> + </programlisting> + + <para> + Switching mode could be chosen with the &lt;rich: menuItem&gt; attribute &quot;Mode&quot; with three possible parameters. + </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> + &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 to items. + </para> + <para> + For example you can put any content into the item. In this case you should set the &quot;Mode&quot; attribute as &quot;none&quot;. + </para> + <para> + Example. + </para> + <programlisting role="xml"> + <![CDATA[ + ... + <rich:dropDownMenu> + ... + <rich:menuItem submitMode="none"> + <h:outputLink value=”www.jboss.org”/> + </rich:menuItem> + ... + <rich:dropDownMenu> + ... + ]]> + </programlisting> + <para> + You can use &quot;Disabled&quot; attribute to set item&apos;s state. + </para> + <para> + Example. + </para> + <programlisting role="xml"> + <![CDATA[ + ... + <rich:dropDownMenu> + <rich:menuItem value="Disable" disabled="true"/> + <rich:dropDownMenu> + ... + ]]> + </programlisting> + </section> + </section> Added: trunk/docs/userguide/en/included/menuSeparator.desc.xml =================================================================== --- trunk/docs/userguide/en/included/menuSeparator.desc.xml (rev 0) +++ trunk/docs/userguide/en/included/menuSeparator.desc.xml 2007-05-07 13:35:11 UTC (rev 670) @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <sectioninfo> + <keywordset> + <keyword>menuSeparator</keyword> + </keywordset> + </sectioninfo> + + <para>The &lt;rich:menuSeparator&gt; component is used for definition horizontal separator that can be placed between groups or items.</para> + <figure> + <title>&lt;rich:menuSeparator&gt;</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/menuSeparator1.png" /> + </imageobject> + </mediaobject> + </figure> +</section> \ No newline at end of file Added: trunk/docs/userguide/en/included/menuSeparator.xml =================================================================== --- trunk/docs/userguide/en/included/menuSeparator.xml (rev 0) +++ trunk/docs/userguide/en/included/menuSeparator.xml 2007-05-07 13:35:11 UTC (rev 670) @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <sectioninfo> + <keywordset> + <keyword>menuseparator</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.MenuSeparator</entry> + </row> + <row> + <entry>component-class</entry> + <entry>org.richfaces.component.html.HtmlMenuSeparator</entry> + </row> + <row> + <entry>component-family</entry> + <entry>org.richfaces.DropDownMenu</entry> + </row> + <row> + <entry>renderer-type</entry> + <entry>org.richfaces.MenuSeparatorRenderer</entry> + </row> + <row> + <entry>tag-class</entry> + <entry>org.richfaces.taglib.MenuSeparatorTag</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/> + ... + <rich: menuSeparator/> + ... + <rich:dropDownMenu/> + ... + ]]> + </programlisting> + </section> + + <section> + <title>Dynamical Creation from Java Code</title> + <programlisting role="java"> + <![CDATA[ + ... + org.richfaces.component.html.HtmlMenuSeparator mySep = new org.richfaces.component.html.HtmlMenuSeparator (); + ... + ]]> + </programlisting> + </section> +</section>