Thanks, we value your feedback!


This book provides an overview of the Vaadin Framework and covers the most important topics that you might encounter while developing applications with it. A more detailed documentation of the individual classes, interfaces, and methods is given in the Vaadin API Reference.

The book has grown greatly after its first edition, until it became too thick to fit any standard pocket. To accommodate all the content also in the printed edition, it has now been split into two volumes, the first one including the topics that you need to get started with Vaadin.

This edition mostly covers Vaadin 7.4 released in 2015, as well as many new and revised add-ons released in early 2015.

In addition to the changes in the core framework, this edition features documentation for the TestBench 4 and TouchKit 4 add-ons, which are not yet released at the time of writing. The updated chapters are based on prerelease versions of the add-ons, so the final releases may include some changes.

Writing this manual is an ongoing work and it is rarely completely up-to-date with the quick-evolving product. Some features may not be included in this book yet. For the most current version, please see the on-line edition available at You can also find PDF and EPUB versions of the book there. You may find the other versions more easily searchable than the printed book. The index in the book is incomplete and will be expanded later. The web edition also has some additional technical content, such as some example code and additional sections that you may need when actually doing development. The purpose of the slightly abridged print edition is more to be an introductionary textbook to Vaadin, and still fit in your pocket.

Also, many Vaadin 7 features are showcased as mini-tutorials, which are available in the Vaadin Wiki at

Who is This Book For?

This book is intended for software developers who use, or are considering to use, Vaadin to develop web applications.

The book assumes that you have some experience with programming in Java, but if not, it is at least as easy to begin learning Java with Vaadin as with any other UI framework. No knowledge of AJAX is needed as it is well hidden from the developer.

You may have used some desktop-oriented user interface frameworks for Java, such as AWT, Swing, or SWT, or a library such as Qt for C++. Such knowledge is useful for understanding the scope of Vaadin, the event-driven programming model, and other common concepts of UI frameworks, but not necessary.

If you do not have a web graphics designer at hand, knowing the basics of HTML and CSS can help so that you can develop presentation themes for your application. A brief introduction to CSS is provided. Knowledge of Google Web Toolkit (GWT) may be useful if you develop or integrate new client-side components.

Organization of This Book

The Book of Vaadin gives an introduction to what Vaadin is and how you use it to develop web applications.

Volume 1

Chapter 1, Introduction

The chapter gives an introduction to the application architecture supported by Vaadin, the core design ideas behind the framework, and some historical background.

Chapter 2, Getting Started with Vaadin

This chapter gives practical instructions for installing Vaadin and the reference toolchain, including the Vaadin Plugin for Eclipse, how to run and debug the demos, and how to create your own application project in the Eclipse IDE.

Chapter 3, Architecture

This chapter gives an introduction to the architecture of Vaadin and its major technologies, including AJAX, Google Web Toolkit, and event-driven programming.

Chapter 4, Writing a Server-Side Web Application

This chapter gives all the practical knowledge required for creating applications with Vaadin, such as window management, application lifecycle, deployment in a servlet container, and handling events, errors, and resources.

Chapter 5, User Interface Components

This chapter gives the basic usage documentation for all the (non-layout) user interface components in Vaadin and their most significant features. The component sections include examples for using each component, as well as for styling with CSS/Sass.

Chapter 6, Managing Layout

This chapter describes the layout components, which are used for managing the layout of the user interface, just like in any desktop application frameworks.

Volume 2:

Chapter 7, Themes

This chapter gives an introduction to Cascading Style Sheets (CSS) and Sass and explains how you can use them to build custom visual themes for your application.

Chapter 8, Binding Components to Data

This chapter gives an overview of the built-in data model of Vaadin, consisting of properties, items, and containers.

Chapter 9, Vaadin SQLContainer

This chapter gives documentation for the SQLContainer, which allows binding Vaadin components to SQL queries.

Chapter 10, Advanced Web Application Topics

This chapter provides many special topics that are commonly needed in applications, such as opening new browser windows, embedding applications in regular web pages, low-level management of resources, shortcut keys, debugging, etc.

Chapter 11, Portal Integration

This chapter describes the development of Vaadin applications as portlets which you can deploy to any portal supporting Java Portlet API 2.0 (JSR-286). The chapter also describes the special support for Liferay and the Control Panel, IPC, and WSRP add-ons.

Chapter 12, Client-Side Vaadin Development

This chapter gives an introduction to creating and developing client-side applications and widgets, including installation, compilation, and debugging.

Chapter 13, Client-Side Applications

This chapter describes how to develop client-side applications and how to integrate them with a back-end service.

Chapter 14, Client-Side Widgets

This chapter describes the built-in widgets (client-side components) available for client-side development. The built-in widgets include Google Web Toolkit widgets as well as Vaadin widgets.

