Skip to content

Latest commit

 

History

History
115 lines (68 loc) · 4.76 KB

README.md

File metadata and controls

115 lines (68 loc) · 4.76 KB
Raw

MVP4G2 Project Generator

Motivation

Setting up a Mvp4g2 project can be difficult, especially if you are not familiar with MVP4G2. There are a lot of things to do before it is possible to run the project and check wheather it is working or not.

To improve the process of setting up a GWT project using MVP4G2, we created a Mvp4g2 project generator. Once you have configurated and generated the project, you will get a zip file containing the - ready to import - Mvp4g2 project.

Keep in mind, Mvp4g2 helps you to structure your application. Navigation, history and confirmation will be generated and work. It is not a widget library. So, the views are nearly empty. It is up to you to implement the views.

Important note: Mvp4g2 requires Java 8!

Note:

The implementation of the generator uses Mvp4g2, GXT and is based on GWT 2.8.2! The generated project requires in this version GWT 2.8.2 and Java 8. The generated Mvp4g2 source code will work with J2CL / GWT 3 once all dependies to GWT 2.8.2 are replaced. You have to choose a widget set, that will work with J2CL / GWT 3 to be compatible with J2CL / GWT 3!

The generator nor Mvp4g2 will make any existing source code compatible with J2CL / GWT 3. There is no magic to transfom GWT 2.x code to work with GWT 3!

Configuration

Project Meta Data

In this area the Group Id, the Artifact Id and GWT version of the project is defined.

Project Meta Data

Group Id

The group id is used as the group id inside the POM. Also it will be used as the name of the package. The group id can not be empty. You can enter letters [a - z], numbers [0 - 9] and dots [.].

Artifact Id

The artifact id is used as the artifact id inside the POM. It is also used as the name of the GWT module. The group id can not be empty. You can enter letters [a - z, A - Z] and numbers [0 - 9].

GWT Version

The GWT version of the generated project. (This voersion of the generator supports only GWT 2.8.2.)

Widget Set

The widget library that will be used for the code generation. At the moment the Mvp4g2 Example generator supports:

  • Elemento

  • native GWT widgets

  • GXT GPL 4.0.0

Note: The native GWT and the GXT GPL 4.0.0 widget sets will not work with J2CL / GWT 3!

Application Meta Data

In this area the features of Mvp4g2 for generated the project are defined.

Project Meta Data

Application Loader

If checked, a application loader will be added to the project source code. can be found [here].

Debug Support

If checked, the Debug annotation will be generated inside the event bus.

History Support

If checked, everything needed for history handling will be generated.

History on Start

If checked, the application will handle a history token on start (book marks).

Screen Meta Data

In this area the screens are defined. A screen in mvp4g2 is a combination of a presenter and a view. There are three predefined screens called screen01, screen02 and screen03. The generator needs at least one screen to generate a fully working project.

Project Meta Data

There are three buttons:

  • the first buttons adds another screen

  • the second button edits the selected screen

  • the third button removes the selected screen.

In case you add or edit a screen, a window will open:

Add or edit screen data

Using this window, you can:

  • name the screen: this name will be used as package name, the goto event, the presenter- and view-name, etc
  • history name (optional): if entered, this name will be used as token instead the event name
  • view creation method:
    • view is created by framework: the instance of the view will be created by the framwork (using 'new')
    • view is created by presenter: the instance of the view has to be created by the developer
  • use this screen as start screen of the application (if there is no history token, this will be the screen, that will be shown at start of the application)
  • enable navigation confirmation