Vaadin – thinking of U and I

Version @version@ built on @builddate@.

Release Notes for Vaadin @version@

• Overview
• General Upgrade Notes
• Instructions for Upgrading from IT Mill Toolkit 5
• Important known problems in Vaadin @version@
• Change Log
• Requirements

Vaadin @version@ is an update release for Vaadin 6. In addition to various fixes, it contains a number of significant enhancements.

Enhancements

• Enhanced keyboard navigation in Table, Tree, DateField, Slider, and many other components

  • In Table and Tree multiselect mode, selecting multiple items now requires pressing Ctrl. Use setMultiSelectMode() with MultiSelectMode.SIMPLE for multiselect without the Ctrl key. (#3520, #4259)

• Table enhancements:
  • Footer - great for calculating sums, etc. Use setFooterVisible(true) to enable the footer and setColumnFooter() to set the footer text for a specific column. (#1553)
  • Header (#4515) and footer (#4516) click listeners

  • Column resize events (ColumnResizeEvent), which can be handled with ColumnResizeListener

• Possibility for lazy loading of client-side components (aka GWT code splitting), which speeds up load times; see more details

• HTTP-level tester compatibility (JMeter, etc)

• DateField enhancements: input prompt, tab behavior and invalid date handling

• Indexed access to contained components in ordered layouts (VerticalLayout, HorizontalLayout, and FormLayout) with getComponentIndex() and getComponent(int index) (#4609)

• Programmatic selection of text range in TextField with selectAll() and setSelectionRange(), and cursor positioning with setCursorPosition (#5217)

• Ability to disable items in an OptionGroup with setItemEnabled() (#3720)

• Added getPortletConfig() access method to PortletApplicationContext2. It allows obtaining the portlet configuration, which provides access to resource bundles, portlet init parameters, etc. (#3988)

• There is a new TreeTable component (#955). It is not yet included in the core library, but is available for download from the Vaadin Directory.

In addition, a significant number of bug fixes and javadoc improvements have been made.
Quality has been ensured by extensive automated testing: 910/910 tests passed for this release.

Backward Incompatible API Changes

The following changes can break backward compatibility in applications using an earlier version of Vaadin:

• In AbsoluteLayout.ComponentPosition (#5311):

  • The setters and getters of floating-point properties now use Float instead of float to allow null values for indicating "unset" values. This change can cause compile-time errors, which you may need to solve with proper casts.

  • The setCSSString() now resets attributes not present in the given parameter to their unset state, which may cause change application behavior without causing any compile- or runtime-errors.

• In the rare case that you have extended the DefaultWidgetSet class, please notice that earlier, the custom entry point was defined in the .gwt.xml file as follows:

      <entry-point class="com.example.MyExtendedWidgetSet" />

  Now you need to write as follows:

      <replace-with class="com.example.MyExtendedWidgetSet">
          <when-type-is class="com.vaadin.terminal.gwt.client.WidgetSet" />
      </replace-with>

Change Log, Future Releases, and Upgrading

See the Change Log for a full list of tickets fixed in this release.

Problem fixes and enhancements planned for upcoming releases can be found in the Vaadin Roadmap in Vaadin Trac.

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.3.0, notice that Vaadin 6.4 uses GWT 2.0 (included in the installation package). See General Upgrade Notes for more details on upgrading.

Upgrading from Vaadin 6.0 or 6.1

The way how widget sets are defined was simplified 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. For most projects this should be a quite painless upgrade.

For applications where custom widgets are used (also applicable to widget projects):

• Remove the getTag() method from all components and replace it with a @ClientWidget(VClientSideWidget.class) annotation. Tag names are no longer used to map the server-side and client-side part of the component. This is done automatically using the @ClientWidget annotation.
• Remove the WidgetSet.java file. This file is no longer needed as the mapping between the server- and the client-side is done automatically using @ClientWidget.

If you are using widgets from another project (typically in a separate JAR file):

• Acquire a new JAR which is compatible with Vaadin 6.3 and add it to WEB-INF/lib. The widget set compilation will automatically include the JAR in your .gwt.xml during compilation if you use the Eclipse Compile Widget Set button. For Ant/Maven you need to specify the location of the widget set JARs that you want to include in the application widget set.

If you package a widget set as a JAR for use in other projects:

• Replace getTag() with @ClientWidget and remove the -WidgetSet.java as described above.
• Add a "Vaadin-Widgetsets: <fully qualified name of widgetset>" (e.g. "Vaadin-Widgetsets: com.example.widgetset.mywidgetset") row to the META-INF/MANIFEST.MF of the JAR file. This enables the widget set builder to automatically detect and include the widget set in other projects.

General Upgrade Notes

When upgrading from an earlier version of the Vaadin library, you should always do the following:

1. Install the new Vaadin JAR to your project
• If using the Vaadin Plugin in Eclipse, download and select the new version in project preferences.
2. Install new GWT JARs if the GWT version has changed
• The Eclipse plugin will automatically download the new GWT and update launch configurations and the project build path when you update the Vaadin version.
3. If you have custom widget sets, recompile them with the new Vaadin library using the included GWT compiler
4. If using the Eclipse IDE:
   1. Refresh the Eclipse project by selecting the project folder and pressing F5
   2. Restart the application server

Using the Vaadin project facet in the Eclipse IDE does the steps 1 and 2 automatically.

Instructions for Upgrading from IT Mill Toolkit 5

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.

Server-side Upgrade Instructions

• Java Package names have changed:
• In all Java files using IT Mill Toolkit, rename package prefix com.itmill.toolkit → com.vaadin
• You also need to update the web.xml deployment descriptor:
• The servlet class is now com.vaadin.terminal.gwt.server.ApplicationServlet.
• Changes in themes:
  • Rename WebContent/ITMILL → WebContent/VAADIN
  • 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.
  • 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).
  • The new "reindeer" theme is the default theme in Vaadin; the old "default" theme in IT Mill Toolkit 5 has been renamed as "runo"
  • There is no longer a theme with name "default"
  • In your custom theme, replace:

    	@import "../default/styles.css";
    →	@import "../reindeer/styles.css";	if you wish to use the new default theme,
    or →	@import "../runo/styles.css";	if you wish to use the old default theme.

  • Use the new default theme with setTheme("reindeer") and the old one with setTheme("runo").
  • CSS class names now start with "v-" prefix instead of "i-"
  • Search and replace ".i-" → ".v-" in custom themes
• Embedding Vaadin applications in web pages:
• The name of the JavaScript variable used for launching applications has changed from "itmill.toolkitConfigurations" → "vaadin.vaadinConfigurations"
• Other changes in naming:
• Rename references to translateToolkitUri() → translateVaadinUri() method in ApplicationConnection class.

Client-side Upgrade Instructions

The following changes are relevant only if you have developed or integrated custom client-side widgets with Google Web Toolkit (GWT).

• GWT 2.0 is required for compiling custom widgets (optional)
• You need to upgrade GWT
• The GWT Compiler class name has changed:
• Replace com.google.gwt.dev.GWTCompiler → com.google.gwt.dev.Compiler in your widget set build script (Ant) or launch configuration (Eclipse).
• Replace the output directory argument for the compiler with the new WAR output argument: -out → -war. The directory parameter for the argument remains unchanged.
• The "I" (IT Mill) prefix in client-side widget classes has been changed to "V" (Vaadin), for example: IButton → VButton.
• Rename IToolkitOverlay → VOverlay

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

Important known problems in Vaadin @version@

• #1155: 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 7-Zip or some other good unzip program for Windows.

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

Change Log

The following closed issues have been included in this release:

• #1086: Tree: Keyboard navigation
• #1553: Table: add footer element
• #2228: Cannot get multiple causes from InvalidValueException
• #2366: Optimize subtree rendering when becoming/losing width or height
• #2390: Keyboard navigation for Table
• #2497: Missing icons
• #2807: Table should update column size back to server
• #2974: Combobox with icon broken in reindeer theme
• #3161: Reindeer black window rounded borders look pixelated in Chrome
• #3520: Improve Table multiselect to use Ctrl and Shift for selection
• #3720: Disable Items for OptionGroup
• #3723: ComponentContainerers should have the possibility to give an index of some component.
• #3988: Provide access to portlet ResourceBundles
• #4259: Improve Tree multiselect to use Ctrl and Shift for selection
• #4311: DateField should not show stacktrace for invalid dates
• #4315: Window name generation should be deterministic
• #4317: VScrollTable should not update page length when hidden or disabled
• #4442: Fix differences script to use zip instead of tar.gz for previous version
• #4448: TextField input prompt focus timing problem with Firefox
• #4484: PropertyFormatter constructor calls format
• #4499: Chrome GWT development mode rendering broken
• #4515: Add support for Table header click listener
• #4516: Add support for Table footer click listener
• #4567: FormLayout doesn't focus the fields when clicking on their caption
• #4581: Dropdowns in a table auto-close when clicked in IE
• #4595: BeanItemContainer: no warning about use of Bean's hashCode
• #4609: Retrieving an index of a component in an AbstractOrderedLayout
• #4619: Gecko as user.agent for GWT doesn't work with Firefox 3.6
• #4631: Implement Runo theme demo application
• #4636: Checking a checkbox moves it 1 pixel down in IE6+IE7
• #4997: VFormLayout should copy component style names to the caption as well
• #5006: Table does not refresh header state when no rows exist
• #5008: Tree should ensure that the selected node is visible after navigation with the keyboard
• #5012: Self comparison of classId with itself in com.vaadin.ui.Embedded.setClassId(String)
• #5024: Table keyboard navigation blocks essential shortcuts
• #5026: WidgetSetBuilder creates duplicate references to non-Vaadin GWT modules
• #5030: ItemSetChangeEvent's in HierarchicalContainer are fired too early
• #5033: Widget not found error should reference to manual or another help page
• #5038: Window clicklistener is not working
• #5057: Keyboard support for TwinColSelect
• #5059: PopupView is not closed when focus is moved outside using tab
• #5060: Pressing ESC inside a ComboBox with input prompt shows an editable prompt
• #5061: Keyboard support for MenuBar
• #5063: RichTextArea class should have constructors
• #5065: Table should not receive focus if it is not in selectable mode and all rows are visible
• #5068: When moving focus to Tree or Table keyboard nav focus should be placed to the current selection
• #5079: AbsoluteLayout z-index parsing is picky
• #5091: RichTextArea with fixed height does not work
• #5099: Slider keyboard navigation
• #5102: Double click in TwinColSelect should move selected item
• #5104: "Table with setNullSelectionAllowed(false) can be visually ""set to null"" using the keyboard"
• #5110: Context menu should get keyboard focus when opened
• #5112: Table.focus() should not throw UnsupportedOperationException
• #5114: ClassPathExplorer should not use URL instances as map or set keys
• #5120: TableClickHandlers sample has extra scrollbar
• #5124: Unsteady first apperance of modal popup Window
• #5144: Moving the caret inside a textfield which is inside a selectable Table is impossible
• #5148: WebBrowser doesn't get correct details when application is run as a portlet
• #5174: Menu cannot be clicked using mouse
• #5177: Popup for DateField with msec resolution fails to open after entering invalid date
• #5179: TabSheet should have a removeTab(Tab t)
• #5180: Selecting a menu item that has no parent using enter does not remove focus from the item
• #5182: ComponentLocator fails to identify widgets attached to RootPanel
• #5203: DateField setResolution() should call requestRepaint
• #5212: Table.setColumnAlignment(Object, String) API and JavaDoc misleading
• #5217: Text selections/cursor position features
• #5225: ApplicationServlet#getApplicationClass does not retain its parent class's 'throws ClassNotFoundException' clause
• #5227: GridLayout column expansion is incorrect
• #5269: Scrolling Tree and the clicking on item will not select item
• #5270: CombobBox is not always opened by first click on dropdown button (Webkit)
• #5277: PopupDateField: isEmpty() returns incorrect result
• #5278: Moving an invisible component to another layout renders the component as visible
• #5279: Combobox selected item's caption disappears from scrolling
• #5280: ContainerHierarchicalWrapper is not fully serializable
• #5281: Tree keeps selected items even after a new containerDataSource has been set
• #5282: Transferable interface and classes implementing it are not serializable
• #5285: Action and event related interfaces and notifiers should be serializable
• #5286: Relevant server side classes and interfaces should implement Serializable
• #5291: PopupDateField ValueChangEvents sent for invalid date changes but not when clearing the field
• #5292: PopupDateField setValue(null) does not clear the field when there is invalid input
• #5293: WidgetsetBuilder should create widgetset directory if it does not exist
• #5300: The Upload component should have a default constructor
• #5303: Error indicator not always shown for checkboxes
• #5306: The multiselect mode for normal Selects doesn't work
• #5311: AbsoluteLayout$ComponentPosition does not indicate unset values properly
• #5314: Menubar should not use a static field for generating menu item ids
• #5315: Header and footer clicks should be immediate even if Table is not immediate
• #5316: Footer cell not resized with the rightmost column
• #5320: Error in table column header mode JavaDoc
• #5323: Disabled buttons in OptionGroup not grayed in CSS

Requirements

Vaadin is available for the following operating systems:

• Windows (see the Zip installation notice above)
• Linux
• Mac OS X Tiger (mac) or Leopard (leopard)
• Other UNIX operating systems, such as Sun Solaris

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:

• Apache Tomcat, version 4.1 or later
• BEA WebLogic® Server, version 9.2 or later
• IBM WebSphere® Application Server, version 6.1 or later
• JBoss Application Server, version 3.2.8 or later
• Jetty, version 5 or later
• Glassfish, version 2 or later

Vaadin supports the following browsers for using the applications made with it:

• Mozilla Firefox 3
• Internet Explorer releases 6, 7, and 8
• Safari 3, 4 and 5
• Opera 10
• Google Chrome 5

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. There may be differences between the exact versions of the supported browsers that may cause incompatibility with applications made with Vaadin.

The following browsers are not supported but have been found to work to a large degree:

• Safari 2
• Firefox 2
• Older versions of Google Chrome
• iPhone (firmware 2.2)
• Midori (0.1.2)
• Epiphany (2.22.3), Galeon, and other Gecko-based browsers. Also WebKit-based Epiphany (2.22.3) works.
• Konqueror 4.2 (3.5.x does not work)
• Nokia Internet Tablet N800 and N810 (ITOS 2008, Opera-based browser).

The reported versions are those that have been tested, though other versions may work as well.

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.

vaadin }> thinking of U and I ↑ Back to top