From richfaces-svn-commits at lists.jboss.org Thu Sep 10 12:30:19 2009 Content-Type: multipart/mixed; boundary="===============2838945909691730404==" 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: r15533 - branches/community/3.3.X/docs/userguide/en/src/main/docbook/included. Date: Thu, 10 Sep 2009 12:30:18 -0400 Message-ID: <200909101630.n8AGUI2t023576@svn01.web.mwc.hst.phx2.redhat.com> --===============2838945909691730404== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: atsebro Date: 2009-09-10 12:30:18 -0400 (Thu, 10 Sep 2009) New Revision: 15533 Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ric= h_modalPanel.xml branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ric= h_panel.xml Log: RF-7804: Rich Output component group description review --> rich:panel Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/inclu= ded/rich_modalPanel.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_modalPanel.xml 2009-09-10 15:46:40 UTC (rev 15532) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ri= ch_modalPanel.xml 2009-09-10 16:30:18 UTC (rev 15533) @@ -302,7 +302,7 @@ - Class name (selector) + Class name Description Skin Parameter CSS property Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/inclu= ded/rich_panel.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_panel.xml 2009-09-10 15:46:40 UTC (rev 15532) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ri= ch_panel.xml 2009-09-10 16:30:18 UTC (rev 15533) @@ -1,270 +1,244 @@
- - < - rich:panel - > - <emphasis role=3D"since"> - <superscript> available since <emphasis role=3D"version">3.0.0</e= mphasis> - </superscript> - </emphasis> - -
- Description - A skinnable panel that is rendered as a b= ordered rectangle with or - without a header. -
- - <emphasis role=3D"bold"> - <property><rich:panel></property> - </emphasis> component - = - - - - -
-
-
- Key Features - - - Highly customizable look and feel - - - Support for any content inside - - - Header adding feature - = - -
-
- Details of Usage - The - "header" - attribute defines text to be represented. If you can = use the - - "header" - facet, you can even not use the - "header" - attribute. - - Example: - - - = - - - ... - - ... - -... -]]> - = - - - <rich:panel> - components are used to group page content pieces on s= imilarly formatted - rectangular panels. - - Example: - - - ... - -... -]]> - It's generating on a page in the following way: -
- - <emphasis role=3D"bold"> - <property><rich:panel></property> - </emphasis> without header + < rich:panel > <emphasis role=3D"since"><superscript> a= vailable since <emphasis role=3D"version">3.0.0</emphasis></superscript></e= mphasis> +
+ Description + The component implements a bordered rectangular panel wi= th or without header. +
+ + The <rich:panel> + + + + + +
+
+ = +
+ Key Features + + + May have any content inside + + + May have header + + + Has customizable look and feel + + +
+ = +
+ Details of Usage + + The component groups page contents into notional blocks. = + Borders separate this content visually from the rest of = page. = + To define the <rich= :panel> on a page the following code will be enoug= h: + + ]]> + = + The result: +
+ Empty <rich:panel> + + + + + +
+ = + + The <rich:pan= el> supports header facet that define= s header and text label on it. = + Besides that there is "he= ader" attribute that does the same job. = + The following two entries + + + = - - - - - -
- = - The example shows that similar rectangular areas are formed wi= th a particular style. - When creating a panel with a header eleme= nt, one more - <div> - element is added with content defined for a header. - - Example: - - - - - - ... - -... -]]> - It's displayed on a page in the following way: -
- - <emphasis role=3D"bold"> - <property><rich:panel></property> with header</emphas= is> - - - - - - - -
- As it has been mentioned above,= the component is mostly used for a page style definition, - hence the main attributes are style ones. - - + + + +]]> + = + + have the same output: + +
+ The <rich:panel> with header + + + + + +
+
+ = +
+ Reference Data - - "styleClass" - + Table of <rich= :panel> attributes. = - - + = + + Component Identification Parameters + + + + Name + Value + + + + + component-type + org.richfaces.panel + + + component-class + org.richfaces.component.html.Ht= mlPanel + + + component-family + org.richfaces.panel + + + renderer-type + org.richfaces.PanelRenderer + + + tag-class + org.richfaces.taglib.PanelTag + + + +
+ = + + Facets + + + + Facet name + Description + + + + + header + Defines panel header and text l= abel on it + + + +
+ = + + Style classes (selectors) and mapped skin paramet= ers + + + + Class name + Description + Skin parameter + CSS property + + + + + .rich-panel + Defines styles f= or a wrapper <div> element of a component + generalBackgroundColor + background-color + + + panelBorderColor + border-color + + = + + .rich-panel-body= + Defines styles f= or a body element + generalFamilyFont + font-family + + + generalSizeFont + font-size + + + generalTextColor + color + + + .rich-panel-head= er + Defines styles f= or a header element + headerFamilyFont + font-family + + + headerSizeFont + font-size + + + headerWeightFont + font-weight + + + headerTextColor + color + + + headerBackgroundColor + background-color + + + headerBackgroundColor + border-color + + + +
+ = + + Internal style classes (selectors) + + + + Class name (selector) + Description + + + + + .rich-panel + Defines styles for a wrapper &l= t;div> element of a component + + + .rich-panel-body + Defines styles for a body eleme= nt + + + .rich-panel-header + Defines styles for a header ele= ment + + + +
+ = - - "headerClass" - + You can find all necessary information about style class= es redefinition in Definition of Custom Styl= e Classes section. = - - +
+ = +
+ Relevant Resources Links - - "bodyClass" - + Visit Panel page at RichFaces LiveDe= mo for examples of component usage and their sources. - - - Moreover, to add e.g. some JavaScript effects, events defined = on it are used. - - - = - - "onmouseover" - = - - - - = - - "onclick" - = - - - - = - - "onmouseout" - = - - - - etc. - - - = -
-
- Reference Data - - Table of = - <rich:panel> = - attributes. - - - Component Identification Parameters - - - - Name - Value - - - - - component-type - org.richfaces.panel - - - component-class - org.richfaces.component.html.HtmlPanel - - - component-family - org.richfaces.panel - - - renderer-type - org.richfaces.PanelRenderer - - - tag-class - org.richfaces.taglib.PanelTag - - - -
- - Facets - - - - Facet name - Description - - - - - header - Defines the header content - - - -
- - Classes names that define a component appearance - - - - Class name - Class description - - - - - rich-panel - Defines styles for a wrapper <div> element= of a component - - - rich-panel-header - Defines styles for a header element - - - rich-panel-body - Defines styles for a body element - - - -
- You can find all necessary information about style classes redefini= tion in = - Definition of Custom Style Classes = - section. -
-
- Relevant Resources Links - - On the component LiveDemo page you can see th= e example of - <rich:panel> - usage and sources for the given example. -
-
\ No newline at end of file + + If you have any questions or ideas regarding the <rich:panel> tell ab= out them at the RichFaces Users Forum. + = + + --===============2838945909691730404==--