From richfaces-svn-commits at lists.jboss.org Mon Sep 28 06:08:52 2009 Content-Type: multipart/mixed; boundary="===============0200387787428990075==" MIME-Version: 1.0 From: richfaces-svn-commits at lists.jboss.org To: richfaces-svn-commits at lists.jboss.org Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r15675 - branches/community/3.3.X/docs/userguide/en/src/main/docbook/included. Date: Mon, 28 Sep 2009 06:08:51 -0400 Message-ID: <200909281008.n8SA8pd1010571@svn01.web.mwc.hst.phx2.redhat.com> --===============0200387787428990075== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: atsebro Date: 2009-09-28 06:08:51 -0400 (Mon, 28 Sep 2009) New Revision: 15675 Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ric= h_panelMenu.xml branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ric= h_panelMenuGroup.xml branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ric= h_panelMenuItem.xml Log: RF-7804: Rich Output component group description review --> rich:panelMenu Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/inclu= ded/rich_panelMenu.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ri= ch_panelMenu.xml 2009-09-28 04:36:20 UTC (rev 15674) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ri= ch_panelMenu.xml 2009-09-28 10:08:51 UTC (rev 15675) @@ -406,7 +406,7 @@ Visit panelMenu page at Rich= Faces LiveDemo for examples of component usage and their sources. - If you have any questions or ideas regarding the <rich:panel> tell ab= out them at the RichFaces Users Forum. + If you have any questions or ideas regarding the <rich:panelMenu> tel= l about them at the RichFaces Users Forum. = Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/inclu= ded/rich_panelMenuGroup.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ri= ch_panelMenuGroup.xml 2009-09-28 04:36:20 UTC (rev 15674) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ri= ch_panelMenuGroup.xml 2009-09-28 10:08:51 UTC (rev 15675) @@ -1,110 +1,96 @@
- - < - rich:panelMenuGroup - > - <emphasis role=3D"since"> - <superscript> available since <emphasis role=3D"version">3.1.0</e= mphasis> - </superscript> - </emphasis> - -
- Description - The - <rich:panelMenuGroup> - component is used to define an expandable group of ite= ms inside the panel menu or other group. -
- - <emphasis role=3D"bold"> - <property><rich:panelMenuGroup></property> - </emphasis> component - - - - - -
-
-
- Key Features - - - Highly customizable look-and-feel - - - Different submission modes inside every group - - - Optional submissions on expand collapse groups - - - Custom and predefined icons supported - - - Support for disabling - - -
-
- Details of Usage + + <rich:panelMenuGroup> <emphasis role=3D"since"><superscr= ipt> available since <emphasis role=3D"version">3.1.0</emphasis></superscri= pt></emphasis> + +
+ Description + + The <rich:panelMenu= Group> defines an expandable group of <rich:panelMenuItem> components insid= e the <rich:panelMenu>. + +
+ + The <emphasis role=3D"bold"><property><rich:pan= elMenuGroup></property></emphasis> component + + + + + +
+
+ = +
+ Key Features + + + Different submission modes inside every grou= p + + + Optional submissions on expand/collapse + + + Supports predefined and custom icons + + + Can be disabled + + + Has customizable look-and-feel + + +
+ = +
+ Details of Usage + + All attributes except "label&qu= ot; are optional. = + The "label" attribute defines text to be represented. + + + Switching mode could be chosen with the"expandMode" attribute for the concrete = panelMenu group. + The "expandMode" attribute could be used with three possible parameters: + = - All attributes except - "label" - are optional. The - "label" - attribute defines text to be represented. - Switching mode could be chosen with the - "expandMode" - attribute for the concrete panelMenu group. - The - "expandMode" - attribute could be used with three possible parameter= s: - - ServerM (default) + ServerM (default) =E2=80=94 regular form su= bmission request is used; + = - Regular form submission request is used. - - Ajax + Ajax =E2=80=94 Ajax submission is used for = switching; = - Ajax submission is used for switching. - - None + None. = - "Action" + "Action" and - "actionListener" + "actionListener" attributes are ignored. Items don't fire any submits = itself. Behavior is fully defined by the components nested into items. = There are three icon-related attributes. The - "iconExpanded" + "iconExpanded" attribute defines an icon for an expanded state. The = - "iconCollapsed" + "iconCollapsed" attribute defines an icon for a collapsed state. The = - "iconDisabled" - attribute defines an icon for a disabled state. + "iconDisabled" + attribute defines an icon for a disabled state. = + Default icons are shown on the picture below: = - Default icons are shown on the picture below: -
Default icons = @@ -117,9 +103,7 @@ = Here is an example: = - - Example: - + = @@ -162,7 +146,7 @@ Information about the "process" - attribute usage you can find " Decide what to process " guide section. + attribute usage you can find "Decide what to process" guide section.
@@ -233,117 +217,146 @@ expand() = - Expand group element + Expands group = collapse() = - Collapse group element + Collapses group - - Classes names that define an upper level groups - - - - - Class name - - Description - - - - - = - - rich-pmenu-top-group-self-icon - - Defines styles for a top group icon - - - - rich-pmenu-top-group-self-label - - Defines styles for a top group label - - - -
- - Classes names that define a second and lower level groups<= /title> = - <tgroup cols=3D"2"> - <thead> - <row> - <entry>Class name</entry> - = - <entry>Description</entry> - </row> - </thead> - = - <tbody> - = - <row> - <entry>rich-pmenu-group</entry> - = - <entry>Defines styles for a group</entry> - </row> - = - <row> - <entry>rich-pmenu-group-self-icon</entry> - = - <entry>Defines styles for a group icon</entry> - </row> - = - <row> - <entry>rich-pmenu-group-self-label</entry> - = - <entry>Defines styles for a group label</entry> - </row> - </tbody> - = - </tgroup> - </table> - <table> - <title>Classes names that define a group state - = - - - - Class name - = - Description - - - = - - - rich-pmenu-hovered-element - = - Defines styles for a hovered group element - +
+ Style classes (selectors) and mapped skin parameters= + + + + Class name + Description + Skin parameter + CSS property + + + + + .rich-pmenu-disabled-element + Defines styles for panel menu disa= bled element + tabDisabledTextColor + color + + + .rich-pmenu-group + Defines styles for = panel menu group + generalTextColor + color + + + headerFamilyFont + font-family + + + headerSizeFont + font-size + + + headerWeightFont + font-weight + + + tableBorderColor + border-top-color + + + .rich-pmenu-hovered-element + Defines styles for panel menu heve= red element + additionalBackgroundColor + background-color + + + .rich-pmenu-top-gro= up + Defines styles for = a top group element of a component + generalFamilyFont + font-family + + + headerSizeFont + font-size + + + headerTextColor + color + + + headerWeightFont + font-weight + + + headerBackgroundColor + background-color + + + .rich-pmenu-top-group-div + Defines styles for a top group div= element of a component + panelBorderColor + border-color + + + +
= - - rich-pmenu-disabled-element - = - Defines styles for a disabled group element - - - = - - - You can find all necessary information about style classes redefini= tion in = - Definition of Custom Style Classes = - section. -
+ + Internal style classes (selectors) + + + + Class name (selector) + Description + + + + + .rich-pmenu-disabled-element + Defines styles for panel menu disa= bled element + + + .rich-pmenu-group + Defines styles for panel menu grou= p + + + .rich-pmenu-group-self-label + Defines styles for panel menu grou= p label + + + .rich-pmenu-nowrap + Defines styles for panel menu wrap= per + + + .rich-pmenu-top-group + Defines styles for panel menu top = group element + + + .rich-pmenu-top-group-div + Defines styles for panel menu top = group div element + + + +
+ = + + You can find all necessary information about style classes = redefinition in Definition of Custom Style C= lasses section. = + + = +
Relevant Resources Links - Some additional information about usage of component can be found = - on the component Live Demo page<= /ulink>. - + Visit panelMenuGroup page<= /ulink> at RichFaces LiveDemo for examples of component usage and their sou= rces.. + + + If you have any questions or ideas regarding the <rich:panelMenuGroup> t= ell about them at the RichFaces Users Forum. + =
\ No newline at end of file Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/inclu= ded/rich_panelMenuItem.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ri= ch_panelMenuItem.xml 2009-09-28 04:36:20 UTC (rev 15674) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ri= ch_panelMenuItem.xml 2009-09-28 10:08:51 UTC (rev 15675) @@ -1,80 +1,74 @@
- < - rich:panelMenuItem - > - <emphasis role=3D"since"> - <superscript> available since <emphasis role=3D"version">3.1.0</e= mphasis> - </superscript> - </emphasis> + <rich:panelMenuItem> <emphasis role=3D"since"><superscript>= available since <emphasis role=3D"version">3.1.0</emphasis></superscript><= /emphasis>
Description - The - <rich:panelMenuItem> - component is used to define a single item inside popup= list. -
+ + The <rich:panelMenuItem= > defines a single item inside <rich:panelMenuGroup>. + +
- <emphasis role=3D"bold"> - <property><rich:panelMenuItem></property> - </emphasis> component - - - - - -
+ The <rich:panelMenu= Item> component. + + + + + + +
-
- Key Features - - - Highly customizable look-and-feel - - - Different submission modes - - - Optionally supports any content inside - - - Custom and predefined icons supported - - - Support for disabling - - -
-
+ = +
+ Key Features + + + Different submission modes inside every grou= p + + + Optional submissions on expand/collapse + + + Supports predefined and custom icons + + + Can be disabled + + + Has customizable look-and-feel + + +
+
= + = Details of Usage = - All attributes except - "label" - are optional. The - "label" - attribute defines text to be rep= resented. - The - "mode" - attribute could be used with thr= ee possible parameters: + + All attributes except "= label" are optional. = + The "label" attribute defines text to be represented. + + + The "mode"= attribute could be used with three possible parameters: + = - Server (default) + Server (default= ) =E2=80=94 Regular form submission request is used. + = - Regular form submission request is used. + = = - Ajax + Ajax =E2=80=94 = Ajax submission is used for switching. = - Ajax submission is used for switching. = @@ -85,19 +79,13 @@ = - - "Action" - and - "actionListener" - attributes are ignored. Items do= n't fire any - submits itself. Behavior is fully defined by= the components nested - into items. + "Action" and "actionListener"<= /emphasis> attributes are ignored. = + Items don't fire any submits itself. = + Behavior is fully defined by the components nest= ed into items. + = + Here is an example for value none: + = - Here is an example for value "none": - - - Example: - ... @@ -110,12 +98,10 @@ ...]]> = - There are two icon-related attributes. The - "icon" - attribute defines an icon. The <= emphasis> - "iconDisabled" - attribute defines an icon for a = disabled item. - + + There are two icon-related attributes. The "icon" attribute defines an = icon. = + The "iconDisabled"= attribute defines an icon for a disabled item. + Default icons are shown on the picture below: =
@@ -128,11 +114,7 @@
= - Here is an example: - - - Example: - + = ... @@ -154,8 +136,9 @@ = - It's also possible to define a path to the icon.= Simple code is - placed below. + + It's also possible to define a path to the icon.= Simple code is placed below. + = @@ -164,179 +147,147 @@ ... = ...]]> - Information about the - "process" - attribute usage you can find in the = - "Decide what to p= rocess" guide section. -
-
+ + Information about the "= process" attribute usage you can find in the &qu= ot;Decide what to process" guide sect= ion. + +
+ +
Reference Data - Table of = - <rich:panelMenuItem> = - attributes. - + Table of <ri= ch:panelMenuItem> attributes. = + - Component Identification Parameters - - - - - Name - - Value - - - - - - component-type - - org.richfaces.Pan= elMenuItem - - - - component-class - - org.richfaces.com= ponent.html.HtmlPanelMenuItem - - - - component-family<= /entry> - - org.richfaces.Pan= elMenuItem - - - - renderer-type - - org.richfaces.Pan= elMenuItemRenderer - - - - tag-class - - org.richfaces.tag= lib.PanelMenuItemTag - - - -
+ Component Identification Parameters + + + + Name + Value + + + + + component-type + org.richfaces.PanelMenuItem + + + component-class + org.richfaces.component.html.HtmlPane= lMenuItem + + + component-family + org.richfaces.PanelMenuItem + + + renderer-type + org.richfaces.PanelMenuItemRenderer + + + tag-class + org.richfaces.taglib.PanelMenuItemTag= + + + + + = - Classes names that define the first l= evel items - - - - - Class name - - Description - - - - - - rich-pmenu-top-it= em - - Defines styles fo= r a top panel - menu item - - - - rich-pmenu-top-it= em-icon - - Defines styles fo= r a top panel - menu item icon - - - - rich-pmenu-top-it= em-label - - Defines styles fo= r a top panel - menu item label - - - - -
- - Classes names that define the second = and lower level items - - - - - Class name - - Description - - - - - - rich-pmenu-item - - Defines styles fo= r a panel menu - item - - - - rich-pmenu-item-i= con - - Defines styles fo= r a panel menu - item icon - - - - rich-pmenu-item-l= abel - - Defines styles fo= r a panel menu - item label - - - - -
- - Classes names that define items state= - - - - - Class name - - Description - - - - - - rich-pmenu-item-s= elected - - Defines styles fo= r a panel menu - selected item - - - - rich-pmenu-disabl= ed-element - - Defines styles fo= r a disabled - panel menu item - - - - rich-pmenu-hovere= d-element - - Defines styles fo= r a hovered - panel menu item - - - -
- You can find all necessary information about style classes redefini= tion in = - Definition of Custom Style Classes = - section. -
+ Style classes (selectors) and mapped skin parameters</t= itle> + <tgroup cols=3D"4"> + <thead> + <row> + <entry>Class name</entry> + <entry>Description</entry> + <entry>Skin parameter</entry> + <entry>CSS property</entry> + </row> + </thead> + <tbody> + <row> + <entry>.rich-pmenu-disabled-element</entry> + <entry>Defines styles for panel menu disable= d element</entry> + <entry>tabDisabledTextColor</entry> + <entry>color</entry> + </row> + <row> + <entry>.rich-pmenu-hovered-element</entry> + <entry>Defines styles for panel menu hevered= element</entry> + <entry>additionalBackgroundColor</entry> + <entry>background-color</entry> + </row> + <row> + <entry morerows=3D"4">.rich-pmenu-item</entr= y> + <entry morerows=3D"4">Defines styles for pan= el menu item</entry> + <entry>generalTextColor</entry> + <entry>color</entry> + </row> + <row> + <entry>generalFamilyFont</entry> + <entry>font-family</entry> + </row> + <row> + <entry>genealSizeFont</entry> + <entry>font-size</entry> + </row> + <row> + <entry>generalWeightFont</entry> + <entry>font-weight</entry> + </row> + <row> + <entry>tableBorderColor</entry> + <entry>border-top-color</entry> + </row> + = + </tbody> + </tgroup> + </table> + = + <table> + <title>Internal style classes (selectors) + + + + Class name (selector) + Description + + + + + .rich-pmenu-disabled-element + Defines styles for panel menu disa= bled element + + + .rich-pmenu-group-self-label + Defines styles for panel menu grou= p label + + + .rich-pmenu-item + Defines styles for panel menu item= + + + .rich-pmenu-selected-element + Defines styles for panel menu sele= cted element + + = + + + + = + + You can find all necessary information about style classes = redefinition in = + Definition of Custom Style C= lasses = + section. + = + + = +
Relevant Resources Links - Some additional information about usage of comp= onent can be found on this LiveDemo pag= e. + + Visit panelM= enuItem page at RichFaces LiveDemo for examples of component usage = and their sources. = + + + If you have any questions or ideas regarding the <rich:panelMenu> tell a= bout them at the RichFaces Users Forum. + =
\ No newline at end of file --===============0200387787428990075==--