From richfaces-svn-commits at lists.jboss.org Wed Oct 20 21:32:01 2010
Content-Type: multipart/mixed; boundary="===============0421745153091909842=="
MIME-Version: 1.0
From: richfaces-svn-commits at lists.jboss.org
To: richfaces-svn-commits at lists.jboss.org
Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r19623 - in
 modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US: extras
 and 1 other directories.
Date: Wed, 20 Oct 2010 21:32:01 -0400
Message-ID: <201010210132.o9L1W1Jk018136@svn01.web.mwc.hst.phx2.redhat.com>

--===============0421745153091909842==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: SeanRogers
Date: 2010-10-20 21:32:01 -0400 (Wed, 20 Oct 2010)
New Revision: 19623

Added:
   modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/extr=
as/exam-Component_Reference-richcalendar-Basic_usage.xml_sample
   modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/imag=
es/figu-Component_Reference-richcalendar-Pop-up_positioning.png
   modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/imag=
es/figu-Component_Reference-richcalendar-richcalendar.png
Modified:
   modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/chap=
-Component_Reference-Rich_inputs.xml
Log:
Draft of rich:calendar complete

Modified: modules/docs/branches/m4/Component_Reference/src/main/docbook/en-=
US/chap-Component_Reference-Rich_inputs.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Rich_inputs.xml	2010-10-21 00:31:11 UTC (rev 19622)
+++ modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Rich_inputs.xml	2010-10-21 01:32:01 UTC (rev 19623)
@@ -21,16 +21,37 @@
 			The <sgmltag>&lt;rich:calendar&gt;</sgmltag> component allows the user =
to enter a date and time through an in-line or pop-up calendar. The pop-up =
calendar can navigate through months and years, and its look and feel can b=
e highly customized.
 		</para>
 =

+		<figure id=3D"figu-Component_Reference-richcalendar-richcalendar">
+			<title><sgmltag>&lt;rich:calendar&gt;</sgmltag></title>
+			<mediaobject>
+				<imageobject>
+					<imagedata fileref=3D"images/figu-Component_Reference-richcalendar-ri=
chcalendar.png" format=3D"PNG" />
+				</imageobject>
+				<textobject>
+					<para>
+						An expanded <sgmltag>&lt;rich:calendar&gt;</sgmltag> component, disp=
laying the calendar month of December, 2010.
+					</para>
+				</textobject>
+			</mediaobject>
+		</figure>
+
 		<section id=3D"sect-Component_Reference-richcalendar-Basic_usage">
 			<title>Basic usage</title>
 			<para>
-				The <sgmltag>&lt;rich:calendar&gt;</sgmltag> component supports two di=
fferent ways of loading data through defining the <varname>mode</varname> a=
ttribute. When not specified, the component uses <literal>client</literal> =
mode, which loads an initial portion of data within a set date range. The r=
ange can be defined by using the <varname>preloadDateRangeBegin</varname> a=
nd <varname>preloadDateRangeEnd</varname> attributes. Additional data reque=
sts are not sent.
+				Basic usage of the <sgmltag>&lt;rich:calendar&gt;</sgmltag> component =
requires only the <varname>value</varname> attribute, which holds the curre=
ntly selected date. <xref linkend=3D"exam-Component_Reference-richcalendar-=
Basic_usage" /> shows a basic declaration, with the value pointing to a dat=
a model.
 			</para>
+			<example id=3D"exam-Component_Reference-richcalendar-Basic_usage">
+				<title>Basic usage</title>
+				<programlisting language=3D"XML" role=3D"XML"><xi:include parse=3D"tex=
t" href=3D"extras/exam-Component_Reference-richcalendar-Basic_usage.xml_sam=
ple" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></programlisting>
+			</example>
 		</section>
 =

 		<section id=3D"sect-Component_Reference-richcalendar-Using_a_data_model">
 			<title>Using a data model</title>
 			<para>
+				The <sgmltag>&lt;rich:calendar&gt;</sgmltag> component supports two di=
fferent ways of loading data through defining the <varname>mode</varname> a=
ttribute. When not specified, the component uses <literal>client</literal> =
mode, which loads an initial portion of data within a set date range. The r=
ange can be defined by using the <varname>preloadDateRangeBegin</varname> a=
nd <varname>preloadDateRangeEnd</varname> attributes. Additional data reque=
sts are not sent.
+			</para>
+			<para>
 				Alternatively, with <code>mode=3D"ajax"</code> the <sgmltag>&lt;rich:c=
alendar&gt;</sgmltag> requests portions of data for rendering from a specia=
l data model. The data model can be defined through the <varname>dataModel<=
/varname> attribute, which points to an object that implements the <classna=
me>CalendarDataModel</classname> interface. If the <varname>dataModel</varn=
ame> attribute is not defined or has a value of <literal>null</literal>, th=
e <literal>ajax</literal> mode functions the same as the <literal>client</l=
iteral> mode.
 			</para>
 		</section>
@@ -44,8 +65,24 @@
 				To change the appearance of the display button from the standard calen=
