Author: msorokin Date: 2008-03-14 13:53:24 -0400 (Fri, 14 Mar 2008) New Revision: 6829 Modified: trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml Log: http://jira.jboss.com/jira/browse/RF-1690 Skin Parameters Redefinition Definition of Custom Style Classes Redefinition styles with predefined classes Modified: trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml 2008-03-14 17:53:12 UTC (rev 6828) +++ trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml 2008-03-14 17:53:24 UTC (rev 6829) @@ -260,7 +260,354 @@ </para> </section> - <!-- End of Look-and-Feel Customization--> + <!-- Skin Parameters Redefinition--> + <section> + <title>Skin Parameters Redefinition</title> + + <table> + <title>Skin parameters redefinition for the &quot;completed&quot; part of the bar with no label</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Skin parameters</entry> + + <entry>CSS properties</entry> + </row> + </thead> + + <tbody> + <row> + <entry>selectControlColor</entry> + + <entry>background-color</entry> + </row> + + </tbody> + </tgroup> + </table> + + <table> + <title>Skin parameters redefinition for the &quot;completed&quot; part of the bar with a label used</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Skin parameters</entry> + + <entry>CSS properties</entry> + </row> + </thead> + + <tbody> + <row> + <entry>panelBorderColor</entry> + + <entry>border-color</entry> + </row> + + </tbody> + </tgroup> + </table> + + <table> + <title>Skin parameters redefinition for the “completed” part of the bar with a label used</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Skin parameters</entry> + + <entry>CSS properties</entry> + </row> + </thead> + + <tbody> + <row> + <entry>selectControlColor</entry> + + <entry>background-color</entry> + </row> + + <row> + <entry>controlBackgroundColor</entry> + + <entry>color</entry> + </row> + </tbody> + </tgroup> + </table> + + <table> + <title>Skin parameters redefinition for the &quot;remained&quot; part of the bar</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Skin parameters</entry> + + <entry>CSS properties</entry> + </row> + </thead> + + <tbody> + <row> + <entry>controlBackgroundColor</entry> + + <entry>background-color</entry> + </row> + + <row> + <entry>controlTextColor</entry> + + <entry>color</entry> + </row> + </tbody> + </tgroup> + </table> + + <table> + <title>Skin parameters redefinition for the bar itself with a label used</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Skin parameters</entry> + + <entry>CSS properties</entry> + </row> + </thead> + + <tbody> + <row> + <entry>panelBorderColor</entry> + + <entry>border-color</entry> + </row> + + <row> + <entry>generalFamilyFont</entry> + + <entry>font-family</entry> + </row> + + <row> + <entry>headerFamilyFont</entry> + + <entry>font-family</entry> + </row> + + <row> + <entry>generalSizeFont</entry> + + <entry>font-size</entry> + </row> + + <row> + <entry>controlTextColor</entry> + + <entry>color</entry> + </row> + + </tbody> + </tgroup> + </table> + + <table> + <title>Skin parameters redefinition for the bar itself with no label used</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Skin parameters</entry> + + <entry>CSS properties</entry> + </row> + </thead> + + <tbody> + <row> + <entry>controlBackgroundColor</entry> + + <entry>background-color</entry> + </row> + + <row> + <entry>panelBorderColor</entry> + + <entry>border-color</entry> + </row> + + </tbody> + </tgroup> + </table> + + </section> + <!-- END Skin Parameters Redefinition--> + + <!-- Definition of Custom Style Classes--> + + <section> + <title>Definition of Custom Style Classes</title> + <para>On the screenshot there are classes names that define styles for component elements.</para> + <figure> + <title>Classes names</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/progressbarClasses.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Classes names for the bar</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Class name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>.rich-progress-bar-shell</entry> + <entry>Defines styles for the background and the borders of the bar when label is not used</entry> + </row> + + <row> + <entry>rich-progress-bar-shell-dig</entry> + <entry>Defines styles for background, font and border settings when label is used</entry> + </row> + </tbody> + </tgroup> + </table> + + <table> + <title>Classes names that define &quot;completed&quot; part of the bar</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Class name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + + <row> + <entry>rich-progress-bar-uploaded</entry> + <entry>Defines styles for of &quot;completed&quot; progress area with no labels used</entry> + </row> + <row> + <entry>rich-progress-bar-uploaded-dig</entry> + <entry>Defines styles for that &quot;completed&quot; progress area with labels used </entry> + </row> + + <row> + <entry>rich-progress-bar-completed</entry> + <entry>Defines styles for the &quot;completed&quot; progress area with a label used</entry> + </row> + + + </tbody> + </tgroup> + </table> + + + + <table> + <title>Classes names that define &quot;remained&quot; part of the progress area</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Class name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + + <row> + <entry>rich-progress-bar-remained</entry> + <entry>Defines styles for the &quot;remained&quot; part of the bar</entry> + </row> + + + + </tbody> + </tgroup> + </table> + <para>In order to redefine styles for all <emphasis role="bold"> + <property>&lt;rich:progressBar&gt;</property> + </emphasis> components on a page using CSS, it&apos;s enough to create classes with the + same names (possible classes could be found in the tables <link linkend="tab_cn3"> above</link>) and define necessary properties in them. </para> + + <para> + <emphasis role="bold">Example:</emphasis> + </para> + <programlisting role="CSS"><![CDATA[... +.rich-progress-bar-remained{ + background-color: #5793f5; +} +...]]></programlisting> + + <para>This is the result:</para> + + <figure> + <title>Redefinition styles with predefined classes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/progressbarRedefinedClasses.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the example the &quot;remained&quot; part of progress area is modified with a background-color CSS property.</para> + + + + + + <para>It&apos;s aslo possible to change styles of a particular + <emphasis role="bold"> <property>&lt;rich:progressBar&gt;</property></emphasis> component. In this case you should create own style classes and use them in corresponding <emphasis role="bold"><property>&lt;rich:progressBar&gt;</property></emphasis> <property>styleClass</property> attributes. An example is placed below:</para> + <para> + <emphasis role="bold">Example:</emphasis> + </para> + <programlisting role="CSS"><![CDATA[... +.myFontClass{ + color: #5793f5; +} +...]]></programlisting> + <para>The <emphasis><property>&quot;styleClass&quot;</property></emphasis> attribute for <emphasis role="bold" + ><property>&lt;rich:progressBar&gt; </property></emphasis> is defined as it’s shown in the example below:</para> + + <para> + <emphasis role="bold">Example:</emphasis> + </para> + <programlisting role="CSS"><![CDATA[<progressBar:progressBar value="#{bean.incValue1}" styleClass="myFontClass" /> +]]></programlisting> + + <para>This is a result:</para> + + <figure> + <title>Modificaton of a look and feel with own classes and <emphasis><property>styleClass</property></emphasis> attributes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/progressbarMyClass.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As it could be seen on the picture above, the font style for output text was changed.</para> + + + </section> + <section> + <title>Relevant Resources Links</title> + <para> + <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/progressbar... + you can see the example of <emphasis role="bold"> + <property>&lt;rich:progressBar&gt;</property> + </emphasis> usage and sources for the given example. </para> + + </section> </section>