Author: SeanRogers Date: 2010-11-24 23:37:19 -0500 (Wed, 24 Nov 2010) New Revision: 20166 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml Log: Updated rich:calendar based on review Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-11-24 23:24:52 UTC (rev 20165) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-11-25 04:37:19 UTC (rev 20166) @@ -212,6 +212,7 @@ </example> </section> + <!-- <section id="sect-Component_Reference-richcalendar-Using_a_data_model"> <title>Using a data model</title> <para> @@ -221,6 +222,7 @@ Alternatively, with <code>mode="ajax"</code> the <sgmltag>&lt;rich:calendar&gt;</sgmltag> requests portions of data for rendering from a special data model. The data model can be defined through the <varname>dataModel</varname> attribute, which points to an object that implements the <classname>CalendarDataModel</classname> interface. If the <varname>dataModel</varname> attribute is not defined or has a value of <literal>null</literal>, the <literal>ajax</literal> mode functions the same as the <literal>client</literal> mode. </para> </section> + --> <section id="sect-Component_Reference-richcalendar-Behavior_and_appearance"> <title>Behavior and appearance</title> @@ -230,6 +232,8 @@ <para> To change the appearance of the display button from the standard calendar icon, use the <varname>buttonIcon</varname> and <varname>buttonIconDisabled</varname> attributes to replace the icon with a specified file. Alternatively, use the <varname>buttonLabel</varname> attribute to display text on the button without an icon. If <varname>buttonLabel</varname> is specified then both the <varname>buttonIcon</varname> and <varname>buttonIconDisabled</varname> attributes are ignored. To hide the text field box, set <code>showInput="false"</code>. </para> + <!-- TODO not in M4 --> + <!-- <para> To change the default position at which the pop-up calendar is shown relative to the text field and button, use the <varname>jointPoint</varname> and <varname>direction</varname> attributes. The <varname>jointPoint</varname> attribute refers to the corner of the text field and button with which the calendar will be aligned and the <varname>direction</varname> specifies which direction the pop-up calendar will span relative to the joint point. The default settings are <code>jointPoint="bottom-left"</code> and <code>direction="bottom-right"</code>, causing the pop-up calendar to align with the bottom-left corner of the text field and span to the bottom-right, underneath the text field and button. The diagram shows the joint points and directions that can be used. Alternatively, set both <varname>jointPoint</varname> and <varname>direction</varname> attributes to <literal>auto</literal> to allow smart pop-up positioning. <xref linkend="figu-Component_Reference-richcalendar! -Pop-up_positioning" /> shows the different possible settings for the <varname>jointPoint</varname> and <varname>direction</varname> attributes. </para> @@ -249,6 +253,7 @@ Pop-up positioning is determined using the <varname>jointPoint</varname> and <varname>direction</varname> attributes. Values for the <varname>jointPoint</varname> attribute are shown in red, while values for the <varname>direction</varname> attribute are shown in black. </para> </figure> + --> <para> The calendar features a <guibutton>Today</guibutton> button for locating today's date on the calendar. This can be set to three different values using the <varname>todayControlMode</varname> attribute: </para> @@ -272,6 +277,9 @@ <para> To make the entire calendar read-only, set <code>readonly="true"</code>. This allows months and years to be browsed through with the arrow controls, but dates and times cannot be selected. </para> + <para> + The locale for the calendar can be defined at the component level. All calendar labels will be localized according to this locale. + </para> <!-- TODO not in M4 --> <!-- <para> @@ -285,8 +293,16 @@ <para> The <sgmltag>&lt;rich:calendar&gt;</sgmltag> component can additionally allow a time of day to be specified with the date. After selecting a date the option to set a time becomes available. The default time can be set with the <varname>defaultTime</varname> attribute. If the time is altered and a new date is selected, it will not reset unless <code>resetTimeOnDateSelect="true"</code> is specified. </para> + <note> + <title>Support for seconds</title> + <para> + In RichFaces 4, the <sgmltag>&lt;rich:calendar&gt;</sgmltag> component supports times that include seconds. Previous versions of RichFaces only supported hours and minutes. + </para> + </note> </section> - + + <!-- TODO not in M4 --> + <!-- <section id="sect-Component_Reference-richcalendar-richcalendar_events"> <title><sgmltag>&lt;rich:calendar&gt;</sgmltag> events</title> <para> @@ -325,6 +341,7 @@ </listitem> </itemizedlist> </section> + --> <section id="sect-Component_Reference-richcalendar-Reference_data"> <title>Reference data</title>