Version @version@ built on @builddate@.
Release Notes for Vaadin Framework @version@
- Overview of Vaadin @version@ Release
- Change log for Vaadin @version@
- Enhancements in Vaadin @version-minor@
- Incompatible changes in @version-minor@
- Behavior altering changes in @version-minor@
- Known issues in @version-minor@
- Limitations in @version-minor@
- Vaadin Installation
- Package Contents
- Migrating from Vaadin 6 to Vaadin 7
- Vaadin @version@ dependencies
- Upgrading to Vaadin @version-minor@
- Supported technologies
- Vaadin on the Web
Overview of Vaadin @version@ Release
Vaadin @version@ is a minor release that includes a number of new features and bug fixes, as listed in the list of enhancements and change log below.
Change log for Vaadin @version@
This release includes the following closed issues:
#4054 | Change ComboBox to be immediate by default | |
Vote | #7229 | Add option to support null intermediate properties in NestedMethodProperty |
#8012 | DateField click-n-hold bug with multiple onMouseDown events | |
#8029 | Change setImmediate default to true for most components | |
#8168 | Table.propertyValueConverters should be cleaned when a property id is removed | |
#9153 | LayoutManager missing methods | |
#9269 | Change UIDL request payload to be valid JSON | |
#9379 | Optimize generated code size | |
#9814 | DragAndDropWrapper should only start dragging when the primary mouse button is pressed | |
#9997 | Add StringToBigDecimalConverter | |
#10015 | Update Link to use state and rpc | |
#10338 | Immediately clean up old UI when loading new | |
#10392 | Unhelpful error message if using generics in RPC interface | |
#10446 | Fix memory problem of BeanItem/MethodProperty | |
#10618 | PopupView doesn't display caption | |
#11054 | @PreserveOnRefresh looses page title on refresh | |
#11257 | Remove multiple variable burst support from UIDL communication | |
Priority | #11324 | BeanValidator uses HTML in error message, that is being escaped |
#11367 | Vaadin 7 Accordion - Problem 2 | |
#11409 | Move DragAndDropService to VaadinSession | |
#11435 | NestedMethodProperty and null values | |
#11599 | Stack traces generated by DefaultErrorHandler are ridiculous | |
Vote | #11744 | Allow Overriding Cache Time for certain files |
#11758 | VaadinServlet isStaticResourceRequest incorrect/inefficient | |
#11803 | Javadoc of @Widgetset annotation speaks about defining a theme | |
#11804 | Typo in UI class Javadoc | |
#11820 | Accessibility for Notification | |
#11821 | Accessibility for Window | |
#11823 | Tabsheet should not immediately select a tab when changing tab using keyboard | |
#11824 | Tabsheet tabs should support alternate text | |
#11826 | Support optional screen reader notification when a tab is added or removed | |
#11827 | Accessibility for TabSheet | |
#11830 | Support screen reader only notifications | |
#11874 | Prevent to exit a (Sub)Window with the tab key | |
#11947 | Long File Size is not supported in VHtml5File and DragAndDropWrapper | |
#12064 | Add support for setId to TabSheet.Tab | |
#12092 | StringToNumberConverter should be removed | |
#12120 | Support websockets with Glassfish4 | |
Priority | #12139 | with push enabled, session is not destroyed |
#12159 | Switch back to master branch of GWT (Vaadin 7.2) | |
#12180 | Add shorthand for recursively measuring child components | |
Vote | #12191 | Provide reload event for UI classes with @PreserveOnRefresh |
#12251 | Add ServiceDestoryListener | |
#12255 | @PreserveOnRefresh might cause problems with multiple UIs on the same page | |
#12257 | When selecting a Tab, screen reader reads out all the tabs | |
#12265 | Prevent SynchronizedRequestHandler from locking just to determine it doesn't handle the request | |
#12269 | Invoke the connector's ErrorHandler for exceptions in ConnectorResourceHandler | |
#12276 | Opening (Sub)Window requires assistive description to be set | |
#12291 | Add a StringToLongConverter | |
#12292 | Ensure pending access queue race condition is fixed | |
Priority | #12307 | VaadinServlet handleContextRootWithoutSlash incorrect when URL contains ;jsessionid |
#12321 | Alt text on button icon does not appear | |
#12323 | Responsive Addon not working on IE8 window resize | |
#12329 | Support Tomcat 8 | |
Priority | #12337 | VScrollTable does not stop timer on detach |
#12344 | Can set focus outside modal Window with Tab key | |
#12353 | Setting page title dynamically broken | |
#12394 | Integrate the Reponsive add-on | |
#12414 | Changing value in Label doesn't fire value change event | |
#12421 | Use GWT git repository instead of GWT subversion repository | |
#12461 | StringIndexOutOfBoundException is thrown if UI class is in default package | |
#12466 | Add support for poll listeners | |
#12517 | aria-invalid attribute is not removed after successful validation | |
#12525 | The user should be able to trigger MenuBar actions/submenus the the space key also | |
#12536 | ComboBox Tooltip not handled on Focus | |
#12550 | Slider doesn't update correctly with window re-sizing | |
#12601 | Upgrade to atmosphere-runtime 2 | |
Priority | #12612 | Duplicate Session Destroy notifications delivered on session shutdown when proxied |
Vote | #12629 | Support IE 11 |
#12710 | 7.2 build fails with new GWT | |
#12713 | Update vaadin-deps to contain new Guava | |
Priority | #12714 | v-table-header-drag element should reside inside v-overlay-container element |
#12765 | DefaultWIdgetSet cannot be compiled | |
#12780 | NativeButton.setIconAlternateText has no effect | |
#12825 | Remove obsolete field "width" from VNativeButton | |
#12843 | On session timeout, client UIs are not properly notified | |
#12849 | When component with tooltip is focused with tab, screen reader reads a wrong component. | |
#12860 | Merge upstream GWT IE10 changes | |
#12871 | Update GWT dependencies | |
#12873 | Generated createWidget() does not work for widgets with generics | |
#12900 | @DelegateToWidget does not work with widget using generics | |
#12902 | TestBench3 selectors fail on paths with domChild | |
#12904 | ComponentLocator and LocatorStrategy implementations are intra-dependent | |
#12925 | Page.setLocation should use window name "_self" | |
#12931 | Notifications do not support Position.MIDDLE_LEFT and MIDDLE_RIGHT | |
Priority | #12944 | TabSheet does state change event before creating DOM |
#12958 | Simplify state change event handling | |
#12959 | Use JSNI in generated invokers to support non-public methods | |
#13011 | Support long polling for push | |
#13020 | VaadinFinderLocatorStrategy should return paths for elements | |
#13053 | Make it possible to retrieve all VaadinSession inside a HTTP session | |
#13067 | Selects should have convenience method to add items with varargs parameter | |
#13068 | Binding a simple bean to fields from a view object requires 4 lines | |
#13073 | Support Date in state + rpc | |
#13080 | vaadin-push depends on two versions of compat-tomcat | |
#13081 | Enable JUnit tests to be run on shared classes | |
#13082 | IE8 does not work with long polling | |
#13083 | Upgrade to atmosphere-javascript 2.0.8 | |
#13124 | DateField in disabled layout | |
#13127 | Creating an UI with only Windows breaks first window | |
#13152 | Support font icons | |
#13156 | DatePicker client-side disabled state works incorrectly after calling setUseNative(true) | |
#13164 | Create long polling versions of all push tests | |
#13196 | Atmosphere-runtime pre-2.1.0 does not support Jetty 9.1 | |
#13199 | Atmosphere init failure should be nonfatal | |
#13206 | Clicking on the active tab in a TabSheet doesn't focus it | |
#13209 | Missing javadoc for Field interface | |
#13222 | com.vaadin.ui.Upload introduce new "SelectionListener" | |
#13223 | Refactor PushConnection | |
#13252 | ICU4J should not be in client-compiler-deps | |
#13259 | Re-enable Opera 12 permutation | |
#13274 | Collapse all GWT permutations by default | |
#13277 | Consider updating to android sdk json | |
#13287 | Replace c.g.g.u.c.Element with c.g.g.d.c.Element | |
#13300 | Snapshot build broken | |
#13329 | CustomDateFormat test fails because legacy locator is not 100% compatible | |
#13350 | Websockets do not work with multiple servlets on Tomcat 8 | |
#13367 | window.prompt is not supported on Metro versions of IE | |
#13368 | Dragging doesn't work on IE on a touch screen | |
#13372 | MenuBar / MenuItem does not support FontIcon | |
#13373 | Notification does not support FontIcon | |
#13374 | Consider enabling the Atmosphere protocol | |
#13375 | Actions do not support FontIcon | |
#13376 | ComboBox items do not support FontIcon | |
#13383 | Vaadin 7.2 (SNAPSHOT) broken on Glassfish 4 | |
#13384 | Support Wildfly 8 | |
#13395 | Re-add Opera 12 support | |
#13399 | Wrong behaviour of Table#setColumnAlignment(Object, Align) | |
#13402 | Update TabSheet and Accordion to use Vaadin 7 style | |
#13405 | Verify we do not use multiple versions of the same dependency | |
#13409 | Change the default push fallback to long polling | |
Priority | #13410 | vaadin-shared-deps bundle doesn't confirm to the OSGi version requirement |
Priority | #13421 | unable to enter a modal window via tabbing once you exit it |
#13427 | OSGi: vaadin-push has unsatisfied dependency | |
#13430 | Title should not be set to null | |
#13445 | Clicking the window header doesn't move it to the top | |
#13446 | Button should have constructor with just icon Resources | |
#13449 | Ensure license info is up to date | |
#13460 | com.vaadin.data.util.filter.Like accepts String as property id | |
#13473 | Improve error message when attaching component from a different session | |
#13502 | Add "incompatible changes" section to release notes | |
#13514 | BroadcasterCache must be used | |
#13516 | VerticalLayout and HorizontalLayout insert additional icons for contained components | |
#13518 | javadoc is incorrect at com.vaadin.shared.ui.label.ContentMode | |
#13528 | Race condition in Atmosphere when initializing two VaadinServlets at the same time | |
#13529 | Session expired not shown for websocket connections | |
#13531 | Use the same version of commons-io in all modules | |
#13532 | Override the sass-compiler's cssparser version | |
#13542 | Discourage use of LayoutManager.setNeedsLayout while a layout is running | |
#13545 | JSONCodec inefficiecies | |
#13548 | Responsive tutorial | |
#13549 | Support pointer events for IE10+IE11 | |
#13550 | Button mousedown - mouseout - mouseover - mouseup should cause click | |
#13551 | Improve extending portlet requests for accessing servlet requests | |
#13556 | findUI throws NullPointerException | |
#13557 | DnD in WRAPPER drag start mode doesn't show text area text in drag image. | |
#13560 | Atmosphere warning appears with default new project: No BroadcasterCache configured. | |
#13568 | AbstractOrderedLayout.replaceComponent should also apply layout settings to the new component | |
#13578 | Push reconnect fails after a network failure when using long-polling with Firefox | |
Priority | #13583 | Vaadin does not handle URL-encoded request URL parameter values properly |
#13593 | PopupView is broken | |
#13598 | Disable animations in popup view until fixed | |
#13612 | Correct release notes | |
#13613 | Update GWT to latest upstream master | |
#13617 | NPE when session expires if session expiration messages texts have been removed | |
#13620 | Vaadin7.2beta: Reloading PreserveOnrefresh App with Push fails with NPE, due to PushConnection being null from disconnect | |
#13625 | Update to TestBench 4.0.0.alpha1 | |
#13651 | Vaadin7.2beta: Upgrade saas compiler version | |
#13655 | NoSuchElement exception on DnD to the table without data. | |
#13682 | SuperDevMode broken with 7.2.0.beta1 | |
#13685 | Move v-loc of bootstrap.js from GET to POST parameter | |
#13692 | Widgetset compilation fails with primitive 'long' field in shared state | |
#13706 | TabSheet too narrow on IE8 | |
#13716 | AtmospherePushConnection.disconnect() does not actually close the connection | |
#13719 | Re-enable animations in popup view | |
Priority | #13720 | Legacy event handling is not aware of PointerEvents |
#13723 | Button Icons and Error Indicators can change places | |
#13727 | Push reconnect doesn't work properly after a network failure with IE & long-polling | |
#13729 | Delete deprecated c.v.c.ComponentLocator | |
#13731 | Combobox does not render icons correctly | |
Vote | Enhancements Vaadin support users have voted for | |
Priority | Defects Vaadin support users have prioritized |
You can also view the list of the closed issues at the Vaadin developer's site.
Enhancements in Vaadin @version-minor@
The @version-minor@ includes many major and minor enhancements. Below is a list of the most notable changes:
- Internet Explorer 11 support
- Window Phone 8.1 support
- Long polling support through Atmosphere 2
- Font icon support
- Tomcat 8 support
- Wildfly 8 support
- Websocket support for Tomcat 8, Glassfish 4, Jetty 9.1, Wildfly 8
- TestBench 4 support
- GWT 2.6 compatibility
- Widget set size reduction
- Widget set compilation speed improvement by collapsing all permutations
- New built-in converters: StringToBigDecimal, StringToLong
- New built-in support for Date in communication
- WAI-ARIA improvements: Window, Notification, TabSheet
- Sass compiler is a separate project
- Support for @OnStateChange for easier state handling
- Reload events for UIs with @PreserveOnRefresh
- Responsive layouts
For enchancements introduced in Vaadin 7, see the Release Notes for Vaadin 7.0.0.
Incompatible changes
- It is assumed that the UI will no longer be used after Page.setLocation is called. Do not use this to start downloads.
- The portlet requests class VaadinGateinRequest is now called VaadinGateInRequest
- The JSON library has been changed from org.json to the json implementation from the Android SDK. They are 99% compatible.
- StringToNumberConverter has been removed in favor of more specific converters such as StringToBigDecimalConverter.
- There is no longer support for "multiple variable bursts" in the UIDL communication.
Behavior altering changes
- Default push fallback is now long-polling
- VerticalLayout and HorizontalLayout.replaceComponent now applies old component parameters (e.g. expand ratio) to the new component. This is now consistent between all layouts in the framework, where relevant properties are applied to the replacement.
- All GWT permutations are collapsed when using DefaultWidgetSet. To use separate permutations, inherit Vaadin instead of DefaultWidgetSet and add the needed entry-point.
- Requests to "/context;jsessionid=xyz" are redirected to "/context/;jsessionid=xyz" which is against specifications but based on how jsessionid is used
- Adding a ValueChangeListener to a component will make it immediate
- ComboBox is immediate by default
Known issues
- Drag'n'drop in a Table doesn't work on touch devices running Internet Explorer (Windows Phone, Surface) (#13737)
Limitations
- It is currently not possible to specify font-size as em or %, or layout component sizes with em (#10634)
- Push is currently not supported in portals (See #11493)
- HTTP session can not be invalidated while using push over websockets on Tomcat 7 (#11721)
- Cookies are not available while using websockets (#11808)
- Not all proxies are compatible with websockets or streaming. Use long polling to avoid these problems.
Vaadin Installation
Vaadin is a Java framework for building modern web applications that look great, perform well and make you and your users happy. Vaadin is available under the Apache License, Version 2.0 (see the license.html in the Vaadin ZIP or JAR package).
The easiest ways to install Vaadin are:
- If using Maven, define it as a dependency or use any of the available archetypes (only vaadin-application is available for Vaadin 7 at the time of this release) to create a new project
- If using Eclipse, use the Vaadin Plugin for Eclipse, which automatically downloads the Vaadin libraries.
It is also available as a ZIP package downloadable from Vaadin Download page.
Package Contents
Inside the ZIP installation package you will find:
- Separate server-side (vaadin-server) and client-side (vaadin-client, vaadin-client-compiler) development libraries
- Precompiled widget set (vaadin-client-compiled) for server-side development
- Shared library (vaadin-shared) for both server- and client-side libraries
- Built-in themes (vaadin-themes)
- Dependency libraries provided under the lib/ folder
See the README.TXT in the installation package for detailed information about the package contents. Book of Vaadin (for Vaadin 7) gives more detailed instructions.
For server-side development, copy the vaadin-server , vaadin-client-compiled , vaadin-shared , and vaadin-themes from the main folder and the dependencies from the lib folder to the WEB-INF/lib folder of your Vaadin project. (The vaadin-client-compiled is necessary if you do not wish to compile the widget set by your own, which you need to do if you use almost any add-on components.)
Updates to the Packaging
Since Vaadin 7.2.0, the old vaadin-theme-compiler has been moved into a separate project and renamed to vaadin-sass-compiler. It is now included along with the other 3rd party dependencies in the ZIP package.
For pure client-side development, you only need the vaadin-client and vaadin-client-compiler JARs, which should be put to a non-deployed project library folder, such as lib . You also need them if you compile the widget set for any reason, such as using Vaadin add-ons, or create new server-side components integrated with client-side widgets.
Migrating from Vaadin 6
All Vaadin 6 applications need some changes when migrating to Vaadin 7. The most obvious changes are in the application/window API and require extending either UI or UI.LegacyApplication instead of Application. A detailed list of migration changes are given in the Vaadin 7 Migration Guide.
Any custom client-side widgets need to be ported to use the new client-server communication API, or the Vaadin 6 compatibility API.
Vaadin 6 add-ons (ones that contain widgets) do not work in Vaadin 7 - please check the add-ons in Vaadin Directory for Vaadin 7 support.
Vaadin @version@ Dependencies
When using Maven, Ivy, Gradle, or other dependency management system, all Vaadin dependencies are downloaded automatically. This is also the case when using the Vaadin Plugin for Eclipse.
The Vaadin ZIP installation package includes the dependencies in the lib subfolder. These need to be copied to the WEB-INF/lib folder of the web application that uses Vaadin.
The dependencies are listed in the Licensing description. Some are explicit dependencies packaged and distributed as separate JARs, while some are included inside other libraries.
Bean Validation
If you use the bean validation feature in Vaadin 7, you need a Bean Validation API implementation. You need to install the implementation JAR in the WEB-INF/lib directory of the web application that uses validation.
Upgrading from Vaadin 7.1 to Vaadin @version-minor@
When upgrading from an earlier Vaadin version, you must:
- Recompile your classes using the new Vaadin version. Binary compatibility is only guaranteed for maintenance releases of Vaadin.
- Unless using the precompiled widget set, recompile your widget set using the new Vaadin version.
Remember also to refresh the project in your IDE to ensure that the new version of everything is in use.
By using the " ?debug " URL parameter, you can verify that the version of the servlet, the theme, and the widget set 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
Vaadin libraries in
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 GAEVaadinServlet instead of VaadinServlet 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, that is, unreliable).
-
Vaadin uses memcache for mutex, the key is of the form _vmutex<sessionid> .
-
The Vaadin VaadinSession 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 ConnectorResource (such as ClassResource.getStream()).
-
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 7 is compatible with Java 6 and newer. Vaadin 7 is especially supported on the following operating systems:
- Windows
- Linux
- Mac OS X
Vaadin 7 requires Java Servlet API 2.4 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 5-8
- Apache TomEE 1
- Oracle WebLogic Server 10.3-12
- IBM WebSphere Application Server 7-8
- JBoss Application Server 4-7
- Wildfly 8
- Jetty 5-9
- Glassfish 2-4
Vaadin 7 supports the JSR-286 Portlet specification and all portals that implement the specification should work. The following portals are supported:
- Liferay Portal 5.2-6
- GateIn Portal 3
- eXo Platform 3
- IBM WebSphere Portal 8
Vaadin also supports Google App Engine.
Vaadin @version@ supports the following desktop browsers:
- Mozilla Firefox 18-29
- Mozilla Firefox 17 ESR, 24 ESR
- Internet Explorer 8-11
- Safari 6-7
- Opera 12, 16-20
- Google Chrome 23-34
Additionally, Vaadin supports the built-in browsers in the following mobile operating systems:
- iOS 5-7
- Android 2.3-4
- Windows Phone 8
Vaadin SQL Container supports the following databases:
- HSQLDB
- MySQL
- MSSQL
- Oracle
- PostgreSQL
Vaadin on the Web
- vaadin.com - The developer portal containing everything you need to know about Vaadin
- vaadin.com/demo - A collection of demos for Vaadin
- vaadin.com/learn - Getting started with Vaadin
- vaadin.com/forum - Forums for Vaadin related discussions
- vaadin.com/book - Book of Vaadin - everything you need to know about Vaadin
- vaadin.com/api - Online javadocs
- vaadin.com/directory - Add-ons for Vaadin
- vaadin.com/pro-tools - Commercial tools for Vaadin development
- vaadin.com/support - Commercial support for Vaadin development
- vaadin.com/services - Expert services for Vaadin
- vaadin.com/company - Information about the company behind Vaadin
- dev.vaadin.com - Bug tracker
- How to get the source code of Vaadin