Vaadin Framework @version@

Version @version@ built on @builddate@.

Release Notes for Vaadin Framework @version@

Overview of Vaadin @version-minor@ Release
Changes in Vaadin @version@
Enhancements in Vaadin @version-minor@
Backwards incompatible changes in Vaadin @version-minor@
Package contents
Vaadin @version@ dependencies
Upgrading to Vaadin @version-minor@
Known problems and limitations in Vaadin @version@
Supported technologies
Vaadin on the Web

Vaadin is a Java application development framework for building modern web applications that look great, perform well and make you and your users happy. Vaadin is available under the Apache 2 license (see license.html in the JAR).

Overview of Vaadin @version@ Release

Vaadin @version@ is a maintenance release that includes a number of important bug fixes.

Changes in Vaadin @version@

This release includes the following closed issues:

#8932: Custom build from 6.8
#8193: Enter ClickShortcut not working in a PopupView
#8584: Invalid behavior of multiselection for com.vaadin.ui.Table
#9136: Tree throws wrong ItemClickEvent in IE9 (when immediate is set to true)
#9139: TextArea in Internet Explorer
#9188: Error parsing maps with empty string as the last value
#7036: Enable scrollbars on a read-only RichTextArea
#8109: Iterating over Table multiselection causes multiple Vaadin SQLContainer full table scans
#8144: Can't use LoginForm inside an iframe
#9202: Test using Chrome 21
#6219: PDF viewer draws itself over floating Vaadin elements
#8230: TextField's input prompt is persisted if Alt is depressed while in focus (Chrome)
#8399: On IE 8 or Google Chrome 16, VOverlay components aren't display on top of Applet
#9148: Oracle TIMESTAMP not supported in SQLContainer
#9189: Variables sent to the DragAndDropManager are not logged in the debug console
#9128: Typo in vaadin book
#8736: com.vaadin.ui.Table component return null value on multiple selection
#9132: No entries in Table with a defined pageLength causes Table to shrink in height
#9147: SQLContainer Filters - Comparison against NULL value produces error
#9154: NumberFormatException in client-side component VSplitPanel
#9171: StreamVariable never cleaned up in CommunicationManager
#9187: No horizontal scroll bar on empty Table
#8838: Drag and Drop in Google Chrome causes ArrayIndexOutOfBoundsException in AbstractCommunicationManager#convertMap (1612)
#8917: input prompt text is leaking into the component's value

The full list of the closed issues can be found at dev.vaadin.com.

Enhancements in Vaadin @version-minor@

Below is a list of enchacements in the current minor release branch, first released in @version-minor@.0.

