You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by mm...@apache.org on 2005/07/28 16:26:59 UTC
svn commit: r225783 -
/myfaces/forrest/trunk/content/xdocs/sandbox/schedule.xml
Author: mmarinschek
Date: Thu Jul 28 07:26:51 2005
New Revision: 225783
URL: http://svn.apache.org/viewcvs?rev=225783&view=rev
Log:
applied patch for documentation of schedule - thanks to Jurgen Lust
Modified:
myfaces/forrest/trunk/content/xdocs/sandbox/schedule.xml
Modified: myfaces/forrest/trunk/content/xdocs/sandbox/schedule.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/sandbox/schedule.xml?rev=225783&r1=225782&r2=225783&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/sandbox/schedule.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/sandbox/schedule.xml Thu Jul 28 07:26:51 2005
@@ -1,22 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd">
-<!--
-This is a standard template meant to be used for the documentation of all custom
-components.
--->
<document>
<!-- component name -->
<header>
<title>Schedule</title>
- <subtitle><x:schedule></subtitle>
+ <subtitle><x:schedule/></subtitle>
</header>
<body>
<!-- Description -->
<section>
<title>Description</title>
<p>
- [TO DO]
+ Renders a schedule component, showing appointments and events
+ in a day, workweek, week or month view, similar to the schedule
+ part of MS Outlook or Evolution.
+ </p>
+ <p>
+ The component is backed by an implementation of the
+ ScheduleModel interface. Creating a custom model can be easily
+ achieved by implementing this interface, or by overriding
+ the AbstractScheduleModel class.
</p>
</section>
<!-- screen shot -->
@@ -30,24 +34,28 @@
<title>API</title>
<table>
<tr>
+ <td>author</td>
+ <td>Jurgen Lust</td>
+ </tr>
+ <tr>
<td>component-family</td>
- <td>[TODO]</td>
+ <td>javax.faces.Panel</td>
</tr>
<tr>
<td>renderer-type</td>
- <td>[TODO]</td>
+ <td>org.apache.myfaces.Schedule</td>
</tr>
<tr>
<td>component-class</td>
- <td>[TODO]</td>
+ <td>org.apache.myfaces.custom.schedule.HtmlSchedule</td>
</tr>
<tr>
<td>renderer-class</td>
- <td>[TODO]</td>
+ <td>org.apache.myfaces.custom.schedule.renderer.ScheduleDelegatingRenderer</td>
</tr>
<tr>
<td>tag-class</td>
- <td>[TODO]</td>
+ <td>org.apache.myfaces.custom.schedule.ScheduleTag</td>
</tr>
</table>
</section>
@@ -55,13 +63,79 @@
<!-- Usage -->
<section>
<title>Usage</title>
- <source>[TODO]</source>
+ <source>
+<x:schedule [ UI component attributes ]
+ [ UI command attributes ]
+ [value="#{backingBean.scheduleModel}"]
+ [visibleStartHour="7"]
+ [visibleEndHour="21"]
+ [workingStartHour="9"]
+ [workingEndHour="17"]
+ [readonly={true|false}]
+ [tooltip={true|false}]
+ [theme={default|outlookxp|evolution}]
+ [headerDateFormat="dd-MM-yyyy"]
+ [compactWeekRowHeight="200"]
+ [compactMonthRowHeight="100"]>
+</x:schedule>
+ </source>
+ </section>
+
+ <!-- Syntax -->
+ <section>
+ <title>Syntax</title>
+ <note label="<x:schedule/>">
+ <code>
+ value - This must be a value binding expression that points to an instance of ScheduleModel.
+ </code>
+ <br/>
+ <code>
+ visibleStartHour - Integer value indicating the first hour of the day that should be visible in the schedule
+ </code>
+ <br/>
+ <code>
+ visibleEndHour - Integer value indicating the last hour of the day that should be visible in the schedule
+ </code>
+ <br/>
+ <code>
+ workingStartHour - Integer value indicating the start of the working day. Everything before this hour will be grayed out
+ </code>
+ <br/>
+ <code>
+ workingEndHour - Integer value indicating the end of the working day. Everything after this hour will be grayed out
+ </code>
+ <br/>
+ <code>
+ readonly - When a schedule is read-only, no entries can be selected
+ </code>
+ <br/>
+ <code>
+ tooltip - Determines whether or not tooltips will be displayed for schedule entries
+ </code>
+ <br/>
+ <code>
+ theme - The name of the theme that should be used when rendering the schedule. Available themes are 'default', 'outlookxp' and 'evolution'
+ </code>
+ <br/>
+ <code>
+ headerDateFormat - If you want to override the Locale dateFormat for displaying the date in the header, you can specify the custom format here
+ </code>
+ <br/>
+ <code>
+ compactWeekRowHeight - The height in pixels of a row in the week view (defaults to 200)
+ </code>
+ <br/>
+ <code>
+ compactMonthRowHeight - The height in pixels of a row in the month view (defaults to 100)
+ </code>
+ <br/>
+ </note>
</section>
- <!-- Additional Information -->
+ <!-- Instructions -->
<section>
- <title>Additional Information</title>
- <p>[TODO]</p>
+ <title>Instructions</title>
+ <p>see examples/schedule.jsp for an example.</p>
</section>
</body>