blob: 306108fa7c9f374dfaf7699d20ed3be383e6ba3e [file] [log] [blame]
mwenzb05b8b72012-04-10 14:47:45 +02001<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
mwenza9262722012-05-29 15:54:20 +02006<title>New Graphiti Plug-in Wizard</title>
mwenzb05b8b72012-04-10 14:47:45 +02007<link href="../book.css" rel="Stylesheet" type="text/css">
8<link href="../code.css" rel="Stylesheet" type="text/css">
9<style type="text/css">
10.auto-style1 {
11 text-align: left;
12}
13</style>
14</head>
15
16<body>
17
mwenz62dbce92012-05-08 12:41:54 +020018 <h1>New Graphiti Plug-in Wizard</h1>
mwenzb05b8b72012-04-10 14:47:45 +020019 <p>
20 This wizard has been introduced with Graphiti 0.9.0 and allows the
21 creation of a new Eclipse plug-in project containing a basic Graphiti
22 editor. It is integrated in the <i>New Plug-in Project Wizard</i>
mwenza9262722012-05-29 15:54:20 +020023 provided by Eclipse PDE and can be started via <i>File --&gt; New
24 --&gt; Project... --&gt; Plug-in Development --&gt; Plug-in Project</i>.
25 The user can specify the name along with the other settings for the
26 new plug-in project and on the third page of the wizard select the
27 template <i>Plug-in with a Graphiti Editor</i>.
mwenzb05b8b72012-04-10 14:47:45 +020028 </p>
29 <img alt="Template selection for new Plug-in with a Graphiti Editor"
30 src="images/NPW_Template.png" width="400px">
31 <p>On the next page, the user can change the pre-filled definitions
32 of the Graphiti Diagram Type, Diagram Type Provider and Feature
33 Provider to be created. The initial values proposed there are derived
34 from the name of the plug-in project.</p>
mwenza9262722012-05-29 15:54:20 +020035 <p>In the lower part of the screen (section "Feature Provider") the
36 user can decide if he wants to use the standard feature or the pattern
37 approach for implementing the Graphiti editor.</p>
38 <img alt="General settings for new Plug-in with a Graphiti Editor"
39 src="images/NPW_Settings1.png" width="400px">
40 <p>On the last page of the wizard the user can finally define any
41 domain objects he would like to use within the editor. By default none
42 are used, but both for the shape and the connection created by the
43 wizard, the user can reference a domain object to be used. (It might
44 be an EObject but does not need to be.)</p>
45 <img
46 alt="Domain object settings for new Plug-in with a Graphiti Editor"
47 src="images/NPW_Settings2.png" width="400px">
mwenzb05b8b72012-04-10 14:47:45 +020048 <p>After finishing the wizard a new plug-in is created containing
49 the definitions and basic implementation classes for a new Graphiti
50 diagram editor that allows the creation of new shapes and connections
51 between shapes. The shapes and connections are not yet linked to any
52 domain objects but offer a good starting point for building a real
53 editor. The user may simply start a Eclipse Application as runtime for
54 this and simply create a new Graphiti diagram with the new type by
55 using the Graphiti New Diagram Wizard that comes as part of the
56 examples.</p>
mwenza9262722012-05-29 15:54:20 +020057 <p>
58 There are still some spots in the generated coding that are marked
59 with a <i>// TODO</i> tag. Here the client needs to adapt the coding,
60 e.g. to create a new instance of the domain object. Also some type
61 checks are generated but not yet enabled, because by default the
62 wizard cannot create linked domain objects.
63 </p>
mwenzb05b8b72012-04-10 14:47:45 +020064</body>
65</html>