Native scrolling support for Android and iOS (#8763)
- Non-native scrolling implementation used in iOS 5 because of an iOS bug (see #8792)
Possibility to fire Button click events on the server-side (#8209)
Possibility to use HTML inside a Button caption (#8663)
Possibility to set "alternative text" (alt attribute) for the Embedded component (#6085)
Possibility to query the browser window width and height on the server-side (#5655)
Keyboard navigation in TabSheet (#5100)
Max/min limits for splitter position in SplitPanel (#1744)
Extended day range in month view to six full weeks in DateField (#6718)
Non-collapsible Table columns (#7495)
Selecting a TabSheet tab by its position or a Tab instance (#8203)
Getting a component by its index or the index of a given component in CssLayout (#7614)
Removing all Validators of a Field at once (#8307)
Debug IDs unique to a window, not the whole application (#5109)
Larger default size for the debug window (#8523)
Compatibility with Google SuperDevMode (#8924)
An add-on for handling broken classloaders (#8447)
- Available in Vaadin Directory: Vaadin-application-server-class-loader-workaround

Package Contents

Vaadin Framework is distributed as a single JAR file. Inside the JAR you will find:

Vaadin server and client side classes (/com)
Vaadin server and client side sources (/com)
The default widget set (/VAADIN/widgetsets)
Themes: Runo, Reindeer and Chameleon (/VAADIN/themes)
Release notes (/release-notes.html)
Licensing information (/license.html)

Vaadin @version@ dependencies

Vaadin uses GWT @gwt-version@ for widget set compilation. GWT can be downloaded from http://code.google.com/webtoolkit/. GWT can also be automatically downloaded by the Vaadin Plug-in for Eclipse. Please note that GWT @gwt-version@ requires the validation-api-1.0.0.GA.jar and validation-api-1.0.0.GA-sources.jar files in addition to gwt-dev.jar and gwt-user.jar for widget set compilation.

Upgrading to Vaadin @version-minor@

When upgrading from an earlier Vaadin version, you must:

Recompile your classes using the new Vaadin JAR. Binary compatibility is only guaranteed for maintenance releases of Vaadin.
Recompile any add-ons you have created using the new Vaadin JAR.
Recompile your widget set using the new Vaadin JAR and the newly compiled add-ons.
If you have extracted a theme from the Vaadin JAR, you need to update it with the theme provided in the new Vaadin JAR.

Remember also to refresh the project in your IDE to ensure that the new version of everything is in use.

Using the "?debug" URL parameter you can verify that the version of the servlet (JAR), the theme and the widgetset all match.

Eclipse users should always check if there is a new version of the Eclipse Plug-in available. The Eclipse Plug-in can be used to update the Vaadin version in the project (Project properties » Vaadin).

Maven users should update the Vaadin dependency version in the pom.xml unless it is defined as LATEST . You must also ensure that the GWT dependency uses the correct version and recompile your project and your widget set.

Liferay and other portal users must install the new vaadin-@version@.jar as ROOT/WEB-INF/lib/vaadin.jar in the portal. Additionally the contents of the VAADIN folder from the JAR must be extracted to the ROOT/html/VAADIN directory in the Liferay installation. If your portal uses custom widgets, install the latest version of Vaadin Control Panel for Liferay for easy widget set compilation.

Upgrading from Vaadin 6.5 or earlier

If you are upgrading from 6.5.x or earlier, notice that Vaadin @version@ uses GWT @gwt-version@. Upgrade your dependencies as necessary. See the dependencies section for more information.

Upgrading from Vaadin 6.1 or earlier

The way widget sets are created was completely changed in Vaadin 6.2. Existing projects, where custom widgets (a custom widget set) are used, must be migrated when upgrading to Vaadin 6.2 or later. Projects where the default widget set is used do not need migration. See Vaadin 6.2.0 release notes for more details.

Notes and Limitations for Google App Engine

The following instructions and limitations apply when you run a Vaadin application under the Google App Engine.

Applications must use GAEApplicationServlet instead of ApplicationServlet in web.xml.
Session support must be enabled in appengine-web.xml :
```
    <sessions-enabled>true</sessions-enabled>
```
Avoid using the session for storage, usual App Engine limitations apply (no synchronization, i.e, unreliable).
Vaadin uses memcache for mutex, the key is of the form _vmutex<sessionid>.
The Vaadin WebApplicationContext class is serialized separately into memcache and datastore; the memcache key is _vac<sessionid> and the datastore entity kind is _vac with identifiers of the type _vac<sessionid>.
DO NOT update application state when serving an ApplicationResource (e.g ClassResource.getStream()).
AVOID (or be very careful when) updating application state in a TransactionListener or a HttpServletRequestListener - they are called even when the application is not locked and won't be serialized (e.g ApplicationResource), 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)
The application remains locked during uploads - a progress bar is not possible

For other known problems, see open tickets at developer site dev.vaadin.com.

Supported technologies

Vaadin is based on Java 5 and it is also compatible with most other operating system supporting Java 5 or newer. Vaadin is supported on the following operating systems:

Windows
Linux
Mac OS X

Vaadin requires Java Servlet API 2.3 but also supports later versions and should work with any Java application server that conforms to the standard. The following application servers are supported:

Apache Tomcat, version 4.1-7.0
Oracle WebLogic® Server, version 9.2-10.3.5(11gR1)
IBM WebSphere® Application Server, version 6.1-8.0
JBoss Application Server, 3.2.8-7.0
Jetty, version 5.0-7.0
Glassfish, version 2.0-3.1

Vaadin supports JSR-168 and JSR-286 Portlet specifications. All portals that implement either of the portlet specifications should work. The following portals are supported:

Liferay Portal 5.2-6.0
GateIn Portal 3.1
eXo Platform 3
Oracle WebLogic® Portal 10gR3
WebSphere Portal 6.1-7.0

Vaadin also supports Google App Engine.

Vaadin supports the following browsers:

Mozilla Firefox 3-14
Internet Explorer 6-9
Safari 4-5
Opera 10-12
Google Chrome 13-21

Vaadin supports the built-in browsers in the following mobile operating systems:

iOS 4-5
Android 2-4

Vaadin – thinking of U and I