This covers how to setup gwt-mpv within an existing GWT application, specifically the IDE/build setup. For more information about actual functionality, see the tutorial and other docs.
This assumes you have an existing GWT application and build environment of your choice setup (Ant/Maven/etc.).
For an existing GWT application to base this Getting Started doc on, I used the “New Web Application Project” in Eclipse and chose:
This means that:
src/ (for your project it may be in src/main/java)gen/ (for your project it may go in target/java)So adjust the paths below to your project accordingly.
To setup view generation, you’ll need:
A dependency on gwt-mpv-user.jar and gwt-mpv-dev.jar.
These can be downloaded from the http://repo.joist.ws Maven repository. Personally, I use an ivy.xml file with:
<dependency org="org.gwtmpv" name="gwt-mpv-user" rev="1.2.7" conf="compile,sources"/>
<dependency org="org.gwtmpv" name="gwt-mpv-dev" rev="1.2.7" conf="provided,sources"/>But you can use Maven or the jars directly if you want.
Either way, ensure they are downloaded into a local directory (e.g. lib/) or the local Maven cache for the code generator to reference them.
Create a views package and resources package, e.g.:
com/business/sample/client/views – for your ui.xml filescom/business/sample/client/resources – for your CSS and image filesCreate a gen directory for the generated source code, e.g.:
gen/(You may put this under target/ or some other directory that doesn’t get checked in.)
And the gen/ directory as a source folder in Eclipse, e.g.:
gen/ directorySetup a custom builder in Eclipse.
The custom builder will run the gwt-mpv code generator whenever your ui.xml files change. It does this by using a feature of Eclipse that will run a command line program anytime one of the files in a watched directory changes.
In Eclipse, select the project, go to Properties
Select Builders, click New
Select Program
For the name, gwtmpv
On the Main tab, type:
Location: ${system_path:java}
Working directory: ${workspace_loc:/sample} (where “sample” is the name of your project)
Arguments:
-cp "lib/*"
org.gwtmpv.generators.Generator
--inputDirectory src/
--viewsPackageName com.business.sample.client.views
--resourcesPackageName com.business.sample.client.resources
--outputDirectory gen/On the Refresh tab,
sample/gen folderOn the Build Options tab,
Check “During auto builds”
Specify working set of relevant resources and check the directories:
samples/src/com/business/sample/client/viewssamples/src/com/business/sample/client/resourcesClick OK
What we’ve just done is tell Eclipse to run java -cp ... every time you change a ui.xml or resources file. (Unfortunately Eclipse doesn’t have an option to run Java classes with the project’s existing classpath, so we have to pass the -cp parameter manually.)
If you do this correctly, you should see output of something like:
gen/com/business/sample/client/views/AppViews.java
gen/com/business/sample/client/views/AppViewsProvider.java
gen/com/business/sample/client/views/GwtViewsProvider.java
gen/com/business/sample/client/views/StubViewsProvider.java
gen/com/business/sample/client/resources/AppResources.java
gen/com/business/sample/client/resources/StubAppResources.java
gen/com/business/sample/client/resources/AppResourcesUtil.javaCheck .externalToolBuilders/gwtmpv.launch into your repository.
This means anyone else checking the project out of your repository should get the “run gwt-mpv on save” setup out-of-the-box and not have to go through this setup again.
Now if you create a file, e.g. com/business/sample/client/views/Foo.ui.xml, you should see IsFooView created.
src/com/business/sample/client/views/Foo.ui.xml
gen/com/business/sample/client/views/Foo-gen.ui.xmlYou can create a presenter, e.g. com/business/sample/client/app/FooPresenter.java:
public class FooPresenter extends BasicPresenter<IsFooView> {
public FooPresenter() {
super(AppViews.newFooView());
}
}In your onModuleLoad, initiate the AppViews provider and then use your presenter:
AppViews.setProvider(new GwtViewsProvider());
FooPresenter p = new FooPresenter();
p.bind();
RootPanel.get().add(p.getView());Eclipse should now be setup to generate views for you. For more information on writing presenters, see the tutorial and other docs.
For your build environment (Maven/Ant), you’ll have to call the same Generator class with the same classpath and arguments as we setup in the Eclipse custom builder. For Ant, you can see the todomvc sample application.
gwt-mpv usages annotation processors for generating some non-view boilerplate, specifically places (@GenPlace) and dispatch DTOs (@GenDispatch).
To configure the annotation processors:
Add a dependency on gwt-mpv-apt:
<dependency org="org.gwtmpv" name="gwt-mpv-apt" rev="1.12" conf="provided,sources"/>In Eclipse, right click on the project, select properties
Go to Java Compiler, Annotation Processing and:
genGo to Java Compiler, Annotation Processing, Factory Path and:
gwt-mpv-apt.jar in your workspaceClick OK
Check .factorypath and .settings/org.eclipse.jdt.apt.core.prefs into your repository, then other users will get this configuration automatically.
For Ant/javac, just ensure the gwt-mpv-apt.jar is on the compilation classpath, it will find it automatically.
For unit tests, you can:
Create a FooPresenterTest.java
In a static initializer, setup gwt-mpv’s stub views (so nothing tries to touch a DOM):
static {
StubWidgetsProvider.install();
}Create your presenter and use the stub views to put it under test:
public void testFoo() {
FooPresenter p = new FooPresenter();
p.bind();
// assuming you have a TextBox
StubFooView v = (StubFooView) p.getView();
v.textName().type("what the user typed");
// assert various things happened
}For more on testing, see tests or the example projects for how the manipulate the fake view objects and fake dispatch implementation to test the presenter.