Documentation versions (currently viewingVaadin 7)

Portlet UI

A portlet UI is just like in a regular Vaadin application, a class that extends com.vaadin.ui.UI.

public class MyportletUI extends UI {
    protected void init(VaadinRequest request) {
        final VerticalLayout layout = new VerticalLayout();

        Button button = new Button("Click Me");
        button.addClickListener(new Button.ClickListener() {
            public void buttonClick(ClickEvent event) {
                        new Label("Thank you for clicking"));

If you created the project as a Servlet 3.0 project, the generated UI stub includes a static servlet class annotated with @WebServlet, as described in "Exploring the Project".

    @WebServlet(value = "/*", asyncSupported = true)
    @VaadinServletConfiguration(productionMode = false,
                                ui = MyportletUI.class)
    public static class Servlet extends VaadinServlet {

This enables running the portlet UI in a servlet container while developing it, which may be easier than deploying to a portal. For Servlet 2.4 projects, a web.xml is created.

The portlet theme is defined with the @Theme annotation as usual. The theme for the UI must match a theme installed in the portal. You can use any of the built-in themes in Vaadin. For Liferay theme compatibility, there is a special liferay theme. If you use a custom theme, you need to compile it to CSS with the theme compiler and install it in the portal under the VAADIN/themes context to be served statically.

In addition to the UI class, you need the portlet descriptor files, Vaadin libraries, and other files as described later. Portlet Project Structure in Eclipse shows the complete project structure under Eclipse.

Portlet Project Structure in Eclipse

Installed as a portlet in Liferay from the Add Application menu, the application will show as illustrated in Hello World Portlet.

Hello World Portlet