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

richfaces-svn-commits at lists.jboss.org richfaces-svn-commits at lists.jboss.org
Fri Aug 17 11:01:51 EDT 2007


Author: vkorluzhenko
Date: 2007-08-17 11:01:51 -0400 (Fri, 17 Aug 2007)
New Revision: 2323

Modified:
   trunk/docs/userguide/en/src/main/docbook/included/calendar.xml
Log:
http://jira.jboss.com/jira/browse/RF-446

Modified: trunk/docs/userguide/en/src/main/docbook/included/calendar.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/calendar.xml	2007-08-17 14:41:49 UTC (rev 2322)
+++ trunk/docs/userguide/en/src/main/docbook/included/calendar.xml	2007-08-17 15:01:51 UTC (rev 2323)
@@ -81,9 +81,7 @@
     <title>Details of Usage</title>
     <para>The <emphasis>
         <property>&quot;popup&quot;</property>
-      </emphasis> attribute defines calendar representation mode on a page. Default value for the <emphasis>
-        <property>&quot;popup&quot;</property>
-      </emphasis> attribute is &quot;false&quot;. If it&apos;s &quot;true&quot;
+      </emphasis> attribute defines calendar representation mode on a page. If it&apos;s &quot;true&quot;
       the calendar is represented on a page as an input field and a button. Clicking on the button
       calls the calendar popup as it&apos;s shown on the picture below. </para>
     <figure>
@@ -237,11 +235,8 @@
 
   </section>
 
-  <!--section>
+  <section>
     <title>JavaScript API</title>
-    <para>In Java Script code for expanding/collapsing group element creation it&apos;s
-      necessary to use doExpand()/doCollapse() function.</para>
-
     <table>
       <title>JavaScript API</title>
 
@@ -255,16 +250,119 @@
         </thead>
 
         <tbody>
+          
           <row>
-            <entry>doExpand()</entry>
+            <entry>selectDate(date)</entry>
+            
+            <entry>Select the date specified.  If the date isn&apos;t in current month - performs request to select</entry>
+          </row>
+          
+          <row>
+            <entry>isDateEnabled(date)</entry>
+            
+            <entry>Check if given date is selectable</entry>
+          </row>
+          
+          <row>
+            <entry>enableDate(date)</entry>
+            
+            <entry>Enables date cell control on the calendar</entry>
+          </row>
+          
+          <row>
+            <entry>disableDate(date)</entry>
+            
+            <entry>Disables date cell control on the calendar</entry>
+          </row>
+          
+          <row>
+            <entry>enableDates(date[])</entry>
+            
+            <entry>Enables dates cell controls set on the calendar</entry>
+          </row>
+          
+          <row>
+            <entry>disableDates(date[])</entry>
+            
+            <entry>Disables dates cell controls set on the calendar</entry>
+          </row>
+          
+          <row>
+            <entry>nextMonth()</entry>
+            
+            <entry>Navigate to next month</entry>
+          </row>
+          
+          <row>
+            <entry>nextYear()</entry>
+            
+            <entry>Navigate to next year</entry>
+          </row>
+          
+          <row>
+            <entry>prevMonth()</entry>
+            
+            <entry>Navigate to previous month </entry>
+          </row>
+          
+          <row>
+            <entry>prevYear()</entry>
+            
+            <entry>Navigate to previous year</entry>
+          </row>
+          
+          <row>
+            <entry>today()</entry>
+            
+            <entry>Select today date</entry>
+          </row>
+          
+          <row>
+            <entry>getSelectedDate()</entry>
+            
+            <entry>Return currently selected date</entry>
+          </row>
+          
+          <row>
+            <entry>Object getData()</entry>
+            
+            <entry>Return additional data for the date</entry>
+          </row>
+          
+          <row>
+            <entry>enable()</entry>
+            
+            <entry>enables calendar</entry>
+          </row>
+          
+          <row>
+            <entry>disable()</entry>
+            
+            <entry>disables calendar</entry>
+          </row>
+          
+          <row>
+            <entry>getCurrentMonth()</entry>
+            
+            <entry>Returns number of the month currently being viewed</entry>
+          </row>
+          
+          <row>
+            <entry>getCurrentYear()</entry>
+            
+            <entry>Returns number of the year currently being viewed</entry>
+          </row>
+          
+          <row>
+            <entry>doCollapse()</entry>
 
-            <entry>Expand group element</entry>
+            <entry>Collapse calendar  element</entry>
           </row>
 
           <row>
-            <entry>doCollapse()</entry>
+            <entry>doExpand()</entry>
 
-            <entry>Collapse group element</entry>
+            <entry>Expand calendar element</entry>
           </row>
         </tbody>
       </tgroup>
@@ -273,7 +371,7 @@
   </section>
 
 
-  <section>
+  <!--section>
     <title>Look-and-Feel Customization</title>
 
     <para>As this component is just a wrapper for its children its provide the only




More information about the richfaces-svn-commits mailing list