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

Author: cluts Date: 2008-07-31 09:24:38 -0400 (Thu, 31 Jul 2008) New Revision: 9846 Modified: trunk/docs/userguide/en/src/main/docbook/included/calendar.xml Log: RF-4036 - described this attribute with its possible values. Modified: trunk/docs/userguide/en/src/main/docbook/included/calendar.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/calendar.xml 2008-07-31 13:24:00 UTC (rev 9845) +++ trunk/docs/userguide/en/src/main/docbook/included/calendar.xml 2008-07-31 13:24:38 UTC (rev 9846) @@ -104,6 +104,21 @@ <para>The <emphasis><property>&quot;value&quot;</property></emphasis> attribute stores selected date currently.</para> <para>With help of the <emphasis><property>&quot;currentDate&quot;</property></emphasis> attribute you can define month and year which will be displayed currently.</para> + <para> + The <emphasis><property>&quot;todayControlMode&quot;</property></emphasis> attribute defines the mode for &quot;today&quot; control. + Possible values are: + </para> + <itemizedlist> + <listitem> + <para>&quot;hidden&quot; - in this mode &quot;Today&quot; button will not be displayed</para> + </listitem> + <listitem> + <para>&quot;select&quot; - (default) in this state &quot;Today&quot; button activation will scroll the calendar to the current date and it become selected date</para> + </listitem> + <listitem> + <para>&quot;scroll&quot; - in this mode &quot;Today&quot; activation will simply scroll the calendar to current month without changing selected day.</para> + </listitem> + </itemizedlist> <para>The <emphasis role="bold"> <property>&lt;rich:calendar&gt;</property> </emphasis> component can render pages of days in two modes. A mode could be @@ -503,31 +518,31 @@ <row> <entry role="tbi">isDateEnabled(date)</entry> - <entry role="tbi">Checks if given date is selectable <para>(to be implemented)</para></entry> + <entry role="tbi">Checks if given date is selectable (to be implemented)</entry> </row> <row> <entry role="tbi">enableDate(date)</entry> - <entry role="tbi">Enables date cell control on the calendar <para>(to be implemented)</para></entry> + <entry role="tbi">Enables date cell control on the calendar (to be implemented)</entry> </row> <row> <entry role="tbi">disableDate(date)</entry> - <entry role="tbi">Disables date cell control on the calendar <para>(to be implemented)</para></entry> + <entry role="tbi">Disables date cell control on the calendar (to be implemented)</entry> </row> <row> <entry role="tbi">enableDates(date[])</entry> - <entry role="tbi">Enables dates cell controls set on the calendar <para>(to be implemented)</para></entry> + <entry role="tbi">Enables dates cell controls set on the calendar (to be implemented)</entry> </row> <row> <entry role="tbi">disableDates(date[])</entry> - <entry role="tbi">Disables dates cell controls set on the calendar <para>(to be implemented)</para></entry> + <entry role="tbi">Disables dates cell controls set on the calendar (to be implemented)</entry> </row> <row>