Chapter 15, Integrating with the Server-Side

This chapter describes how to integrate client-side widgets with their server-side counterparts for the purpose of creating new server-side components. The chapter also covers integrating JavaScript components.

Chapter 16, Using Vaadin Add-ons

This chapter gives instructions for downloading and installing add-on components from the Vaadin Directory.

Chapter 17, Vaadin Charts

This chapter documents the use of the Vaadin Charts add-on component for interactive charting with many diagram types. The add-on includes the Chart and Timeline components.

Chapter 18, Vaadin JPAContainer

This chapter gives documentation of the JPAContainer add-on, which allows binding Vaadin components directly to relational and other databases using Java Persistence API (JPA).

Chapter 19, Mobile Applications with TouchKit

This chapter gives examples and reference documentation for using the Vaadin TouchKit add-on for developing mobile applications.

Chapter 21, Vaadin TestBench

This chapter gives the complete documentation of using the Vaadin TestBench tool for recording and executing user interface regression tests of Vaadin applications.

Supplementary Material

The Vaadin websites offer plenty of material that can help you understand what Vaadin is, what you can do with it, and how you can do it.

Demo Applications

The most important demo application for Vaadin is the Sampler, which demonstrates the use of all basic components and features. You can run it on-line at or download it as a WAR from the Vaadin download page.

Most of the code examples in this book and many others can be found online at

Cheat Sheet

The two-page cheat sheet illustrates the basic relationship hierarchy of the user interface and data binding classes and interfaces. You can download it at


The six-page DZone Refcard gives an overview to application development with Vaadin. It includes a diagram of the user interface and data binding classes and interfaces. You can find more information about it at

Address Book Tutorial

The Address Book is a sample application accompanied with a tutorial that gives detailed step-by-step instructions for creating a real-life web application with Vaadin. You can find the tutorial from the product website.

Developer's Website

Vaadin Developer's Site at provides various online resources, such as the ticket system, a development wiki, source repositories, activity timeline, development milestones, and so on.

The wiki provides instructions for developers, especially for those who wish to check-out and compile Vaadin itself from the source repository. The technical articles deal with integration of Vaadin applications with various systems, such as JSP, Maven, Spring, Hibernate, and portals. The wiki also provides answers to Frequently Asked Questions.

Online Documentation

You can read this book online at Lots of additional material, including technical HOWTOs, answers to Frequently Asked Questions and other documentation is also available on Vaadin web-site.


Stuck with a problem? No need to lose your hair over it, the Vaadin Framework developer community and the Vaadin company offer support to all of your needs.

Community Support Forum

You can find the user and developer community forum at Please use the forum to discuss any problems you might encounter, wishes for features, and so on. The answer to your problems may already lie in the forum archives, so searching the discussions is always the best way to begin.

Report Bugs

If you have found a possible bug in Vaadin, the demo applications, or the documentation, please report it by filing a ticket at the Vaadin developer's site at You may want to check the existing tickets before filing a new one. You can make a ticket to make a request for a new feature as well, or to suggest modifications to an existing feature.

Commercial Support

Vaadin offers full commercial support and training services for the Vaadin Framework and related products. Read more about the commercial products at for details.

About the Author

Marko Grönroos is a professional writer and software developer working at Vaadin Ltd in Turku, Finland. He has been involved in web application development since 1994 and has worked on several application development frameworks in C, C++, and Java. He has been active in many open source software projects and holds an M.Sc. degree in Computer Science from the University of Turku.


Much of the book is the result of close work within the development team at Vaadin Ltd. Joonas Lehtinen, CEO of Vaadin Ltd, wrote the first outline of the book, which became the basis for the first two chapters. Since then, Marko Grönroos has become the primary author and editor. The development team has contributed several passages, answered numerous technical questions, reviewed the manual, and made many corrections.

The contributors are (in rough chronological order):

  • Joonas Lehtinen
  • Jani Laakso
  • Marko Grönroos
  • Jouni Koivuviita
  • Matti Tahvonen
  • Artur Signell
  • Marc Englund
  • Henri Sara
  • Jonatan Kronqvist
  • Mikael Grankvist (TestBench)
  • Teppo Kurki (SQLContainer)
  • Tomi Virtanen (Calendar)
  • Risto Yrjänä (Calendar)
  • John Ahlroos (Timeline)
  • Petter Holmström (JPAContainer)
  • Leif Åstrand

About Vaadin Ltd

Vaadin Ltd is a Finnish software company specializing in the design and development of Rich Internet Applications. The company offers planning, implementation, and support services for the software projects of its customers, as well as sub-contract software development. Vaadin Framework, previously known as IT Mill Toolkit, is the flagship open source product of the company, for which it provides commercial development and support services.

