[richfaces-svn-commits] JBoss Rich Faces SVN: r3295 - branches/3.1.x/docs/userguide/en/src/main/docbook/included.

Author: vkorluzhenko Date: 2007-10-08 11:17:03 -0400 (Mon, 08 Oct 2007) New Revision: 3295 Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/calendar.xml Log: http://jira.jboss.com/jira/browse/RF-968 - improved description Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/calendar.xml =================================================================== --- branches/3.1.x/docs/userguide/en/src/main/docbook/included/calendar.xml 2007-10-08 15:16:04 UTC (rev 3294) +++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/calendar.xml 2007-10-08 15:17:03 UTC (rev 3295) @@ -93,17 +93,50 @@ <mediaobject> <imageobject> - <imagedata fileref="images/calendar.png" /> + <imagedata fileref="images/calendar.png"/> </imageobject> </mediaobject> </figure> + <para>Usage <emphasis> + <property>&quot;currentDate&quot;</property> + </emphasis> attribute isn&apos;t available in the popup + mode.</para> + <para>The <emphasis role="bold"> + <property>&lt;rich:calendar&gt;</property> + </emphasis> component ables to render pages of days in two modes. Switching mode + could be defined with the <emphasis> + <property>&quot;mode&quot;</property> + </emphasis> attribute with two possible parameters: Ajax and Client. Default value is set to + &quot;Client&quot;.</para> + <itemizedlist> + <listitem> + <para>Ajax</para> + </listitem> + </itemizedlist> + + <para>Calendar requests portions of data from Data Model for a page rendering. If + <emphasis> + <property>&quot;dataModel&quot;</property> + </emphasis> attribute has <property>&quot;null&quot;</property> value, data requests are + not sent. In this case the &quot;Ajax&quot; mode is equal to the + &quot;Client&quot; mode. </para> + + <itemizedlist> + <listitem> + <para>Client</para> + </listitem> + </itemizedlist> + + <para>Calendar loads an initial portion of data in a specified range and use this data to + render months. Additional data requests are not sent.</para> + <para>There are three button-related attributes:</para> <itemizedlist> <listitem> <para><emphasis> <property>&quot;buttonLabel&quot;</property> - </emphasis> defines a label for the button. If the attribute is set "buttonIcon" and "buttonIconDisabled" are ignored - </para> + </emphasis> defines a label for the button. If the attribute is set "buttonIcon" and + "buttonIconDisabled" are ignored </para> </listitem> </itemizedlist> <itemizedlist> @@ -225,8 +258,8 @@ <para>The <emphasis role="bold"> <property>&lt;rich:calendar&gt;</property> - </emphasis> component provides the possibility to use a special data model to define data for - element rendering. Data model includes two major interfaces: </para> + </emphasis> component provides the possibility to use a special Data Model to define data for + element rendering. Data Model includes two major interfaces: </para> <itemizedlist> <listitem>CalendarDataModel</listitem> @@ -402,389 +435,389 @@ <section> <title>Look-and-Feel Customization</title> - + <para>For skinnability implementation, the components use a <emphasis> - <property>style class redefinition method.</property> - </emphasis> - Default style classes are mapped on <emphasis> + <property>style class redefinition method.</property> + </emphasis> Default style classes are mapped on <emphasis> <property>skin parameters.</property> </emphasis></para> - + <para>There are two ways to redefine the appearance of all <emphasis role="bold"> - <property>&lt;rich:calendar&gt;</property> - </emphasis> components at once:</para> - + <property>&lt;rich:calendar&gt;</property> + </emphasis> components at once:</para> + <itemizedlist> <listitem> <para>Redefine the corresponding skin parameters</para> </listitem> - + <listitem> <para>Add to your style sheets <emphasis> - <property>style classes</property> - </emphasis> used by a <emphasis role="bold"> - <property>&lt;rich:calendar&gt;</property> - </emphasis> component</para> + <property>style classes</property> + </emphasis> used by a <emphasis role="bold"> + <property>&lt;rich:calendar&gt;</property> + </emphasis> component</para> </listitem> </itemizedlist> </section> - + <section> <title>Skin Parameters Redefinition</title> - + <table> <title>Skin parameters redefinition for a popup element</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 headers (header, optional header)</title> - + <tgroup cols="2"> <thead> <row> <entry>Skin parameters</entry> - + <entry>CSS properties</entry> </row> </thead> - + <tbody> <row> <entry>panelBorderColor</entry> - + <entry>border-bottom-color</entry> </row> - + <row> <entry>additionalBackgroundColor</entry> - + <entry>background-color</entry> </row> - + <row> <entry>generalSizeFont</entry> - + <entry>font-size</entry> </row> - + <row> <entry>generalFamilyFont</entry> - + <entry>font-family</entry> </row> - + </tbody> </tgroup> </table> - + <table> - <title>Skin parameters redefinition for footers (footer, optional footer) and names of working days</title> - + <title>Skin parameters redefinition for footers (footer, optional footer) and names of working + days</title> + <tgroup cols="2"> <thead> <row> <entry>Skin parameters</entry> - + <entry>CSS properties</entry> </row> </thead> - + <tbody> <row> <entry>panelBorderColor</entry> - + <entry>border-top-color</entry> </row> - + <row> <entry>panelBorderColor</entry> - + <entry>border-right-color</entry> </row> - + <row> <entry>additionalBackgroundColor</entry> - + <entry>background</entry> </row> - + <row> <entry>generalSizeFont</entry> - + <entry>font-size</entry> </row> - + <row> <entry>generalFamilyFont</entry> - + <entry>font-family</entry> </row> - + </tbody> </tgroup> </table> - + <table> <title>Skin parameters redefinition for weeks numbers</title> - + <tgroup cols="2"> <thead> <row> <entry>Skin parameters</entry> - + <entry>CSS properties</entry> </row> </thead> - + <tbody> <row> <entry>panelBorderColor</entry> - + <entry>border-bottom-color</entry> </row> - + <row> <entry>panelBorderColor</entry> - + <entry>border-right-color</entry> </row> - + <row> <entry>additionalBackgroundColor</entry> - + <entry>background</entry> </row> - + <row> <entry>calendarWeekBackgroundColor</entry> - + <entry>background-color</entry> </row> - + <row> <entry>generalSizeFont</entry> - + <entry>font-size</entry> </row> - + <row> <entry>generalFamilyFont</entry> - + <entry>font-family</entry> </row> - + </tbody> </tgroup> </table> - + <table> <title>Skin parameters redefinition for a toolbar and names of months</title> - + <tgroup cols="2"> <thead> <row> <entry>Skin parameters</entry> - + <entry>CSS properties</entry> </row> </thead> - + <tbody> <row> <entry>headerBackgroundColor</entry> - + <entry>background-color</entry> </row> - + <row> <entry>headerSizeFont</entry> - + <entry>font-size</entry> </row> - + <row> <entry>headerFamilyFont</entry> - + <entry>font-family</entry> </row> - + <row> <entry>headerWeightFont</entry> - + <entry>font-weight</entry> </row> - + <row> <entry>headerTextColor</entry> - + <entry>color</entry> </row> - + </tbody> </tgroup> </table> - + <table> <title>Skin parameters redefinition for cells with days</title> - + <tgroup cols="2"> <thead> <row> <entry>Skin parameters</entry> - + <entry>CSS properties</entry> </row> </thead> - + <tbody> <row> <entry>panelBorderColor</entry> - + <entry>border-bottom-color</entry> </row> - + <row> <entry>panelBorderColor</entry> - + <entry>border-right-color</entry> </row> - + <row> <entry>generalBackgroundColor</entry> - + <entry>background-color</entry> </row> - + <row> <entry>generalSizeFont</entry> - + <entry>font-size</entry> </row> - + <row> <entry>generalFamilyFont</entry> - + <entry>font-family</entry> </row> - + </tbody> </tgroup> </table> - + <table> <title>Skin parameters redefinition for holiday</title> - + <tgroup cols="2"> <thead> <row> <entry>Skin parameters</entry> - + <entry>CSS properties</entry> </row> </thead> - + <tbody> <row> <entry>calendarHolidaysBackgroundColor</entry> - + <entry>background-color</entry> </row> - + <row> <entry>calendarHolidaysTextColor</entry> - + <entry>color</entry> </row> - + </tbody> </tgroup> </table> - + <table> <title>Skin parameters redefinition for cell with a current date</title> - + <tgroup cols="2"> <thead> <row> <entry>Skin parameters</entry> - + <entry>CSS properties</entry> </row> </thead> - + <tbody> <row> <entry>calendarCurrentBackgroundColor</entry> - + <entry>background-color</entry> </row> - + <row> <entry>calendarCurrentTextColor</entry> - + <entry>color</entry> </row> - + </tbody> </tgroup> </table> - + <table> <title>Skin parameters redefinition for a selected day</title> - + <tgroup cols="2"> <thead> <row> <entry>Skin parameters</entry> - + <entry>CSS properties</entry> </row> </thead> - + <tbody> <row> <entry>headerBackgroundColor</entry> - + <entry>background-color</entry> </row> - + <row> <entry>headerTextColor</entry> - + <entry>color</entry> </row> - + <row> <entry>headerWeightFont</entry> - + <entry>font-weight</entry> </row> - + </tbody> </tgroup> </table> - + </section> - + <section> <title>Definition of Custom Style Classes</title> @@ -860,10 +893,10 @@ <entry>Defines styles for weeks numbers</entry> </row> - + <row> <entry>rich-calendar-today</entry> - + <entry>Defines styles for cell with a current date</entry> </row> @@ -914,16 +947,16 @@ <entry>Defines styles for a popup element</entry> </row> - + <row> <entry>rich-calendar-tool</entry> - + <entry>Defines styles for toolbars</entry> </row> - + <row> <entry>rich-calendar-month</entry> - + <entry>Defines styles for names of months</entry> </row> @@ -989,8 +1022,9 @@ <section> <title>Relevant Resources Links</title> <para><ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/calendar.js... - >Here</ulink> you can see the example of <emphasis role="bold" - ><property>&lt;rich:calendar&gt;</property></emphasis> usage and sources for the given example. </para> + >Here</ulink> you can see the example of <emphasis role="bold"> + <property>&lt;rich:calendar&gt;</property> + </emphasis> usage and sources for the given example. </para> <para>How to use JavaScript API see on the <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&...