Eclipse Graphical Editing Framework (GEF) Classic

This repository contains the code base of the Eclipse Graphical Editing Framework (GEF) project's classic components:

• GEF (MVC) 3.x
• Draw2d 3.x
• Zest 2.x

The code base of the GEF components implemented in JavaFX is located in the eclipse-gef/gef repository instead.

Update sites:

Update Sites (p2 repositories) are available at:

• Latest release of GEF Classic: https://download.eclipse.org/tools/gef/classic/release/latest
• Latest version build from master: https://download.eclipse.org/tools/gef/classic/nightly/latest

Other update sites are:

• 3.x.y release: https://download.eclipse.org/tools/gef/classic/release/3.x.y

Getting started with the framework components (adopters)

In order to develop graphical applications with GEF Classic, you should first set up a proper development environment. The following sections shortly lay out how to set up an Eclipse IDE for this purpose. They conclude with running our deployed and undeployed examples to confirm everything is set up properly.

Having accomplished that, you might want to browse our developer documentation to learn about the framework components in detail. At any time, if you get stuck, feel free to contact us.

Set up an Eclipse IDE

1. Install a recent Java SE Development Kit 17 as a prerequisite.
2. Download an 'Eclipse IDE for Eclipse Committers ' package and start it, pointing to an empty workspace folder.

Set up a Target Definition containing GEF Classic (development snapshot)

1. Go to File -> New -> Project... and select to create a General/Project. Name it gef-classic-integration.target or as you like, the project is to contain only a target definition.

2. Go to File -> New -> Other... then choose Plug-in Development/Target Definition and create a new empty (Nothing: Start with an empty target definition) target definition file named gef-classic-integration.target within the newly created project.

3. Close the Target Editor that has automatically opened, open the target file with the Text Editor using the Open With context menu, then paste the following contents:

   <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   <?pde version="3.8"?><target name="gef-integration" sequenceNumber="1">
   <locations>
   <location includeAllPlatforms="false" includeConfigurePhase="true" includeMode="planner" includeSource="true" type="InstallableUnit">
   <unit id="org.eclipse.sdk.ide" version="0.0.0"/>
   <repository location="https://download.eclipse.org/releases/latest"/>
   </location>
   <location includeAllPlatforms="false" includeConfigurePhase="true" includeMode="planner" includeSource="true" type="InstallableUnit">
   <unit id="org.eclipse.zest.sdk.feature.group" version="0.0.0"/>
   <unit id="org.eclipse.draw2d.sdk.feature.group" version="0.0.0"/>
   <unit id="org.eclipse.gef.sdk.feature.group" version="0.0.0"/>
   <unit id="org.eclipse.gef.examples.feature.group" version="0.0.0"/>
   <repository location="https://download.eclipse.org/tools/gef/classic/nightly/latest"/>
   </location>
   </locations>
   </target>
   

4. Now open the gef-classic-integration.target file with the Target Editor again, using the Open With context menu, let if fully resolve, then click Set as Target Platform (link in the upper right corner of the editor).

Run the examples

As the deployed 'Flow', 'Logic', 'Shapes', and 'WYSIWYG Document' GEF (MVC) examples are contained in the target definition, we only need to start a new Eclipse Runtime to run them:

1. Go to Run -> Run Configurations... then create a new Eclipse Application launch configuration and Run it.
2. Go to File -> New -> Project... and select to create a new General/Project. Name it gef-logic-example or as you like.
3. Go to File -> New -> Example... and select to create a new GEF (Graphical Editing Framework)/Logic Diagram, choosing the Four-bit Adder Model from the Logic Model Samples section.

The undeployed Draw2d and Zest examples have to be checked out in source before. Using EGit this can easily be achieved as follows:

1. Go to File -> Import..., then select Git/Projects from Git, press Next >.
2. Select Clone URI, press Next >.
3. Paste https://github.com/eclipse-gef/gef-classic.git to the URI field , press Next >.
4. Select master branch, press Next >.
5. Confirm the local directory or change it as needed, press Next >.
6. Ensure Import existing Eclipse projects is checked, then select Working Tree and press Next >.
7. Select org.eclipse.draw2d.examples and org.eclipse.zest.examples, press Finish.
8. Select an arbitrary example class, e.g. org.eclipse.zest.examples.jface.GraphJFaceSnippet1, in the Package Explorer view and select Run As -> Java Application from the context menu.

How to proceed from here?

The first thing you will probably want to consult is the developer documentation, which explains the different framework components in detail. It is bundled by the individual SDK features that are available for the framework components and can be accessed via Help -> Help Contents if these features are installed into the Eclipse IDE (its not sufficient to include them in a target definition for this purpose). It is further contributed to help.eclipse.org for each release, where it can be accessed online.⁶⁾

All further project information (forum, mailing list, issue tracker, update-site locations, release plans) can be retrieved from the project meta-data at projects.eclipse.org.

If you want to contribute, please consult the contributor guide.