1. Introduction
1.1. Overview
1.2. Example Application Walkthrough
1.3. Support for the Eclipse IDE
1.4. Goals and Philosophy
1.5. Background
2. Getting Started with Vaadin
2.1. Overview
2.2. Setting up the Development Environment
2.2.1. Installing Java SDK
2.2.2. Installing Eclipse IDE
2.2.3. Installing Apache Tomcat
2.2.4. Firefox and Firebug
2.3. Overview of Vaadin Libraries
2.4. Installing Vaadin Plugin for Eclipse
2.4.1. Installing the IvyDE Plugin
2.4.2. Installing the Vaadin Plugin
2.4.3. Updating the Plugins
2.4.4. Updating the Vaadin Libraries
2.5. Creating and Running a Project with Eclipse
2.5.1. Creating the Project
2.5.2. Exploring the Project
2.5.3. Coding Tips for Eclipse
2.5.4. Setting Up and Starting the Web Server
2.5.5. Running and Debugging
2.6. Using Vaadin with Maven
2.6.1. Working from Command-Line
2.6.2. Compiling and Running the Application
2.6.3. Using Add-ons and Custom Widget Sets
2.7. Creating a Project with NetBeans IDE
2.7.1. Maven Project from a Vaadin Archetype
2.8. Creating a Project with IntelliJ IDEA
2.8.1. Configuring an Application Server
2.8.2. Creating a Vaadin Web Application Project
2.8.3. Creating a Maven Project
2.9. Vaadin Installation Package
2.9.1. Package Contents
2.9.2. Installing the Libraries
2.10. Using Vaadin with Scala
3. Architecture
3.1. Overview
3.2. Technological Background
3.2.1. HTML and JavaScript
3.2.2. Styling with CSS and Sass
3.2.3. AJAX
3.2.4. Google Web Toolkit
3.2.5. Java Servlets
3.3. Client-Side Engine
3.4. Events and Listeners
4. Writing a Server-Side Web Application
4.1. Overview
4.2. Building the UI
4.2.1. Application Architecture
4.2.2. Compositing Components
4.2.3. View Navigation
4.2.4. Accessing UI, Page, Session, and Service
4.3. Designing UIs Declaratively
4.3.1. Declarative Syntax
4.3.2. Component Elements
4.3.3. Component Attributes
4.3.4. Component Identifiers
4.3.5. Using Designs in Code
4.4. Handling Events with Listeners
4.4.1. Using Anonymous Classes
4.4.2. Handling Events in Java 8
4.4.3. Implementing a Listener in a Regular Class
4.4.4. Differentiating Between Event Sources
4.5. Images and Other Resources
4.5.1. Resource Interfaces and Classes
4.5.2. File Resources
4.5.3. Class Loader Resources
4.5.4. Theme Resources
4.5.5. Stream Resources
4.6. Handling Errors
4.6.1. Error Indicator and Message
4.6.2. Customizing System Messages
4.6.3. Handling Uncaught Exceptions
4.7. Notifications
4.7.1. Notification Type
4.7.2. Customizing Notifications
4.7.3. Styling with CSS
4.8. Application Lifecycle
4.8.1. Deployment
4.8.2. Vaadin Servlet, Portlet, and Service
4.8.3. User Session
4.8.4. Loading a UI
4.8.5. UI Expiration
4.8.6. Closing UIs Explicitly
4.8.7. Session Expiration
4.8.8. Closing a Session
4.9. Deploying an Application
4.9.1. Creating Deployable WAR in Eclipse
4.9.2. Web Application Contents
4.9.3. Web Servlet Class
4.9.4. Using a web.xml Deployment Descriptor
4.9.5. Servlet Mapping with URL Patterns
4.9.6. Other Servlet Configuration Parameters
4.9.7. Deployment Configuration
5. User Interface Components
5.1. Overview
5.2. Interfaces and Abstractions
5.2.1. Component Interface
5.2.2. AbstractComponent
5.3. Common Component Features
5.3.1. Caption
5.3.2. Description and Tooltips
5.3.3. Enabled
5.3.4. Icon
5.3.5. Locale
5.3.6. Read-Only
5.3.7. Style Name
5.3.8. Visible
5.3.9. Sizing Components
5.3.10. Managing Input Focus
5.4. Field Components
5.4.1. Field Interface
5.4.2. Data Binding and Conversions
5.4.3. Handling Field Value Changes
5.4.4. Field Buffering
5.4.5. Field Validation
5.5. Selection Components
5.5.1. Binding Selection Components to Data
5.5.2. Adding New Items
5.5.3. Item Captions
5.5.4. Getting and Setting Selection
5.5.5. Handling Selection Changes
5.5.6. Allowing Adding New Items
5.5.7. Multiple Selection
5.5.8. Item Icons
5.6. Component Extensions
5.7. Label
5.7.1. Text Width and Wrapping
5.7.2. Content Mode
5.7.3. Spacing with a Label
5.7.4. Data Binding
5.7.5. CSS Style Rules
5.8. Link
5.9. TextField
5.9.1. Data Binding
5.9.2. String Length
5.9.3. Handling Null Values
5.9.4. Text Change Events
5.9.5. CSS Style Rules
5.10. TextArea
5.11. PasswordField
5.12. RichTextArea
5.13. Date and Time Input with DateField
5.13.1. PopupDateField
5.13.2. InlineDateField
5.13.3. Date and Time Resolution
5.13.4. DateField Locale
5.14. Button
5.15. CheckBox
5.16. ComboBox
5.16.1. Filtered Selection
5.17. ListSelect
5.18. NativeSelect
5.19. OptionGroup
5.19.1. Disabling Items
5.20. TwinColSelect
5.21. Table
5.21.1. Selecting Items in a Table
5.21.2. Table Features
5.21.3. Editing the Values in a Table
5.21.4. Column Headers and Footers
5.21.5. Generated Table Columns
5.21.6. Formatting Table Columns
5.21.7. CSS Style Rules
5.22. Tree
5.23. Grid
5.23.1. Overview
5.23.2. Binding to Data
5.23.3. Handling Selection Changes
5.23.4. Configuring Columns
5.23.5. Generating and Hiding Columns
5.23.6. Column Renderers
5.23.7. Header and Footer
5.23.8. Filtering
5.23.9. Sorting
5.23.10. Editing
5.23.11. Programmatic Scrolling
5.23.12. Generating Row or Cell Styles
5.23.13. Styling with CSS
5.24. MenuBar
5.25. Upload
5.26. ProgressBar
5.27. Slider
5.28. Calendar
5.28.1. Date Range and View Mode
5.28.2. Calendar Events
5.28.3. Getting Events from a Container
5.28.4. Implementing an Event Provider
5.28.5. Styling a Calendar
5.28.6. Visible Hours and Days
5.28.7. Drag and Drop
5.28.8. Using the Context Menu
5.28.9. Localization and Formatting
5.28.10. Customizing the Calendar
5.28.11. Backward and Forward Navigation
5.28.12. Date Click Handling
5.28.13. Handling Week Clicks
5.28.14. Handling Event Clicks
5.28.15. Event Dragging
5.28.16. Handling Drag Selection
5.28.17. Resizing Events
5.29. Composition with CustomComponent
5.30. Composite Fields with CustomField
5.31. Embedded Resources
5.31.1. Embedded Image
5.31.2. Adobe Flash Graphics
5.31.3. BrowserFrame
5.31.4. Generic Embedded Objects
6. Managing Layout
6.1. Overview
6.2. UI, Window, and Panel Content
6.3. VerticalLayout and HorizontalLayout
6.3.1. Properties or Attributes
6.3.2. Spacing in Ordered Layouts
6.3.3. Sizing Contained Components
6.4. GridLayout
6.4.1. Sizing Grid Cells
6.5. FormLayout
6.6. Panel
6.6.1. Scrolling the Panel Content
6.7. Sub-Windows
6.7.1. Opening and Closing Sub-Windows
6.7.2. Window Positioning
6.7.3. Scrolling Sub-Window Content
6.7.4. Modal Sub-Windows
6.8. HorizontalSplitPanel and VerticalSplitPanel
6.9. TabSheet
6.9.1. Adding Tabs
6.9.2. Tab Objects
6.9.3. Tab Change Events
6.9.4. Enabling and Handling Closing Tabs
6.10. Accordion
6.11. AbsoluteLayout
6.12. CssLayout
6.12.1. CSS Injection
6.12.2. Browser Compatibility
6.13. Layout Formatting
6.13.1. Layout Size
6.13.2. Expanding Components
6.13.3. Layout Cell Alignment
6.13.4. Layout Cell Spacing
6.13.5. Layout Margins
6.14. Custom Layouts
7. Themes
7.1. Overview
7.2. Introduction to Cascading Style Sheets
7.2.1. Applying CSS to HTML
7.2.2. Basic CSS Rules
7.2.3. Matching by Element Class
7.2.4. Matching by Descendant Relationship
7.2.5. Importance of Cascading
7.2.6. Style Class Hierarchy of a Vaadin UI
7.2.7. Notes on Compatibility
7.3. Syntactically Awesome Stylesheets (Sass)
7.3.1. Sass Overview
7.3.2. Sass Basics with Vaadin
7.4. Compiling Sass Themes
7.4.1. Compiling On the Fly
7.4.2. Compiling in Eclipse
7.4.3. Compiling with Maven
7.4.4. Compiling in Command-line
7.4.5. Compiling with Ant
7.5. Creating and Using Themes
7.5.1. Sass Themes
7.5.2. Plain Old CSS Themes
7.5.3. Styling Standard Components
7.5.4. Built-in Themes
7.5.5. Add-on Themes
7.6. Creating a Theme in Eclipse
7.7. Valo Theme
7.7.1. Basic Use
7.7.2. Common Settings
7.7.3. Valo Mixins and Functions
7.7.4. Valo Fonts
7.7.5. Component Styles
7.7.6. Theme Optimization
7.8. Font Icons
7.8.1. Loading Icon Fonts
7.8.2. Basic Use
7.8.3. Using Font icons in HTML
7.8.4. Using Font Icons in Other Text
7.8.5. Custom Font Icons
7.9. Custom Fonts
7.9.1. Loading Fonts
7.9.2. Using Custom Fonts
7.10. Responsive Themes
8. Binding Components to Data
8.1. Overview
8.2. Properties
8.2.1. Property Viewers and Editors
8.2.2. ObjectProperty Implementation
8.2.3. Converting Between Property Type and Representation
8.2.4. Implementing the Property Interface
8.3. Holding properties in Items
8.3.1. The PropertysetItem Implementation
8.3.2. Wrapping a Bean in a BeanItem
8.4. Creating Forms by Binding Fields to Items
8.4.1. Simple Binding
8.4.2. Using a FieldFactory to Build and Bind Fields
8.4.3. Binding Member Fields
8.4.4. Buffering Forms
8.4.5. Binding Fields to a Bean
8.4.6. Bean Validation
8.5. Collecting Items in Containers
8.5.1. Basic Use of Containers
8.5.2. Container Subinterfaces
8.5.3. IndexedContainer
8.5.4. BeanContainer
8.5.5. BeanItemContainer
8.5.6. Iterating Over a Container
8.5.7. GeneratedPropertyContainer
8.5.8. Filterable Containers
9. Vaadin SQLContainer
9.1. Architecture
9.2. Getting Started with SQLContainer
9.2.1. Creating a connection pool
9.2.2. Creating the TableQuery Query Delegate
9.2.3. Creating the Container
9.3. Filtering and Sorting
9.3.1. Filtering
9.3.2. Sorting
9.4. Editing
9.4.1. Adding items
9.4.2. Fetching generated row keys
9.4.3. Version column requirement
9.4.4. Auto-commit mode
9.4.5. Modified state
9.5. Caching, Paging and Refreshing
9.5.1. Container Size
9.5.2. Page Length and Cache Size
9.5.3. Refreshing the Container
9.5.4. Cache Flush Notification Mechanism
9.6. Referencing Another SQLContainer
9.7. Making Freeform Queries
9.8. Non-Implemented Methods
9.9. Known Issues and Limitations
10. Advanced Web Application Topics
10.1. Handling Browser Windows
10.1.1. Opening Popup Windows
10.1.2. Closing Popup Windows
10.2. Embedding UIs in Web Pages
10.2.1. Embedding Inside a div Element
10.2.2. Embedding Inside an iframe Element
10.2.3. Cross-Site Embedding with the Vaadin XS Add-on
10.3. Debug Mode and Window
10.3.1. Enabling the Debug Mode
10.3.2. Opening the Debug Window
10.3.3. Debug Message Log
10.3.4. General Information
10.3.5. Inspecting Component Hierarchy
10.3.6. Communication Log
10.3.7. Debug Modes
10.4. Request Handlers
10.5. Shortcut Keys
10.5.1. Shortcut Keys for Default Buttons
10.5.2. Field Focus Shortcuts
10.5.3. Generic Shortcut Actions
10.5.4. Supported Key Codes and Modifier Keys
10.6. Printing
10.6.1. Printing the Browser Window
10.6.2. Opening a Print Window
10.6.3. Printing PDF
10.7. Google App Engine Integration
10.8. Common Security Issues
10.8.1. Sanitizing User Input to Prevent Cross-Site Scripting
10.9. Navigating in an Application
10.9.1. Setting Up for Navigation
10.9.2. Implementing a View
10.9.3. Handling URI Fragment Path
10.10. Advanced Application Architectures
10.10.1. Layered Architectures
10.10.2. Model-View-Presenter Pattern
10.11. Managing URI Fragments
10.11.1. Setting the URI Fragment
10.11.2. Reading the URI Fragment
10.11.3. Listening for URI Fragment Changes
10.11.4. Supporting Web Crawling
10.12. Drag and Drop
10.12.1. Handling Drops
10.12.2. Dropping Items On a Tree
10.12.3. Dropping Items On a Table
10.12.4. Accepting Drops
10.12.5. Dragging Components
10.12.6. Dropping on a Component
10.12.7. Dragging Files from Outside the Browser
10.13. Logging
10.14. JavaScript Interaction
10.14.1. Calling JavaScript
10.14.2. Handling JavaScript Function Callbacks
10.15. Accessing Session-Global Data
10.15.1. Passing References Around
10.15.2. Overriding attach()
10.15.3. ThreadLocal Pattern
10.16. Server Push
10.16.1. Installing the Push Support
10.16.2. Enabling Push for a UI
10.16.3. Accessing UI from Another Thread
10.16.4. Broadcasting to Other Users
10.17. Vaadin CDI Add-on
10.17.1. CDI Overview
10.17.2. Installing Vaadin CDI Add-on
10.17.3. Preparing Application for CDI
10.17.4. Injecting a UI with @CDIUI
10.17.5. Scopes
10.17.6. Deploying CDI UIs and Servlets
10.17.7. View Navigation
10.17.8. CDI Events
11. Portal Integration
11.1. Overview
11.2. Creating a Generic Portlet in Eclipse
11.2.1. Creating a Project with Vaadin Plugin
11.3. Developing Vaadin Portlets for Liferay
11.3.1. Defining Liferay Profile for Maven
11.3.2. Creating a Portlet Project with Maven
11.3.3. Creating a Portlet Project in Liferay IDE
11.3.4. Removing the Bundled Installation
11.3.5. Installing Vaadin Resources
11.4. Portlet UI
11.5. Deploying to a Portal
11.5.1. Portlet Deployment Descriptor
11.5.2. Liferay Portlet Descriptor
11.5.3. Liferay Display Descriptor
11.5.4. Liferay Plugin Package Properties
11.5.5. Using a Single Widget Set
11.5.6. Building the WAR Package
11.5.7. Deploying the WAR Package
11.6. Vaadin IPC for Liferay
11.6.1. Installing the Add-on
11.6.2. Basic Communication
11.6.3. Considerations
11.6.4. Communication Through Session Attributes
11.6.5. Serializing and Encoding Data
11.6.6. Communicating with Non-Vaadin Portlets
12. Client-Side Vaadin Development
12.1. Overview
12.2. Installing the Client-Side Development Environment
12.3. Client-Side Module Descriptor
12.3.1. Specifying a Stylesheet
12.3.2. Limiting Compilation Targets
12.4. Compiling a Client-Side Module
12.4.1. Vaadin Compiler Overview
12.4.2. Compiling in Eclipse
12.4.3. Compiling with Ant
12.4.4. Compiling with Maven
12.5. Creating a Custom Widget
12.5.1. A Basic Widget
12.5.2. Using the Widget
12.6. Debugging Client-Side Code
12.6.1. Launching Development Mode
12.6.2. Launching SuperDevMode
12.6.3. Debugging Java Code in Chrome
13. Client-Side Applications
13.1. Overview
13.2. Client-Side Module Entry-Point
13.2.1. Module Descriptor
13.3. Compiling and Running a Client-Side Application
13.4. Loading a Client-Side Application
14. Client-Side Widgets
14.1. Overview
14.2. GWT Widgets
14.3. Vaadin Widgets
14.4. Grid
14.4.1. Renderers
15. Integrating with the Server-Side
15.1. Overview
15.2. Starting It Simple With Eclipse
15.2.1. Creating a Widget
15.2.2. Compiling the Widget Set
15.3. Creating a Server-Side Component
15.3.1. Basic Server-Side Component
15.4. Integrating the Two Sides with a Connector
15.4.1. A Basic Connector
15.4.2. Communication with the Server-Side
15.5. Shared State
15.5.1. Accessing Shared State on Server-Side
15.5.2. Handing Shared State in a Connector
15.5.3. Handling Property State Changes with @OnStateChange
15.5.4. Delegating State Properties to Widget
15.5.5. Referring to Components in Shared State
15.5.6. Sharing Resources
15.6. RPC Calls Between Client- and Server-Side
15.6.1. RPC Calls to the Server-Side
15.7. Component and UI Extensions
15.7.1. Server-Side Extension API
15.7.2. Extension Connectors
15.8. Styling a Widget
15.8.1. Determining the CSS Class
15.8.2. Default Stylesheet
15.9. Component Containers
15.10. Advanced Client-Side Topics
15.10.1. Client-Side Processing Phases
15.11. Creating Add-ons
15.11.1. Exporting Add-on in Eclipse
15.11.2. Building Add-on with Ant
15.12. Migrating from Vaadin 6
15.12.1. Quick (and Dirty) Migration
15.13. Integrating JavaScript Components and Extensions
15.13.1. Example JavaScript Library
15.13.2. A Server-Side API for a JavaScript Component
15.13.3. Defining a JavaScript Connector
15.13.4. RPC from JavaScript to Server-Side
16. Using Vaadin Add-ons
16.1. Overview
16.2. Downloading Add-ons from Vaadin Directory
16.2.1. Compiling Widget Sets with an Ant Script
16.3. Installing Add-ons in Eclipse with Ivy
16.4. Using Add-ons in a Maven Project
16.4.1. Adding a Dependency
16.4.2. Compiling the Project Widget Set
16.4.3. Enabling Widget Set Compilation
16.5. Installing Commercial Vaadin Add-on Licence
16.5.1. Obtaining License Keys
16.5.2. Installing License Key in License File
16.5.3. Passing License Key as System Property
16.6. Troubleshooting
17. Vaadin Charts
17.1. Overview
17.2. Installing Vaadin Charts
17.2.1. Maven Dependency
17.2.2. Ivy Dependency
17.2.3. Installing License Key
17.3. Basic Use
17.3.1. Basic Chart Configuration
17.3.2. Plot Options
17.3.3. Chart Data Series
17.3.4. Axis Configuration
17.3.5. Displaying Multiple Series
17.3.6. Mixed Type Charts
17.3.7. 3D Charts
17.3.8. Chart Themes
17.4. Chart Types
17.4.1. Line and Spline Charts
17.4.2. Area Charts
17.4.3. Column and Bar Charts
17.4.4. Error Bars
17.4.5. Box Plot Charts
17.4.6. Scatter Charts
17.4.7. Bubble Charts
17.4.8. Pie Charts
17.4.9. Gauges
17.4.10. Solid Gauges
17.4.11. Area and Column Range Charts
17.4.12. Polar, Wind Rose, and Spiderweb Charts
17.4.13. Funnel and Pyramid Charts
17.4.14. Waterfall Charts
17.4.15. Heat Maps
17.5. Chart Configuration
17.5.1. Plot Options
17.5.2. Axes
17.5.3. Legend
17.5.4. Formatting Labels
17.6. Chart Data
17.6.1. List Series
17.6.2. Generic Data Series
17.6.3. Range Series
17.6.4. Container Data Series
17.7. Advanced Uses
17.7.1. Server-Side Rendering and Exporting
17.8. Timeline
17.8.1. Graph types
17.8.2. Interaction Elements
17.8.3. Event Markers
17.8.4. Efficiency
17.8.5. Data Source Requirements
17.8.6. Events and Listeners
17.8.7. Configurability
17.8.8. Localization
17.8.9. Timeline Tutorial
18. Vaadin JPAContainer
18.1. Overview
18.2. Installing
18.2.1. Downloading the Package
18.2.2. Installation Package Content
18.2.3. Downloading with Maven
18.2.4. Including Libraries in Your Project
18.2.5. Persistence Configuration
18.2.6. Troubleshooting
18.3. Defining a Domain Model
18.3.1. Persistence Metadata
18.4. Basic Use of JPAContainer
18.4.1. Creating JPAContainer with JPAContainerFactory
18.4.2. Creating and Accessing Entities
18.4.3. Nested Properties
18.4.4. Hierarchical Container
18.5. Entity Providers
18.5.1. Built-In Entity Providers
18.5.2. Using JNDI Entity Providers in JEE6 Environment
18.5.3. Entity Providers as Enterprise Beans
18.6. Filtering JPAContainer
18.7. Querying with the Criteria API
18.7.1. Filtering the Query
18.7.2. Compatibility
18.8. Automatic Form Generation
18.8.1. Configuring the Field Factory
18.8.2. Using the Field Factory
18.8.3. Master-Detail Editor
18.9. Using JPAContainer with Hibernate
18.9.1. Lazy loading
18.9.2. The EntityManager-Per-Request pattern
18.9.3. Joins in Hibernate vs EclipseLink
19. Mobile Applications with TouchKit
19.1. Overview
19.2. Considerations Regarding Mobile Browsing
19.2.1. Mobile Human Interface
19.2.2. Bandwidth and Performance
19.2.3. Mobile Features
19.2.4. Compatibility
19.3. Installing Vaadin TouchKit
19.3.1. Installing as Ivy Dependency
19.3.2. Defining the Maven Dependency
19.3.3. Installing the Zip Package
19.4. Importing the Parking Demo
19.5. Creating a New TouchKit Project
19.5.1. Using the Maven Archetype
19.5.2. Starting from a New Eclipse Project
19.6. Elements of a TouchKit Application
19.6.1. The Servlet Class
19.6.2. Defining Servlet and UI with web.xml Deployment Descriptor
19.6.3. TouchKit Settings
19.6.4. The UI
19.6.5. Mobile Widget Set
19.6.6. Mobile Theme
19.6.7. Using Font Icons
19.7. Mobile User Interface Components
19.7.1. NavigationView
19.7.2. Toolbar
19.7.3. NavigationManager
19.7.4. NavigationButton
19.7.5. Popover
19.7.6. SwipeView
19.7.7. Switch
19.7.8. VerticalComponentGroup
19.7.9. HorizontalButtonGroup
19.7.10. TabBarView
19.7.11. EmailField
19.7.12. NumberField
19.7.13. UrlField
19.8. Advanced Mobile Features
19.8.1. Providing a Fallback UI
19.8.2. Geolocation
19.8.3. Storing Data in the Local Storage
19.8.4. Uploading Content
19.9. Offline Mode
19.9.1. Enabling the Cache Manifest
19.9.2. Enabling Offline Mode
19.9.3. The Offline User Interface
19.9.4. Sending Data to Server
19.9.5. The Offline Theme
19.10. Building an Optimized Widget Set
19.10.1. Generating the Widget Map
19.10.2. Defining the Widget Loading Style
19.10.3. Applying the Custom Widget Map Generator
19.10.4. Deployment
19.11. Testing and Debugging on Mobile Devices
19.11.1. Debugging
20. Vaadin Spreadsheet
20.1. Overview
20.2. Installing Vaadin Spreadsheet
20.2.1. Installing as Ivy Dependency
20.2.2. Defining the Maven Dependency
20.2.3. Installing the Zip Package
20.2.4. Installing License Key
20.2.5. Compiling Widget Set
20.2.6. Compiling Theme
20.2.7. Importing the Demo
20.3. Basic Use
20.3.1. Creating a Spreadsheet
20.3.2. Working with Sheets
20.4. Spreadsheet Configuration
20.4.1. Spreadsheet Elements
20.4.2. Frozen Row and Column Panes
20.5. Cell Content and Formatting
20.5.1. Cell Formatting
20.5.2. Cell Font Style
20.5.3. Cell Comments
20.5.4. Merging Cells
20.5.5. Components in Cells
20.5.6. Hyperlinks
20.5.7. Popup Buttons in Cells
20.6. Context Menus
20.6.1. Default Context Menu
20.6.2. Custom Context Menus
20.7. Tables Within Spreadsheets
20.7.1. Creating a Table
20.7.2. Filtering With a Table
21. Vaadin TestBench
21.1. Overview
21.2. Quick Start
21.2.1. Installing License Key
21.2.2. Quick Start with Eclipse
21.2.3. Quick Start with Maven
21.3. Installing Vaadin TestBench
21.3.1. Test Development Setup
21.3.2. A Distributed Testing Environment
21.3.3. Installation Package Contents
21.3.4. TestBench Demo
21.3.5. Installing Browser Drivers
21.3.6. Test Node Configuration
21.4. Developing JUnit Tests
21.4.1. Basic Test Case Structure
21.4.2. Running JUnit Tests in Eclipse
21.5. Creating a Test Case
21.5.1. Test Setup
21.5.2. Basic Test Case Structure
21.5.3. Creating and Closing a Web Driver
21.6. Querying Elements
21.6.1. Generating Queries with Debug Window
21.6.2. Querying Elements by Component Type ($)
21.6.3. Non-Recursive Component Queries ($$)
21.6.4. Element Classes
21.6.5. ElementQuery Objects
21.6.6. Query Terminators
21.7. Element Selectors
21.7.1. Finding by ID
21.7.2. Finding by CSS Class
21.8. Special Testing Topics
21.8.1. Waiting for Vaadin
21.8.2. Testing Tooltips
21.8.3. Scrolling
21.8.4. Testing Notifications
21.8.5. Testing Context Menus
21.8.6. Profiling Test Execution Time
21.9. Creating Maintainable Tests
21.9.1. Increasing Selector Robustness
21.9.2. The Page Object Pattern
21.10. Taking and Comparing Screenshots
21.10.1. Screenshot Parameters
21.10.2. Taking Screenshots on Failure
21.10.3. Taking Screenshots for Comparison
21.10.4. Practices for Handling Screenshots
21.10.5. Known Compatibility Problems
21.11. Running Tests
21.11.1. Running Tests with Ant
21.11.2. Running Tests with Maven
21.12. Running Tests in a Distributed Environment
21.12.1. Running Tests Remotely
21.12.2. Starting the Hub
21.12.3. Node Service Configuration
21.12.4. Starting a Grid Node
21.12.5. Mobile Testing
21.13. Parallel Execution of Tests
21.13.1. Local Parallel Execution
21.13.2. Multi-Browser Execution in a Grid
21.14. Headless Testing
21.14.1. Basic Setup for Running Headless Tests
21.14.2. Running Headless Tests in a Distributed Environment
21.15. Behaviour-Driven Development
21.16. Known Issues
21.16.1. Running Firefox Tests on Mac OS X