1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Vaadin 6</title>
<link rel="stylesheet" type="text/css" href="demo/css/styles.css" />
<!--[if IE]>
<link rel="stylesheet" type="text/css" href="demo/css/ie.css" />
<![endif]-->
</head>
<body>
<div id="header">
<h1>Vaadin – thinking of U and I</h1>
<div id="version">
<a href="javascript:history.go(-1);" title="Back to index page">Back</a>
</div>
</div> <!-- /header -->
<div id="content">
<p>Version @version@ built on @builddate@.</p>
<h2><a name="overview">Release Notes for Vaadin @version@</a></h2>
<ul>
<li><a href="#overview">Overview</a></li>
<li><a href="#upgrading">General Upgrade Notes</a></li>
<li><a href="#upgrading-tk5">Instructions for Upgrading from IT Mill Toolkit 5</a></li>
<li><a href="#oophm">Package for the experimental GWT Out-of-Process Hosted Mode</a></li>
<li><a href="#known-problems">Important known problems in Vaadin @version@</a></li>
<li><a href="#changelog">Change Log</a></li>
<li><a href="#requirements">Requirements</a></li>
</ul>
<p><i><b>This is a prerelease version of Vaadin 6.2</b>, the Release
Notes will change before the final release.</i> Also notice that the regular
Vaadin Plugin for Eclipse does not support Vaadin 6.2 yet; you should
use <tt>http://vaadin.com/eclipse/experimental</tt> as the URL for the
experimental plugin that supports the upcoming Vaadin 6.2.</p>
<p>Vaadin @version@ is an update for Vaadin 6. In addition to various fixes, it
contains a number of significant enhancements.</p>
<ul>
<li>Widget set definition and component-to-widget mapping has been redesigned</li>
<ul>
<li>Reuse of widgets is now much easier, as it is easier to package and use widget set JARs and otherwise combine widget sets.</li>
<li>A widget set definition class is no longer used. Java code needed for widget instantiation and client-server mapping is
automatically generated by GWT compiler. For common Vaadin user, Widgetset is now only a GWT module definition file (.gwt.xml).</li>
<li>Server-side component is mapped to a client-side widget with an annotation:
<pre>@ClientWidget(com.vaadin.demo.colorpicker.gwt.client.ui.VColorPicker.class)
public class ColorPicker extends AbstractField {</pre>
</li>
<li>The <tt>getTag()</tt> method is no longer needed</tt></li>
<li>The Vaadin Plugin for Eclipse can create new widget stubs, define the mapping, and create widget set definition files (<tt>.gwt.xml</tt>).</li>
<li>See <tt>WebContent/docs/example-source/build-widgetset.xml</tt> for example on how you can compile widget sets and widget set JARs with Ant.</li>
<li>A widget set builder allows automatic generation and maintenance of widget configurations, making use of widget set JARs easier.</li>
</ul>
<li>Other enhancements to development of new components</li>
<ul>
<li>On the server-side:</li>
<ul>
<li>Listeners are now easier to implement the <b>ReflectTools</b>
and with <tt>addListener(String eventIdentifier, Class<?>
eventType, Object target, Method method)</tt> methods that
automatically inform the client-side that a listener is registered)</li>
</ul>
<li>On the client-side:</li>
<ul>
<li>Ability to check if a listener is registered on server side</li>
<li>Typed arrays and maps can now be sent to server with <tt>updateVariable()</tt></li>
</ul>
</ul>
<li>Refactoring widget sets has also provided some optimizations for rendering</li>
<li>Portlet 2.0 (JSR 268) support (no separate servlet, no session problems, portlet-to-portlet communication, etc)</li>
<li>OSGi support</li>
<li>Enhanced sorting of <b>IndexedContainer</b> and <b>BeanItemContainer</b></li>
<li>New layout in Sampler and several new examples</li>
<li>JavaScript injection with <tt>Window.excecuteJavaScript()</tt>, "the method that you never want to use, but that is nice to have"</li>
<li><b>Tree</b> style generator, <b>TabSheet</b> close button, plus dozens of other small enhancements and bug fixes</li>
</ul>
<p>Problem fixes and enhancements planned for upcoming releases can be found from the <a
href="http://dev.vaadin.com/roadmap">Vaadin Roadmap</a> in Vaadin Trac.</p>
<p>As always, when upgrading from an earlier version, you should recompile any custom
widget sets and refresh your project in Eclipse. If you are upgrading from earlier than
6.1.0, notice that Vaadin 6.1 uses GWT 1.7.0 (included in the installation package). See
<a href="#upgrading">General Upgrade Notes</a> for more details on upgrading.</p>
<h2><a name="upgrading">General Upgrade Notes</a></h2>
<p>When upgrading from an earlier version of the Vaadin library, you should always do the following:</p>
<ol>
<li>Install the new Vaadin JAR to your project</li>
<ul>
<li>If using the Vaadin Plugin in Eclipse, download and select the new version in project preferences.</li>
</ul>
<li>Install new GWT JARs if the GWT version has changed</li>
<ul>
<li>The Eclipse plugin will download the new GWT automatically when you update the Vaadin version; you will need to update GWT paths in the widget set compilation launch configurations in Eclipse (<a href="http://dev.vaadin.com/ticket/3286">#3286</a>).
</ul>
<li>If you have custom widget sets, recompile them with the new Vaadin library using the included GWT compiler</li>
<li>If using the Eclipse IDE:
<ol type="a">
<li>Refresh the Eclipse project by selecting the project folder and pressing <strong>F5</strong></li>
<li>Restart the application server</li>
</ol>
</ol>
<p>Using the Vaadin project facet in the Eclipse IDE does the steps 1 and 2 automatically.</p>
<h2><a name="upgrading-tk5">Instructions for Upgrading from IT Mill Toolkit 5</a></h2>
<p>While the Vaadin 6 API is otherwise mostly backward-compatible with IT Mill Toolkit 5.4, the
change of the product name has made it necessary to reflect it in the Java package names,
some name prefixes, and some other details.</p>
<h3>Server-side Upgrade Instructions</h3>
<ul>
<li>Java Package names have changed:</li>
<ul>
<li>In all Java files using IT Mill Toolkit, rename package prefix <tt>com.itmill.toolkit</tt> → <tt>com.vaadin</tt></li>
<li>You also need to update the <tt>web.xml</tt> deployment descriptor:</li>
<ul>
<li>The servlet class is now <strong>com.vaadin.terminal.gwt.server.ApplicationServlet</strong>.</li>
</ul>
</ul>
<li>Changes in themes:
<ul>
<li>Rename <tt>WebContent/ITMILL</tt> → <tt>WebContent/VAADIN</tt></li>
<ul>
<li>If you have extracted the built-in themes and widgetsets in IT Mill Toolkit JAR to the folder to have them served statically by the server, remove the old content and re-extract from Vaadin JAR.</li>
<li>This may require changes to build scripts for custom widgetsets, as well as to any code that relies on the old naming (it is discouraged but possible).</li>
</ul>
<li>The new "<tt>reindeer</tt>" theme is the default theme in Vaadin; the old
"<tt>default</tt>" theme in IT Mill Toolkit 5 has been renamed as "<tt>runo</tt>"</li>
<ul>
<li>There is no longer a theme with name "<tt>default</tt>"</li>
<li>In your custom theme, replace:
<table><tr><td></td><td><tt>@import "../default/styles.css";</tt></td></tr>
<tr><td align="right">→</td><td><tt>@import "../reindeer/styles.css";</tt></td><td>if you wish to use the new default theme,</td></tr>
<tr><td align="right">or →</td><td><tt>@import "../runo/styles.css";</tt></td><td>if you wish to use the old default theme.</td></tr></table></li>
<li>Use the new default theme with <tt>setTheme("reindeer")</tt> and the old one with <tt>setTheme("runo")</tt>.</li>
</ul>
<li>CSS class names now start with "<tt>v-</tt>" prefix instead of "<tt>i-</tt>"</li>
<ul>
<li>Search and replace "<tt>.i-</tt>" → "<tt>.v-</tt>" in custom themes </li>
</ul>
</ul>
<li>Embedding Vaadin applications in web pages:</li>
<ul>
<li>The name of the JavaScript variable used for launching applications has changed from "<tt>itmill.toolkitConfigurations</tt>" → "<tt>vaadin.vaadinConfigurations</tt>"</li>
</ul>
<li>Other changes in naming:</li>
<ul>
<li>Rename references to <tt>translateToolkitUri()</tt> → <tt>translateVaadinUri()</tt> method in <strong>ApplicationConnection</strong> class.
</ul>
</ul>
<h3>Client-side Upgrade Instructions</h3>
<p>The following changes are relevant only if you have developed or integrated custom
client-side widgets with Google Web Toolkit (GWT).</p>
<ul>
<li>GWT 1.7 is required for compiling custom widgets (optional)</li>
<ul>
<li>You need to upgrade GWT</li>
<li>The GWT Compiler class name has changed:</li>
<ul>
<li>Replace <tt>com.google.gwt.dev.GWTCompiler</tt> → <tt>com.google.gwt.dev.Compiler</tt> in your widget set build script (Ant) or launch configuration (Eclipse).</li>
<li>Replace the output directory argument for the compiler with the new WAR output argument: <tt>-out</tt> → <tt>-war</tt>. The directory parameter for the argument remains unchanged.</li>
</ul>
</ul>
<li>The "<strong>I</strong>" (IT Mill) prefix in client-side widget classes has been changed to "<strong>V</strong>" (Vaadin), for example: <strong>IButton</strong> → <strong>VButton</strong>.</li>
<li>Rename <strong>IToolkitOverlay</strong> → <strong>VOverlay</strong>
</ul>
<h2><a name="gae">Notes and Limitations for Google App Engine</a></h2>
<p>The following instructions and limitations apply when you run a Vaadin application
under the Google App Engine.</p>
<ul>
<li><p>Applications must use <b>GAEApplicationServlet</b> instead of
<b>ApplicationServlet</b> in <tt>web.xml</tt>.</p></li>
<li><p>Session support must be enabled in <tt>appengine-web.xml</tt>:</p>
<pre> <sessions-enabled>true</sessions-enabled></pre>
</li>
<li><p>Avoid using the session for storage, usual App Engine limitations apply (no
synchronization, i.e, unreliable).</p></li>
<li><p>Vaadin uses memcache for mutex, the key is of the form
<tt>_vmutex<sessionid></tt>.</p></li>
<li><p>The Vaadin <b>WebApplicationContext</b> class is serialized separately into memcache
and datastore; the memcache key is <tt>_vac<sessionid></tt> and the datastore
entity kind is <tt>_vac</tt> with identifiers of the type <tt>_vac<sessionid></tt>.</p></li>
<li><p>DO NOT update application state when serving an <b>ApplicationResource</b> (e.g <b>ClassResource</b>.<i>getStream()</i>).</p></li>
<li><p>AVOID (or be very careful when) updating application state in a
<b>TransactionListener</b> - it is called even when the application is not locked and
won't be serialized (e.g <b>ApplicationResource</b>), and changes can thus go missing (it
should be safe to update things that can be safely discarded later - i.e valid only for
the current request)</p></li>
<li><p>The application remains locked during uploads - a progress bar is not possible</p></li>
</ul>
<h2><a name="oophm">Package for the experimental GWT Out-of-Process Hosted Mode</a></h2>
<p>We provide a separate (platform independent) installation package
(<tt>vaadin-oophm-@version@.tar.gz</tt>) for the
experimental Out of Process Hosted Mode (OOPHM) of GWT, which allows
debugging client-side code in GWT Hosted Mode with a regular web
browser. Using the OOPHM requires installing a browser plugin (available
for Mozilla Firefox, IE, and WebKit). See the manual section on OOPHM
for more details.</p>
<p>The Linux version of GWT Hosted Mode Browser is no longer compatible with Vaadin (<a
href="http://dev.vaadin.com/ticket/2299">#2299</a>), so the OOPHM is the only option for
debugging in hosted mode in Linux.</p>
<p>The GWT 1.7.0 version included in the OOPHM package is a custom
build from GWT trunk and is not 100% compatible with the official GWT
1.7.0 release (<a href="http://dev.vaadin.com/ticket/3270">#3270</a>).</p>
<p>As the OOPHM package is experimental and because there are
differences between the version packaged with Vaadin and the official
version of GWT, you should use it only for debugging purposes during
development. For production use, and generally when you absolutely do
not need to debug using OOPHM, you should compile your custom widget
sets with the regular Vaadin package for your platform.</p>
<h2><a name="known-problems">Important known problems in Vaadin @version@</a></h2>
<ul>
<li><p><a href="http://dev.vaadin.com/ticket/1155">#1155</a>:
Uncompressing the installation package fails in Windows if using the
default Zip uncompression. Uncompression gives (in Windows Vista) an
error message about too long filenames, and a more obscure message in
other versions of Windows. Workaround: use <a
href="http://www.7-zip.org/">7-Zip</a> or some other good unzip
program for Windows.</p></li>
<li><p><a href="http://dev.vaadin.com/ticket/2299">#2299</a>: The
Hosted Mode Browser does not work in Linux for debugging client-side
GWT code. You need to install the experimental OOPHM package instead
(see above) for development. For production, you should use the regular
package for Linux.</p></li>
<li>
<p><a href="http://dev.vaadin.com/ticket/3716">#3716</a>: OOPHM
Hosted Mode browser does not work in Firefox 3.0 with <tt>vaadin-oophm-6.x.x/gwt/plugins/firefox3/oophm-xpcom-ff3.xpi</tt>.
As a workaround, the old <tt>oophm.xpi</tt> plugin provided in the IT
Mill Toolkit 5.3.0 package works just fine with Vaadin OOPHM 6.1.4 and
later.</p>
</li>
</ul>
<p>For other known problems, see open tickets at developer site <a
href="http://dev.vaadin.com/">dev.vaadin.com</a>.</p>
<h2><a name="changelog">Change Log</a></h2>
<p>The following closed issues have been included in this release:</p>
<ul>
<li><a href="http://dev.vaadin.com/ticket/2719">#2719</a>: Sampler margin demo shows wide right margin without explanation</li>
<li><a href="http://dev.vaadin.com/ticket/2918">#2918</a>: Same application is loaded in different portlet instances</li>
<li><a href="http://dev.vaadin.com/ticket/3070">#3070</a>: Tree's Items should be easily styled</li>
<li><a href="http://dev.vaadin.com/ticket/3088">#3088</a>: ComboBox, If only one item is listed, pressing Enter should choose it, not discard</li>
<li><a href="http://dev.vaadin.com/ticket/3117">#3117</a>: Portlet 2.0 (JSR-286) support</li>
<li><a href="http://dev.vaadin.com/ticket/3234">#3234</a>: Component Event Listener Framework for all widgets/components</li>
<li><a href="http://dev.vaadin.com/ticket/3277">#3277</a>: MenuBar.MenuItem could have setVisible() method</li>
<li><a href="http://dev.vaadin.com/ticket/3323">#3323</a>: Redesign sampler main screen</li>
<li><a href="http://dev.vaadin.com/ticket/3386">#3386</a>: Add JUnit tests for ensuring compatibility with all supported application servers and portals</li>
<li><a href="http://dev.vaadin.com/ticket/3387">#3387</a>: Google AppEngine integration test</li>
<li><a href="http://dev.vaadin.com/ticket/3433">#3433</a>: BeanItemContainer's sort is not overridable</li>
<li><a href="http://dev.vaadin.com/ticket/3434">#3434</a>: IndexedContainer's compare is not overridable</li>
<li><a href="http://dev.vaadin.com/ticket/3499">#3499</a>: PopupView CSS style is broken</li>
<li><a href="http://dev.vaadin.com/ticket/3541">#3541</a>: VerticalLayout//HorizontalLayout/GridLayout/AbsoluteLayout/CSSLayout should support click events</li>
<li><a href="http://dev.vaadin.com/ticket/3544">#3544</a>: Implement support for focus/blur events in TextField</li>
<li><a href="http://dev.vaadin.com/ticket/3553">#3553</a>: Change nightly and develpoment version numbering</li>
<li><a href="http://dev.vaadin.com/ticket/3605">#3605</a>: Patch to avoid concurrent modification exceptions in EventRouter</li>
<li><a href="http://dev.vaadin.com/ticket/3640">#3640</a>: Update build-widgetsets.xml and verify it works</li>
<li><a href="http://dev.vaadin.com/ticket/3655">#3655</a>: ApplicationRunner logs unnecessary java.lang.ClassNotFoundExceptions</li>
<li><a href="http://dev.vaadin.com/ticket/3683">#3683</a>: TextField.setRows() API needs reworking</li>
<li><a href="http://dev.vaadin.com/ticket/3731">#3731</a>: Implement a simpler alternative to ApplicationContext.TransactionListener</li>
<li><a href="http://dev.vaadin.com/ticket/3740">#3740</a>: Tabsheet no longer fully serializable, doesn't work in GAE</li>
<li><a href="http://dev.vaadin.com/ticket/3754">#3754</a>: Add data.util.TextFileProperty</li>
<li><a href="http://dev.vaadin.com/ticket/3755">#3755</a>: Select throws IllegalArgumentException when browsing pages quickly</li>
<li><a href="http://dev.vaadin.com/ticket/3756">#3756</a>: Add support for passing a typed Object[] from client to server</li>
<li><a href="http://dev.vaadin.com/ticket/3757">#3757</a>: Add support for passing a typed map from client to server</li>
<li><a href="http://dev.vaadin.com/ticket/3759">#3759</a>: Cannot scroll to the last tab in a Tabsheet</li>
<li><a href="http://dev.vaadin.com/ticket/3760">#3760</a>: Scrollbars are missing in Safari/Chrome</li>
<li><a href="http://dev.vaadin.com/ticket/3762">#3762</a>: Dependency to javax/portlet/PortletRequest, won't work with GAE</li>
<li><a href="http://dev.vaadin.com/ticket/3772">#3772</a>: Add notifier interfaces for focus and blur events</li>
<li><a href="http://dev.vaadin.com/ticket/3775">#3775</a>: Optimize Tree rendering</li>
<li><a href="http://dev.vaadin.com/ticket/3776">#3776</a>: Server side junit test cases should be run automatically on each build</li>
<li><a href="http://dev.vaadin.com/ticket/3782">#3782</a>: ClassCastException when adding Window via addComponent</li>
<li><a href="http://dev.vaadin.com/ticket/3783">#3783</a>: ClickListener in Panel does not work</li>
<li><a href="http://dev.vaadin.com/ticket/3784">#3784</a>: Panel.setScrollTop does not work with invalid values</li>
<li><a href="http://dev.vaadin.com/ticket/3785">#3785</a>: Style names for MenuBar.MenuItem</li>
<li><a href="http://dev.vaadin.com/ticket/3786">#3786</a>: Add focus and blur events to Select/VFilterSelect and DateField/VTextualDate</li>
<li><a href="http://dev.vaadin.com/ticket/3788">#3788</a>: Typo in setWriteThrough's parameter name</li>
</ul>
<h2><a name="requirements">Requirements</a></h2>
<p>Vaadin is available for the following operating systems:</p>
<ul>
<li>Windows (see the Zip installation notice above)</li>
<li>Linux</li>
<li>Mac OS X Tiger (mac) or Leopard (leopard)</li>
<li>Other UNIX operating systems, such as Sun Solaris, using the installation package
for Linux.</li>
</ul>
<p>Vaadin supports Java Servlet API 2.3 and later versions and should work with
any Java application server that conforms to the standard. It supports the following
application servers:</p>
<ul>
<li>Apache Tomcat, version 4.1 or later</li>
<li>BEA WebLogic® Server, version 9.2 or later</li>
<li>IBM WebSphere® Application Server, version 6.1 or later</li>
<li>JBoss Application Server, version 3.2.8 or later</li>
<li>Jetty, version 5 or later</li>
<li>Glassfish, version 2 or later</li>
</ul>
<p>Vaadin supports the following browsers for using the applications made with
it:</p>
<ul>
<li>Mozilla Firefox 3</li>
<li>Internet Explorer releases 6, 7, and 8</li>
<li>Safari 3 and 4</li>
<li>Opera 9.6 and 10</li>
</ul>
<p>The support for browsers follows the support by GWT. The browsers are supported on both
Windows and Mac, if available. Firefox is supported also on Linux (Opera 10a1 works also
on Linux though also suffers from <a
href="http://dev.vaadin.com/ticket/2652">#2652</a>). There may be differences between the
exact versions of the supported browsers that may cause incompatibility with applications
made with Vaadin.</p>
<p>The following browsers are not supported but have been found to
work to a large degree:</p>
<ul>
<li>Safari 2, and 4 beta</li>
<li>Firefox 2</li>
<li>Google Chrome 1.0.x (available only for Windows)</li>
<li>iPhone (firmware 2.2)</li>
<li>Midori (0.1.2)</li>
<li>Epiphany (2.22.3), Galeon, and other Gecko-based browsers. Also WebKit-based Epiphany (2.22.3) works.</li>
<li>Konqueror 4.2 (3.5.x does not work)</li>
<li>Nokia Internet Tablet N800 and N810 (ITOS 2008, Opera-based browser).</li>
</ul>
<p>The reported versions are those that have been tested, though other versions may work
as well.</p>
<p>Nokia E-series phones, such as E90, have been known to work with older versions, but
not with Vaadin 6. Links, Lynx, and other text-based browsers do not
work.</p>
</div> <!-- /content-->
<div id="footer">
<span class="slogan">Vaadin – thinking of U and I<span>
</div> <!-- /footer -->
</body>
</html>
|