dar icon, use the <varname>buttonIcon</varname> and <varname>buttonIconDisa=
bled</varname> attributes to replace the icon with a specified file. Altern=
atively, use the <varname>buttonLabel</varname> attribute to display text o=
n the button without an icon. If <varname>buttonLabel</varname> is specifie=
d then both the <varname>buttonIcon</varname> and <varname>buttonIconDisabl=
ed</varname> attributes are ignored. To hide the text field box, set <code>=
showInput=3D"false"</code>.
 			</para>
 			<para>
-				To change the default position at which the pop-up calendar is shown r=
elative to the text field and button, use the <varname>jointPoint</varname>=
 and <varname>direction</varname> attributes. The <varname>jointPoint</varn=
ame> attribute refers to the corner of the text field and button with which=
 the calendar will be aligned and the <varname>direction</varname> specifie=
s which direction the pop-up calendar will span relative to the joint point=
. The default settings are <code>jointPoint=3D"bottom-left"</code> and <cod=
e>direction=3D"bottom-right"</code>, causing the pop-up calendar to align w=
ith 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 an=
d directions that can be used. Alternatively, set both <varname>jointPoint<=
/varname> and <varname>direction</varname> attributes to <literal>auto</lit=
eral> to allow smart pop-up positioning.
+				To change the default position at which the pop-up calendar is shown r=
elative to the text field and button, use the <varname>jointPoint</varname>=
 and <varname>direction</varname> attributes. The <varname>jointPoint</varn=
ame> attribute refers to the corner of the text field and button with which=
 the calendar will be aligned and the <varname>direction</varname> specifie=
s which direction the pop-up calendar will span relative to the joint point=
. The default settings are <code>jointPoint=3D"bottom-left"</code> and <cod=
e>direction=3D"bottom-right"</code>, causing the pop-up calendar to align w=
ith 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 an=
d directions that can be used. Alternatively, set both <varname>jointPoint<=
/varname> and <varname>direction</varname> attributes to <literal>auto</lit=
eral> to allow smart pop-up positioning. <xref linkend=3D"figu-Component_Re=
ference-richcalendar!
 -Pop-up_positioning" /> shows the different possible settings for the <var=
name>jointPoint</varname> and <varname>direction</varname> attributes.
 			</para>
+			<figure id=3D"figu-Component_Reference-richcalendar-Pop-up_positioning">
+				<title>Pop-up positioning</title>
+				<mediaobject>
+					<imageobject>
+						<imagedata fileref=3D"images/figu-Component_Reference-richcalendar-P=
op-up_positioning.png" format=3D"PNG" />
+					</imageobject>
+					<textobject>
+						<para>
+							Pop-up positioning is determined using the <varname>jointPoint</var=
name> and <varname>direction</varname> attributes.
+						</para>
+					</textobject>
+				</mediaobject>
+				<para>
+					Pop-up positioning is determined using the <varname>jointPoint</varna=
me> and <varname>direction</varname> attributes. Values for the <varname>jo=
intPoint</varname> attribute are shown in red, while values for the <varnam=
e>direction</varname> attribute are shown in black.
+				</para>
+			</figure>
 			<para>
 				The calendar features a <guibutton>Today</guibutton> button for locati=
ng today's date on the calendar. This can be set to three different values =
using the <varname>todayControlMode</varname> attribute:
 			</para>
@@ -69,6 +106,12 @@
 			<para>
 				To make the entire calendar read-only, set <code>readonly=3D"true"</co=
de>. This allows months and years to be browsed through with the arrow cont=
rols, but dates and times cannot be selected.
 			</para>
+			<!-- TODO not in M4 -->
+			<!--
+			<para>
+				The styling and appearance of the calendar can be fully customized usi=
ng facets. =

+			</para>
+			-->
 		</section>
 =

 		<section id=3D"sect-Component_Reference-richcalendar-Time_of_day">

Added: modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/=
extras/exam-Component_Reference-richcalendar-Basic_usage.xml_sample
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/ext=
ras/exam-Component_Reference-richcalendar-Basic_usage.xml_sample	          =
              (rev 0)
+++ modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/ext=
ras/exam-Component_Reference-richcalendar-Basic_usage.xml_sample	2010-10-21=
 01:32:01 UTC (rev 19623)
@@ -0,0 +1 @@
+<rich:calendar value=3D"#{bean.dateTest}" />

Added: modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/=
images/figu-Component_Reference-richcalendar-Pop-up_positioning.png
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
(Binary files differ)


Property changes on: modules/docs/branches/m4/Component_Reference/src/main/=
docbook/en-US/images/figu-Component_Reference-richcalendar-Pop-up_positioni=
ng.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/=
images/figu-Component_Reference-richcalendar-richcalendar.png
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
(Binary files differ)


Property changes on: modules/docs/branches/m4/Component_Reference/src/main/=
docbook/en-US/images/figu-Component_Reference-richcalendar-richcalendar.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream


--===============0421745153091909842==--