Play Integration for Vaadin

Run your Vaadin applications inside the Play! Framework.

Requirements

• Play 2.2
• Vaadin 7.1
• (Scaladin 3.0-SNAPSHOT)

Running Vaadin applications inside Play!

1. Use an existing Play! application or create a new by saying play new PlayVaadinExample.

2. Add dependencies and specify VAADIN as an asset directory in build.sbt:

     name := "PlayVaadinExample"
   
     version := "1.0-SNAPSHOT"
   
     resolvers += "play-vaadin-integration Snapshots" at "http://henrikerola.github.io/repository/snapshots/"
   
     libraryDependencies ++= Seq(
       "com.vaadin" % "vaadin-server" % "7.1.6",
       "com.vaadin" % "vaadin-client-compiled" % "7.1.6",
       "com.vaadin" % "vaadin-themes" % "7.1.6",
       "org.vaadin.playintegration" %% "play-vaadin-integration" % "0.1-SNAPSHOT",
   
       jdbc,
       anorm,
       cache
     )
   
     play.Project.playScalaSettings
   
     playAssetsDirectories <+= baseDirectory / "VAADIN"
   

3. To hook up Vaadin to Play's request handling mechanism, create a Global object in the default package and let it extend VaadinSupport (app/Global.scala):

     import org.vaadin.playintegration.VaadinSupport
     import play.api.GlobalSettings
   
     object Global extends GlobalSettings with VaadinSupport
   

   Note, this must be a Scala object even when you are using the Java API of Play.

4. Create a class extending com.vaadin.ui.UI in app/example:

     package example;
   
     import com.vaadin.server.VaadinRequest;
     import com.vaadin.ui.*;
   
     public class MyVaadinUI extends UI {
   
         @Override
         protected void init(VaadinRequest vaadinRequest) {
             setContent(new Button("Click me!", new Button.ClickListener() {
                 @Override
                 public void buttonClick(Button.ClickEvent event) {
                     Notification.show("Hello World!");
                 }
             }));
         }
     }
   

5. Define a Vaadin application in conf/application.conf:

     vaadin.myapp.ui = example.MyVaadinUI
     vaadin.myapp.path = /my-vaadin-app
   

After the above steps, there should be a Vaadin application responding in http://localhost:9000/my-vaadin-app/ when you run Play with play run.

Running Scaladin applications inside Play!

Scaladin is a wrapper library that provides a pure Scala API for Vaadin.

1. Use an existing Play! application or create a new by saying play new PlayScaladinExample.

2. Add dependencies and specify VAADIN as an asset directory in build.sbt:

     name := "PlayScaladinExample"
   
     version := "1.0-SNAPSHOT"
   
     resolvers += "Scaladin & play-vaadin-integration Snapshots" at "http://henrikerola.github.io/repository/snapshots/",
   
     libraryDependencies ++= Seq(
       "com.vaadin" % "vaadin-server" % "7.1.6",
       "com.vaadin" % "vaadin-client-compiled" % "7.1.6",
       "com.vaadin" % "vaadin-themes" % "7.1.6",
       "vaadin.scala" %% "scaladin" % "3.0-SNAPSHOT",
       "org.vaadin.playintegration" %% "play-vaadin-integration" % "0.1-SNAPSHOT",
   
       jdbc,
       anorm,
       cache
     )
   
     play.Project.playScalaSettings
   
     playAssetsDirectories <+= baseDirectory / "VAADIN"
   

3. To hook up Vaadin to Play's request handling mechanism, create a Global object in the default package and let it extend VaadinSupport (app/Global.scala):

     import org.vaadin.playintegration.VaadinSupport
     import play.api.GlobalSettings
   
     object Global extends GlobalSettings with VaadinSupport
   

Note, this must be a Scala object even when you are using the Java API of Play.

4. Create a class extending vaadin.scala.UI in app/example:

     package example
   
     import vaadin.scala._
   
     class MyScaladinUI extends UI {
       content = Button("Click me!", Notification.show("Hello World!"))
     }
   

5. Define a Scaladin application in conf/application.conf:

     scaladin.myapp.ui = example.MyScaladinUI
     scaladin.myapp.path = /my-scaladin-app
   

After the above steps, there should be a Vaadin application responding in http://localhost:9000/my-scaladin-app/ when you run Play with play run.

License

The project is licensed under the Apache 2.0 License.