Jump to: navigation, search

Difference between revisions of "GEF/Developer FAQ"

< GEF
Line 5: Line 5:
  
 
== Why should I use GEF? ==
 
== Why should I use GEF? ==
GEF enables developers to easily create rich graphical editors within Eclipse. GEF has been used to build a variety of applications, including state diagrams, activity diagrams, class diagrams, GUI builders for AWT, Swing and SWT, and process flow editors. For more information on GEF features, please see the [http://www.eclipse.org/gef/overview.html?cvsroot=Tools_Project Project Overview].  
+
GEF enables developers to easily create rich graphical editors and views within Eclipse. GEF has been used to build a variety of applications, including state diagrams, activity diagrams, class diagrams, GUI builders for AWT, Swing and SWT, and process flow editors. For more information on GEF features, please see the [http://www.eclipse.org/gef/overview.html?cvsroot=Tools_Project Project Overview].  
 
+
== What version of Eclipse do I need? ==
+
A given version of GEF requires the exact same version of the Eclipse Platform.  For example, GEF 3.0.1 requires Eclipse 3.0.1.
+
 
+
== How do I make a suggestion for this FAQ? ==
+
This FAQ is hosted as a Wiki. Anyone can edit this page after creating an account.
+
 
+
== Which operating systems does GEF support? ==
+
GEF is written in pure Java and should run on all operating systems officially supported by the Eclipse platform. It's primarily tested on Windows and Linux (GTK and Motif). See the readme file that came with your installation of GEF for specific versions.
+
 
+
== How is GEF licensed? ==
+
GEF is licensed in accordance with the [http://www.eclipse.org/legal/epl-v10.html Eclipse Public License]. Third party components built using GEF are made available under their own licenses.
+
 
+
----
+
 
+
= Download and Install =
+
 
+
== How do I Install GEF? ==
+
 
+
1. Go to the Help / Install New Software ..."
+
 
+
2. Select or add one of the update sites listed on [[http://www.eclipse.org/gef/updates/index.php]].
+
 
+
3. Choose which GEF features you want to install and commit your selection by pressing "Finish".
+
 
+
== How do I Run the Logic Example? ==
+
[http://download.eclipse.org/tools/gef/downloads/ Download] the example that matches your version of GEF.  Exit Eclipse and unzip into the eclipse directory.  Restart Eclipse and verify it was installed by going to Help->About Eclipse Platform->Plug-in Details and checking for Logic GEF Example in the list.  Next, create a simple Project. Then run the Logic Wizard. The wizard can be found at File->New->Other (Control+N), under the Examples heading. Select the simple project as the container in which the wizard will place the example document. The document should open automatically when you press Finish.
+
 
+
== Where do I find the documentation? ==
+
The 3.1 documentation is now available [http://help.eclipse.org/help31 online].  [[Image:help_menu-1.png]]
+
 
+
The latest documentation is available in the SDK download. After unzipping this build into your Eclipse installation directory, start Eclipse (and possibly restart after updating via the update manager), click on the Help menu and then Help Contents.
+
 
+
When the Help window opens, there will be a section called GEF and Draw2d Plug-in Developer Guide. [[Image:help_toc.png]]
+
 
+
In this section, you'll find Developer Guides which contain high-level descriptions of GEF and Draw2d, as well as API References containing javadoc. 
+
[[Image:gef_dev_guide.png]]
+
 
+
----
+
 
+
= Developer =
+
  
 
== When should I use GEF and when should I use just Draw2d? ==
 
== When should I use GEF and when should I use just Draw2d? ==
Line 65: Line 24:
  
 
== Can I develop a standalone GEF application without use of the Eclipse platform? ==
 
== Can I develop a standalone GEF application without use of the Eclipse platform? ==
The official answer is No, this is not supported. The main reason involves the use of an Eclipse-specific file titled plugin.properties which GEF uses for string externalizations. However, since GEF is an open source project, modifications to the GEF codebase could potentially allow a GEF editor external to Eclipse.
+
The official answer is No, this is not supported.
  
 
== How can I get started on my GEF-based editor? ==
 
== How can I get started on my GEF-based editor? ==
The best place to investigate initially is the [http://www.eclipse.org/gef/developer/faq.html#install_doc GEF documentation]. This provides high-level concepts of GEF and Draw2d. There is also a sample GEF editor that can be downloaded at the [http://download.eclipse.org/tools/gef/downloads/ GEF download page] . The source code is made entirely available.
+
The best place to investigate initially is the [http://www.eclipse.org/gef/documentation.php GEF documentation]. This provides high-level concepts of GEF and Draw2d.
  
 
= Additional Documentation Links =
 
= Additional Documentation Links =
Line 76: Line 35:
 
* [[GEF/Examples | Examples]]
 
* [[GEF/Examples | Examples]]
 
* [[GEF/Troubleshooting Guide | Draw2d/GEF Troubleshooting Guide]]
 
* [[GEF/Troubleshooting Guide | Draw2d/GEF Troubleshooting Guide]]
 +
 +
= How do I make a suggestion for this FAQ? =
 +
This FAQ is hosted as a Wiki. Anyone can edit this page after creating an account.
  
 
[[Category:FAQ]]
 
[[Category:FAQ]]
 
[[Category:GEF]]
 
[[Category:GEF]]

Revision as of 11:03, 1 March 2012

General

What is GEF

The Graphical Editing Framework is an open source framework dedicated to providing a rich, consistent graphical editing environment for applications on the Eclipse Platform.

Why should I use GEF?

GEF enables developers to easily create rich graphical editors and views within Eclipse. GEF has been used to build a variety of applications, including state diagrams, activity diagrams, class diagrams, GUI builders for AWT, Swing and SWT, and process flow editors. For more information on GEF features, please see the Project Overview.

When should I use GEF and when should I use just Draw2d?

The simple answer to this question lies in their names. Draw2d is for drawing. GEF (or Graphical Editing Framework) is for editing.

Draw2d is used for rendering and layout. If all you want is to display data, all you need is Draw2d. If, on the other hand, you want to be able to manipulate that data, you should use GEF. GEF adds important functionality for editing -- commands for changing your model, a palette and tools for selecting and manipulating the edit parts that represent your model, direct edit, accessibility support such as keyboard navigation, native drag and drop, and much more that I've probably missed.

There may be only a few of these functions that you need -- for instance, you may just want to add drag and drop support so that you can drag files from the navigator or a file explorer and drop them onto your application/view, but otherwise only need to display the dropped data and not manipulate it. This is where the line gets blurred. You'll need to weigh the advantages and disadvantages of both options. On the one hand, you could move to GEF, get a bunch of functionality that you don't need and increase the complexity of your code. Or you could stick with Draw2d and implement the functionality you need yourself, maintaining a much simpler implementation. For the above example, I would personally implement the drag and drop function myself and stick with Draw2d. However, you should also consider future needs. You may want more of these functions down the road and moving to GEF now may be helpful.

How do I redistribute GEF with my application?

First off, you should probably check out the Eclipse.org Legal FAQ, the CPL FAQ, and/or the CPL itself. More information forthcoming.

How do I ask questions?

Questions about the use of GEF in user projects that are not addressed in this FAQ should be posted to the GEF newsgroup. Questions and comments regarding the implementation of GEF itself should be posted to the GEF mailing list.

How do I report a bug or request a feature?

GEF, like the Eclipse project, uses Bugzilla as its bug and feature tracking system. Entering a bug\feature report is as simple as filling in a web form on the eclipse bugzilla page. The first time you enter a bug you will need to create a new bugzilla account for yourself by providing an email address and choosing a password. Before submitting a bug, please be sure to check the list of open GEF bugs and recently closed GEF bugs.

Can I develop a standalone GEF application without use of the Eclipse platform?

The official answer is No, this is not supported.

How can I get started on my GEF-based editor?

The best place to investigate initially is the GEF documentation. This provides high-level concepts of GEF and Draw2d.

Additional Documentation Links

How do I make a suggestion for this FAQ?

This FAQ is hosted as a Wiki. Anyone can edit this page after creating an account.