Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

EEF/User Guide/Custom Widget Generation

< EEF‎ | User Guide
Revision as of 10:41, 6 February 2012 by Goulwen.lefur.obeo.fr (Talk | contribs) (Generating PropertiesEditionPart)

Need to generate new widgets ?

In the CustomElementEditor guide, we saw how to ponctually include specific widgets in EEF generated editing forms. If this need is becoming common, EEF offers the ability to extend its generators to generate new widgets.

Environment initialization

As we will create acceleo generator, we need to install the Acceleo SDK. It can be done via the release train:

acceleo install

Next, in an empty workspace, we create an Acceleo Project. In the new project wizard, we can initialize our first template:

Acceleo project creation

Let's name it spinnerGettersSetter. It need two metamodels:

The other data are marginal, we will erase the generated body of this module.

We also have to add to the generator project a dependency to the EEF Codegen plugin : org.eclipse.emf.eef.codegen.

All generator projects extending EEF must have a dependency on its generation project

And finally, we add an Extension to the generator project. The org.eclipse.acceleo.engine.dynamic.templates defines a project as an dynamic module able to extend existing generators. In this extension, we must specify the folders containing dynamic modules. In our case, we can specify the folder org/eclipse/emf/samples/eef/gen/spinner/common.

All generator projects extending EEF must be defined as Acceleo dynamic modules

After these step, we can create our modules to generate spinner with EEF.

Creating Acceleo modules to generate a specific widget with EEF

In the CustomElementEditor guide, we modified 4 classes in the code generated by EEF in order to add manually a specific widget in an EEF editing form. To generate a specific widget, we have to create 4 generation modules.

Generating PropertiesEditionPart

The first module is the "GettersSetters" module defining the methods' signature for the views interfaces and their implementations in the PartImpls and the PartForms. In our case, we just have to override the generation in order to define the getters and setters implementations. We have to override two templates from the abstract module widgetGettersSetters :

  • getterSignatureImplementation
  • setterSignatureImplementation

To do that, you can use the override view in Acceleo :

6 - EEF CostumGen GettersSettersTemplateOverride.png

This view initialize the two templates to implement :

EEF CostumGen GettersSettersTemplateToOverride.png

Back to the top