Jump to content

Graphical Editing Framework

From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Anyssen (talk | contribs) at 20:38, 12 February 2016 (Added some historic information about the project as well as information about the new development stream GEF4.). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

The Graphical Editing Framework (GEF) is an Eclipse project that provides framework components to realize rich graphical applications.

The project was initially contributed to Eclipse by IBM in 2002, consisting of two components: Draw2d, a 2D-visualization component based on the Standard Widget Toolkit (SWT), as well as GEF (MVC), a related model-view-controller component that can be used to realize graphical editors as part of an Eclipse Rich Client Product (RCP) application. It is inter alia used by the Graphical Modeling Framework (GMF), which combines the Eclipse Modeling Framework (EMF) and GEF to create the code for both the data model and the graphical editor. Zest, a graph-based visualization toolkit, was added as a third project component in 2007. It can be used to realize views for visualization of graph-like data structures inside Eclipse applications.

Since 2004, when GEF 3.0 was released, only compatible changes have been applied to the framework's application programming interface (API). A new major revision of the framework, GEF 4.0, has been developed in parallel to the maintenance of the GEF 3.x code base by the project team since 2010. It is a complete redesign that is much more modular (consisting of 9 components), uses JavaFX instead of SWT as underlying rendering framework, and can be used also independent of the Eclipse RCP platform. Commonly referred to as GEF4, it was initially released in version 0.1.0 (with still provisional API) in June 2015 with the Eclipse Mars release.

Structure of GEF (MVC)

Editors created with GEF (MVC) consist of the following components:

  • The diagram editor including tool palette
  • Figures which graphically represent the underlying data model elements
  • EditParts which match figures and their respective model elements
  • Request objects for user input
  • EditPolicy objects which evaluate the requests and create appropriate command objects
  • Command objects that edit the model and provide undo-redo

Design Pattern Usage in GEF (MVC)

GEF makes heavy use of Design Patterns. These patterns are often mandatory under GEF and developers are required to understand them.

Model-View-Controller Pattern

Model-View-Controller is an architectural design pattern which divides an application into separate parts which communicate with each other in a specific way. The goal is to separate data model (model), graphical user interface (view) and business logic (controller). GEF uses the MVC pattern extensively.

  • Model: The data model can either be generated using EMF, self-implemented by the user or it may already exist in case of a legacy software.
  • Controller: The EditParts act as controllers. Typically, each model element has its matching EditPart. EditParts may contain other EditParts thereby matching model elements containing other model elements. EditParts also have a reference to the figure which graphically represents the model element. Finally, EditParts evaluate requests and create the appropriate command to edit the underlying model.
  • View: For each element within the model, including connections, a figure has to be implemented using the Draw2d framework. Oftentimes the figure is some geometrical drawing.
  • Factory: Creating models from palette, creating EditParts and creating Figures
  • Observer: Typically a controller (EditPart) listening on Model and View
  • Command: To implement Undo and Redo functions
  • Strategy: EditParts can install and remove EditPolicies dynamically
  • Chain of responsibility: To decide which EditPolicy should handle a Request

Request and Response Mechanism

Any user action with the editor can generate a request. The nature of the request is understood by the context of invocation. The context is determined by the EditPart the user interacts with and the active tool. The tool can be any selected entry in a tool palette. The request is handed over to the selected EditPart, which in turn returns a Command.

This is achieved using the Chain of responsibility mechanism over Editpolicies. The editpolicies determine if they can handle the request, otherwise they pass on to the next editpolicy. The order of declaration of editpolicies determine the order in which the request is passed around. The capable editpolicy creates a command. This command is handed back to the tool which initiated the "Request". Execution of the command causes the model to be modified (Response).