PageRenderTime 47ms CodeModel.GetById 40ms app.highlight 2ms RepoModel.GetById 2ms app.codeStats 0ms

/ftr-gwt-date-emulation/src/site/xdoc/index.xml

http://ftr-gwt-library.googlecode.com/
XML | 53 lines | 38 code | 15 blank | 0 comment | 0 complexity | 8c7e861a81f9db8cd05f458ab3af91b6 MD5 | raw file
 1<?xml version="1.0" encoding="ISO-8859-1"?>
 2<document>
 3  <properties>
 4    <author email="mnouwens@future-earth.eu">Marteijn Nouwens</author>
 5    <title>Introduction</title>
 6  </properties>
 7  <body>
 8    <p>This library implements a Calander in the style of the well known Google Calander.</p>
 9      <p>
10
11      <h2>Using it in your application</h2>
12
13      Embedding it in your application can be done in several ways.
14      Each component can be included depending on the funtionality you need.
15      The most simple Class that can be used is a DayPanel. This class gives you day view.<br />
16      Also classes that can be used are:
17      <ul>
18       <li>WeekPanel a week panel.</li>
19       <li>MonthPanel a month panel.</li>
20       <li>MultiView is the class that most will be used.</li>
21      </ul>
22
23      See the api documentation about parameters and contructors.
24
25      <h2>Using the components embedded</h2>
26
27      You can embed the components like any normal widget. The components are writen in 100% gwt and do not call external javascript libraries. <br />
28
29      The sizing for the compoent is the responsebility for the using programmer. See the example project on how to size the widget.
30
31      <h2>The Renderer</h2>
32
33      There is a default renderer named DefaultStringPanelRenderer. It gives an example on how to implement a custom one. This renderer uses a time stamp as an id. This is normally not suited for production like system.
34
35      The least thing that should be done is implementing a custom renderer. Objects that should be shown must implement the EventData interface. This interface is distributed in a seperate jar file.
36      The reason for this is that a ejb or other back end should not know of the gwt libraries and calander classes. This will provide users with less spagetti code. <br />
37
38      Classes that must be implemented for a custom renderer:
39      <ul>
40       <li>AbstractDayField. The field that is used on the day view. Use the DefaultDayPanel as a base for implementing your own. (It can also be used as is.)</li>
41       <li>AbstractMonthField. The field used on the month view. Use the DefaultMonthField as a basis. (It can also be used as is.)</li>
42       <li>AbstractDateRenderer. This is the class that must be extended for creating you own renderer. DefaultStringPanelRenderer can be used as an example. This cannot be used as is. It defines how objects are created.</li>
43      </ul>
44
45      For the Multiview it is needed to implement a EventController. This allows for switching and navigation from the multiview page. A programmer can choose whether to implement clientside caching or only use real time data from the server.
46
47      See the custom page for more information.
48
49
50
51      </p>
52  </body>
53</document>