Blame - examples/org.eclipse.graphiti.doc/resources/docu/gfw/diagram.htm - graphiti/org.eclipse.graphiti

jpasch

947e2ec

2011-12-27 15:25:37 +0100

[diff] [blame^]

1

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>

<head>

<title>Diagram</title>

</head>

<body>

<h1>Diagram</h1>

For the creation of an editor, it is necessary to implement a diagram type

15

agent. This diagram type agent consists of a diagram type provider and

16

a feature provider. The minimum implementation of the diagram type provider

17

is described in this chapter.

18

<h2>Create a Plug-In</h2>

19

Create a plug-in project for your diagram type specific graphical editor. Please

20

keep in mind not to use the ID org.eclipse.graphiti.tutorial, which

21

is the ID of our implementation of the tutorial. Additionally use different ID's

22

for implementations of our extension points, see below.

23

You should have references to following plug-ins: org.eclipse.graphiti,

24

org.eclipse.graphiti.ui, org.eclipse.graphiti.examples.common,

25

org.eclipse.core.resources, org.eclipse.core.runtime, org.eclipse.ui.views.properties.tabbed.

26

Hint: the final version of this tutorial as it is included in the SDK download

27

of Graphiti actually defines more dependencies; these are introduced in later sections

28

of this tutorial. To start off with the tutorial only the above mentioned dependencies

29

are required.

30

<h2>Create a Diagram Type Provider</h2>

31

A diagram type provider has to implement the interface

32

<a href="../../../javadoc/org/eclipse/graphiti/dt/IDiagramTypeProvider.html">IDiagramTypeProvider</a>.

33

Instead of implementing it directly it should extend one of the available base classes.

34

In this example we extend the base class

35

36

AbstractDiagramTypeProvider</a>.

37

You can see the complete implementation of the diagram type provider here:

38

package

org.eclipse.graphiti.examples.tutorial.diagram;

44

public class MyTutorialDiagramTypeProvider

45

extends AbstractDiagramTypeProvider {

46

public

47

MyTutorialDiagramTypeProvider() {

super();

} }

</div>

</div>

54

<h2>Create a Diagram Type</h2>

55

If you create a diagram type provider for a diagram type which does not exist

56

in the repository, it is necessary to provide also information about this new diagram

57

type.The diagram type advertises that the containing diagram type provider understands

58

the given diagram type and is suitable for editing and viewing diagrams of that

59

type.

60

The information about a diagram type must be declared in the plugin.xml.

61

<h2>Register the Diagram Type Provider and Diagram Type</h2>

62

The newly created diagram type provider and diagram type are registered through

63

the extension points:

64

<ul>

65

<li><a href="../extension-points/diagramTypes.html">diagramTypes</a></li>

66

<li><a href="../extension-points/diagramTypeProviders.html">diagramTypeProviders</a></li>

67

</ul>

68

The corresponding plugin.xml looks similar to this:

69

70

71

72

<?xml version="1.0" encoding="UTF-8"?> <?eclipse version="3.0"?>

73

<plugin>   <extension

74

point="org.eclipse.graphiti.ui.diagramTypes">

75

<diagramType

76

description="This is the

77

diagram type for my Graphiti tutorial"

78

id="org.eclipse.graphiti.examples.tutorial.diagram.MyTutorialDiagramType"

79

name="My Graphiti Tutorial

80

Diagram Type"

81

type="mytutorial">

82

</diagramType>   </extension>

83

84

<diagramTypeProvider

85

class="org.eclipse.graphiti.examples.tutorial.diagram.

86

MyTutorialDiagramTypeProvider"

87

description="This is my

88

editor for the Graphiti tutorial"

89

id="org.eclipse.graphiti.examples.tutorial.diagram.

90

MyTutorialDiagramTypeProvider"

91

name="My tutorial editor">

92

93

</diagramType>     </diagramTypeProvider>   </extension>

</plugin>

</div>

</div>

100

For further information to these extension points, see the extension point description

in the Eclipse IDE.

</body>

</html>