[richfaces-svn-commits] JBoss Rich Faces SVN: r2053 - trunk/docs/userguide/en/src/main/docbook/included.

richfaces-svn-commits at lists.jboss.org richfaces-svn-commits at lists.jboss.org
Fri Aug 3 11:55:47 EDT 2007


Author: vkorluzhenko
Date: 2007-08-03 11:55:47 -0400 (Fri, 03 Aug 2007)
New Revision: 2053

Added:
   trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.desc.xml
   trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml
   trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.desc.xml
   trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.xml
Modified:
   trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml
   trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml
Log:
http://jira.jboss.com/jira/browse/RF-444
http://jira.jboss.com/jira/browse/RF-448

Modified: trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml	2007-08-03 15:25:47 UTC (rev 2052)
+++ trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml	2007-08-03 15:55:47 UTC (rev 2053)
@@ -133,11 +133,11 @@
             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 the appearance of all menuGroups at once:
+            There are two ways to redefine the appearance of all panelMenuGroups at once:
         </para>
         <itemizedlist>
             <listitem><para>Redefine corresponding skin parameters</para></listitem>
-            <listitem><para>Add to user&apos;s styles heet style classes used by a menuGroup</para></listitem>
+            <listitem><para>Add to user&apos;s styles heet style classes used by a panelMenuGroup</para></listitem>
         </itemizedlist>
        </section>
        <section>
@@ -271,10 +271,10 @@
         </tgroup>
     </table>
     <para>
-        In order to redefine the style for all menuGroups 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 panelMenuGroups 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 aspects of particular menuGroups define your own style classes in the corresponding menuGroup attributes.
+        To change style aspects of particular panelMenuGroups define your own style classes in the corresponding panelMenuGroup attributes.
     </para>
 </section>
 </section>

Modified: trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml	2007-08-03 15:25:47 UTC (rev 2052)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml	2007-08-03 15:55:47 UTC (rev 2053)
@@ -2,7 +2,7 @@
 <section>
   <sectioninfo>
     <keywordset>
-      <keyword>dropDownMenu</keyword>
+      <keyword>panelMenu</keyword>
     </keywordset>
   </sectioninfo>
 
@@ -181,7 +181,7 @@
 
   <section>
     <title>JavaScript API</title>
-    <para>In Java Script code for expanding/collapsing group element creation it’s necessary to use
+    <para>In Java Script code for expanding/collapsing group element creation it&apos;s necessary to use
       doExpand()/doCollapse() function.</para>
 
     <table>

Added: trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.desc.xml	                        (rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.desc.xml	2007-08-03 15:55:47 UTC (rev 2053)
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section>
+    <sectioninfo>
+        <keywordset>
+            <keyword>panelMenuGroup</keyword>
+        </keywordset>
+    </sectioninfo>
+    <section>
+        <para>The <emphasis role="bold">
+                <property>&lt;rich:panelMenuGroup&gt;</property>
+        </emphasis> component is used to define an expandable group of items inside the panel menu or other group.</para>
+
+        <mediaobject>
+            <imageobject>
+                <imagedata fileref="images/panelmenu.png"/>
+            </imageobject>
+        </mediaobject>
+    </section>
+    <section>
+        <title>Key Features</title>
+        <itemizedlist>
+            <listitem>Highly customizable look-and-feel</listitem>
+            <listitem>Different submission modes inside every group</listitem>
+            <listitem>Optional submissions on expand collapse groups</listitem>
+            <listitem>Custom and predefined icons supported</listitem>
+            <listitem>Support for disabling</listitem>
+        </itemizedlist>
+    </section>
+</section>

Added: trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml	                        (rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml	2007-08-03 15:55:47 UTC (rev 2053)
@@ -0,0 +1,432 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section>
+  <sectioninfo>
+    <keywordset>
+      <keyword>panelMenuGroup</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.PanelMenuGroup</entry>
+        </row>
+
+        <row>
+          <entry>component-class</entry>
+
+          <entry>org.richfaces.component.html.HtmlPanelMenuGroup</entry>
+        </row>
+
+        <row>
+          <entry>component-family</entry>
+
+          <entry>org.richfaces.PanelMenuGroup</entry>
+        </row>
+
+        <row>
+          <entry>renderer-type</entry>
+
+          <entry>org.richfaces.PanelMenuGroupRenderer</entry>
+        </row>
+
+        <row>
+          <entry>tag-class</entry>
+
+          <entry>org.richfaces.taglib.PanelMenuGroupTag</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </table>
+
+  <section>
+    <title>Creating the Component with a Page Tag</title>
+
+    <para>To create the simplest variant on the page use the following syntax:</para>
+
+
+    <para>
+      <emphasis role="bold">Example:</emphasis>
+    </para>
+    <programlisting role="xml">...
+      &lt;rich:panelMenu&gt;
+            &lt;rich:panelMenuGroup label="Group1"&gt;
+                  &lt;!--Nested panelMenu components--&gt;
+            &lt;/rich:panelMenuGroup&gt;
+      &lt;/rich:panelMenu&gt;
+...</programlisting>
+  </section>
+
+  <section>
+    <title>Creating the Component Dynamically Using Java</title>
+
+    <para>
+      <emphasis role="bold">Example:</emphasis>
+    </para>
+    <programlisting role="java">...
+      org.richfaces.component.html.HtmlPanelMenuGroup mypanelMenuGroup = new  org.richfaces.component.html.HtmlPanelMenuGroup();
+...</programlisting>
+  </section>
+
+  <section>
+    <title>Details of Usage</title>
+
+    <para>All attributes except &quot;label&quot; are optional. The
+      &quot;label&quot; attribute defines text to be represented.</para>
+    <para>Switching mode could be chosen with the &quot;expandMode&quot; attribute for the
+      concrete panelMenu group.</para>
+    <para>The &quot;expandMode&quot; attribute could be used with three possible parameters:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>Server (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; attributes are ignored.
+      Items don&apos;t fire any submits itself. Behavior is fully defined by the components
+      nested to items.</para>
+
+    <para>There are three icon-related attributes. The &quot;iconExpanded&quot; attribute
+      defines an icon for an expanded state. The &quot;iconCollapsed&quot; attribute defines
+      an icon for a collapsed state. The &quot;iconDisabled&quot; attribute defines an icon
+      for a disabled state.</para>
+
+    <para>Default icons are shown on the picture below:</para>
+
+    <figure>
+      <title>Default icons</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/panelMenuGroup_icons.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+    <para>Here is an example:</para>
+
+    <para>
+      <emphasis role="bold">Example:</emphasis>
+    </para>
+    <programlisting role="xml">...
+      &lt;rich:panelMenu&gt;
+            &lt;rich:panelMenuGroup label="Group1" iconExpanded="disc" iconCollapsed="chevron"&gt;
+                  &lt;!--Nested panelMenu components--&gt;
+            &lt;/rich:panelMenuGroup&gt;
+      &lt;/rich:panelMenu&gt;
+...</programlisting>
+    <para> As the result the pictures are shown below. The first one represents the collapsed state,
+      the second one - expanded state:</para>
+
+    <figure>
+      <title>Collapsed state</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/panelmenugroup_col.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+    <figure>
+      <title>Expanded state</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/panelmenugroup_exp.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+    <para>It&apos;s also possible to define a path to the icon. Simple code is placed below.</para>
+
+    <programlisting role="xml">...
+      &lt;rich:panelMenu&gt;
+            &lt;rich:panelMenuGroup label="Group1" iconExpanded="\images\img1.gif" iconCollapsed=""\images\img2.gif""&gt;
+                  &lt;!--Nested menu components--&gt;
+            &lt;/rich:panelMenuGroup&gt;
+      &lt;/rich:panelMenu&gt;
+...</programlisting>
+
+  </section>
+
+  <section>
+    <title>JavaScript API</title>
+    <para>In Java Script code for expanding/collapsing group element creation it&apos;s
+      necessary to use doExpand()/doCollapse() function.</para>
+
+    <table>
+      <title>JavaScript API</title>
+
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Function</entry>
+
+            <entry>Description</entry>
+          </row>
+        </thead>
+
+        <tbody>
+          <row>
+            <entry>doExpand()</entry>
+
+            <entry>Expand group element</entry>
+          </row>
+
+          <row>
+            <entry>doCollapse()</entry>
+
+            <entry>Collapse group element</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+
+  </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 the appearance of all panel menu groups at once:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>Redefine the corresponding skin parameters</para>
+      </listitem>
+
+      <listitem>
+        <para>Add to a user&apos;s style sheets style classes used by a panel menu group</para>
+      </listitem>
+    </itemizedlist>
+  </section>
+
+  <section>
+    <title> Skin parameters redefinition</title>
+
+    <table>
+      <title>Skin parameters redefinition for table element of the first level group</title>
+
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Parameters for table element of the first level group</entry>
+
+            <entry>CSS properties</entry>
+          </row>
+        </thead>
+
+        <tbody>
+          <row>
+            <entry>headerWeightFont</entry>
+
+            <entry>font-weight</entry>
+          </row>
+
+          <row>
+            <entry>generalFamilyFont</entry>
+
+            <entry>font-family</entry>
+          </row>
+
+          <row>
+            <entry>headerSizeFont</entry>
+
+            <entry>font-size</entry>
+          </row>
+
+          <row>
+            <entry>headerTextColor</entry>
+
+            <entry>color</entry>
+          </row>
+
+          <row>
+            <entry>headerBackgroundColor</entry>
+
+            <entry>background-color</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+
+    <table>
+      <title>Skin parameters redefinition for table element of the second and next levels groups</title>
+
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Parameters for table element of the second and next levels groups</entry>
+
+            <entry>CSS properties</entry>
+          </row>
+        </thead>
+
+        <tbody>
+          <row>
+            <entry>headerWeightFont</entry>
+
+            <entry>font-weight</entry>
+          </row>
+
+          <row>
+            <entry>headerFamilyFont</entry>
+
+            <entry>font-family</entry>
+          </row>
+
+          <row>
+            <entry>headerSizeFont</entry>
+
+            <entry>font-size</entry>
+          </row>
+
+          <row>
+            <entry>generalTextColor</entry>
+
+            <entry>color</entry>
+          </row>
+
+          <row>
+            <entry>tableBorderColor</entry>
+
+            <entry>border-top-color</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+
+    <table>
+      <title>Skin parameter redefinition for wrapped div element of the first level group</title>
+
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Parameter for wrapped div element of the first level group</entry>
+
+            <entry>CSS properties</entry>
+          </row>
+        </thead>
+
+        <tbody>
+          <row>
+            <entry>panelBorderColor</entry>
+
+            <entry>border-color</entry>
+          </row>
+
+        </tbody>
+      </tgroup>
+    </table>
+  </section>
+
+  <section>
+    <title>Definition of Custom Style Classes</title>
+
+    <figure>
+      <title>Classes names</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/panelmenugroup1.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+    <para>On the screenshot, there are classes names defining specified elements.</para>
+
+    <table>
+      <title>Component skin class</title>
+
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Class name</entry>
+
+            <entry>Description</entry>
+          </row>
+        </thead>
+
+        <tbody>
+          <row>
+            <entry>rich-pmenu-top-group-div</entry>
+
+            <entry>Defines top panel menu group common styleClass. It&apos;s used in the outside
+              &lt;div&gt; element</entry>
+          </row>
+
+          <row>
+            <entry>rich-pmenu-top-group</entry>
+
+            <entry>Defines top panel menu group wrapper table element</entry>
+          </row>
+
+          <row>
+            <entry>rich-pmenu-top-group-self-icon</entry>
+
+            <entry>Defines top panel menu group icon element</entry>
+          </row>
+
+          <row>
+            <entry>rich-pmenu-top-group-self-label</entry>
+
+            <entry>Defines top panel menu group label element</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+
+    <para>This classes set is related to upper level of nodes. For all nodes starting with the
+      second level there are similar classes:</para>
+
+    <itemizedlist>
+      <listitem>rich-pmenu-group-div</listitem>
+      <listitem>rich-pmenu-group</listitem>
+      <listitem>rich-pmenu-group-self-icon</listitem>
+      <listitem>rich-pmenu-group-self-label</listitem>
+    </itemizedlist>
+
+    <para>In order to redefine the style for all panel menu groups 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 the style of particular panel menu groups components define your own style
+      classes in the corresponding panelMenuGroup attributes. </para>
+  </section>
+
+</section>

Added: trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.desc.xml	                        (rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.desc.xml	2007-08-03 15:55:47 UTC (rev 2053)
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section>
+    <sectioninfo>
+        <keywordset>
+            <keyword>panelMenuItem</keyword>
+        </keywordset>
+    </sectioninfo>
+    <section>
+        <para>The <emphasis role="bold">
+                <property>&lt;rich:panelMenuItem&gt;</property>
+        </emphasis> component is used to define a single item inside popup list.</para>
+
+        <mediaobject>
+            <imageobject>
+                <imagedata fileref="images/panelmenu.png"/>
+            </imageobject>
+        </mediaobject>
+    </section>
+    <section>
+        <title>Key Features</title>
+        <itemizedlist>
+            <listitem>Highly customizable look-and-feel</listitem>
+            <listitem>Different submission modes</listitem>
+            <listitem>Optionally supports any content inside</listitem>
+            <listitem>Custom and predefined icons supported</listitem>
+            <listitem>Support for disabling</listitem>
+        </itemizedlist>
+    </section>
+</section>

Added: trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.xml	                        (rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.xml	2007-08-03 15:55:47 UTC (rev 2053)
@@ -0,0 +1,382 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section>
+  <sectioninfo>
+    <keywordset>
+      <keyword>panelMenuItem</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.PanelMenuItem</entry>
+        </row>
+
+        <row>
+          <entry>component-class</entry>
+
+          <entry>org.richfaces.component.html.HtmlPanelMenuItem</entry>
+        </row>
+
+        <row>
+          <entry>component-family</entry>
+
+          <entry>org.richfaces.PanelMenuItem</entry>
+        </row>
+
+        <row>
+          <entry>renderer-type</entry>
+
+          <entry>org.richfaces.PanelMenuItemRenderer</entry>
+        </row>
+
+        <row>
+          <entry>tag-class</entry>
+
+          <entry>org.richfaces.taglib.PanelMenuItemTag</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </table>
+
+  <section>
+    <title>Creating the Component with a Page Tag</title>
+
+    <para>To create the simplest variant on the page use the following syntax:</para>
+
+
+    <para>
+      <emphasis role="bold">Example:</emphasis>
+    </para>
+    <programlisting role="xml">...
+      &lt;rich:panelMenu&gt;
+             …
+            &lt;rich:panelMenuItem value="Item1"/&gt;
+            …	
+      &lt;/rich:panelMenu&gt;
+...</programlisting>
+  </section>
+
+  <section>
+    <title>Creating the Component Dynamically Using Java</title>
+
+    <para>
+      <emphasis role="bold">Example:</emphasis>
+    </para>
+    <programlisting role="java">...
+      org.richfaces.component.html.HtmlPanelMenuItem mypanelMenuItem = new  org.richfaces.component.html.HtmlPanelMenuItem();
+...</programlisting>
+  </section>
+
+  <section>
+    <title>Details of Usage</title>
+
+    <para>All attributes except &quot;label&quot; are optional. The
+      &quot;label&quot; attribute defines text to be represented.</para>
+    <para>The &quot;mode&quot; attribute could be used with three possible parameters:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>Server (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; attributes are ignored.
+      Items don&apos;t fire any submits itself. Behavior is fully defined by the components
+      nested to items.</para>
+
+    <para>Here is an example for value &quot;none&quot;:</para>
+
+    <para>
+      <emphasis role="bold">Example:</emphasis>
+    </para>
+    <programlisting role="xml">...
+      &lt;rich:panelMenu&gt;
+            …
+            &lt;rich:panelMenuItem submitMode="none" onclick="document.location.href='http://labs.jboss.com/jbossrichfaces/"&gt;
+                  &lt;h:outputLink value="http://labs.jboss.com/jbossrichfaces/"&gt;
+                        &lt;h:outputText value="RichFaces Home Page"&gt;&lt;/h:outputText&gt;
+                  &lt;/h:outputLink&gt;
+            &lt;/rich:panelMenuItem&gt;
+            …
+      &lt;/rich:panelMenu&gt;
+...</programlisting>
+
+    <para>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.</para>
+
+    <para>Default icons are shown on the picture below:</para>
+
+    <figure>
+      <title>Default icons</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/panelMenuGroup_icons.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+    <para>Here is an example:</para>
+
+    <para>
+      <emphasis role="bold">Example:</emphasis>
+    </para>
+    <programlisting role="xml">...
+      &lt;rich:panelMenu&gt;
+            …
+            &lt;rich:panelMenuItem ="Item 1.1" icon="chevronUp" /&gt;
+            …	
+      &lt;/rich:panelMenu&gt;
+...</programlisting>
+    <para> As the result the picture is shown below:</para>
+
+    <figure>
+      <title>Using an &quot;icon&quot; attribute</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/panelmenugroup_exp.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+    <para>It&apos;s also possible to define a path to the icon. Simple code is placed below.</para>
+
+    <programlisting role="xml">...
+      &quot;rich:panelMenu&quot;
+            …
+            &quot;rich:panelMenuItem ="Item 1.1" icon="\images\img1.gif" /&quot;
+            …	
+      &quot;/rich:panelMenu&quot;
+...</programlisting>
+
+  </section>
+
+  <section>
+    <title>JavaScript API</title>
+    <para>In Java Script code for expanding/collapsing group element creation it&apos;s
+      necessary to use doExpand()/doCollapse() function.</para>
+
+    <table>
+      <title>JavaScript API</title>
+
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Function</entry>
+
+            <entry>Description</entry>
+          </row>
+        </thead>
+
+        <tbody>
+          <row>
+            <entry>doExpand()</entry>
+
+            <entry>Expand group element</entry>
+          </row>
+
+          <row>
+            <entry>doCollapse()</entry>
+
+            <entry>Collapse group element</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+
+  </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 the appearance of all panel menu items at once:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>Redefine the corresponding skin parameters</para>
+      </listitem>
+
+      <listitem>
+        <para>Add to a user&apos;s style sheets style classes used by a panel menu item</para>
+      </listitem>
+    </itemizedlist>
+  </section>
+
+  <section>
+    <title> Skin parameters redefinition</title>
+
+    <table>
+      <title>Skin parameters redefinition for table element item of first level</title>
+
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Parameters for table element item of first level</entry>
+
+            <entry>CSS properties</entry>
+          </row>
+        </thead>
+
+        <tbody>
+          <row>
+            <entry>generalFamilyFont</entry>
+
+            <entry>font-family</entry>
+          </row>
+
+          <row>
+            <entry>generalWeightFont</entry>
+
+            <entry>font-weight</entry>
+          </row>
+
+          <row>
+            <entry>generalSizeFont</entry>
+
+            <entry>font-size</entry>
+          </row>
+
+          <row>
+            <entry>generalTextColor</entry>
+
+            <entry>color</entry>
+          </row>
+
+          <row>
+            <entry>panelBorderColor</entry>
+
+            <entry>border-top-color</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+
+    <table>
+      <title>General skin parameter redefinition for disabled item </title>
+
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Parameter for disabled item</entry>
+
+            <entry>CSS properties</entry>
+          </row>
+        </thead>
+
+        <tbody>
+          <row>
+            <entry>panelBorderColor</entry>
+
+            <entry>color</entry>
+          </row>
+
+        </tbody>
+      </tgroup>
+    </table>
+
+  </section>
+
+  <section>
+    <title>Definition of Custom Style Classes</title>
+
+    <figure>
+      <title>Classes names</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/panelmenuitem.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+    <para>On the screenshot, there are classes names defining specified elements.</para>
+
+    <table>
+      <title>Component skin class</title>
+
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Class name</entry>
+
+            <entry>Description</entry>
+          </row>
+        </thead>
+
+        <tbody>
+          <row>
+            <entry>rich-pmenu-item</entry>
+
+            <entry>Defines panel menu item common styleClass</entry>
+          </row>
+
+          <row>
+            <entry>rich-pmenu-item-icon</entry>
+
+            <entry>Defines panel menu item icon</entry>
+          </row>
+
+          <row>
+            <entry>rich-pmenu-item-label</entry>
+
+            <entry>Defines panel menu item label element</entry>
+          </row>
+
+        </tbody>
+      </tgroup>
+    </table>
+
+    <para>This classes set is related to the second and all other lower levels of items. For all
+      items starting from the first level there are similar classes:</para>
+
+    <itemizedlist>
+      <listitem>rich-pmenu-top-item</listitem>
+      <listitem>rich-pmenu-top-item-icon</listitem>
+      <listitem>rich-pmenu-top-item-label</listitem>
+    </itemizedlist>
+
+    <para>In order to redefine the style for all panel menu items 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 the style of particular panel menu items components define your own style
+      classes in the corresponding panelMenuItem attributes.</para>
+  </section>
+
+</section>




More information about the richfaces-svn-commits mailing list