1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*****************************************************************************
* Copyright (c) 2008, 2016 LIFL, CEA LIST, Christian W. Damus, and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Cedric Dumoulin Cedric.dumoulin@lifl.fr - Initial API and implementation
* Christian W. Damus (CEA) - service hook for integrating tools into graphical editor (CDO)
* Christian W. Damus (CEA) - bug 392301
* Christian W. Damus - bug 474467
*
*****************************************************************************/
package org.eclipse.papyrus.infra.gmfdiag.common;
import java.lang.reflect.Constructor;
import org.eclipse.gef.ui.parts.GraphicalEditor;
import org.eclipse.gmf.runtime.notation.Diagram;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.papyrus.infra.core.editor.BackboneException;
import org.eclipse.papyrus.infra.core.sasheditor.contentprovider.AbstractPageModel;
import org.eclipse.papyrus.infra.core.sasheditor.contentprovider.IEditorModel;
import org.eclipse.papyrus.infra.core.sasheditor.contentprovider.IPageModel;
import org.eclipse.papyrus.infra.core.services.ServiceException;
import org.eclipse.papyrus.infra.core.services.ServicesRegistry;
import org.eclipse.papyrus.infra.core.utils.ServiceUtils;
import org.eclipse.papyrus.infra.gmfdiag.common.messages.Messages;
import org.eclipse.papyrus.infra.gmfdiag.common.providers.NotationLabelProvider;
import org.eclipse.papyrus.infra.services.labelprovider.service.LabelProviderService;
import org.eclipse.papyrus.infra.ui.extension.diagrameditor.AbstractEditorFactory;
import org.eclipse.papyrus.infra.ui.multidiagram.actionbarcontributor.ActionBarContributorRegistry;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.part.EditorActionBarContributor;
/**
* Base class of GmfEditor factories. Editor should subclass this class and provide a 0 args
* constructor initializing the super class.
*
* @author Cedric Dumoulin
* @author Remi Schnekenburger
* @author Patrick Tessier
*/
public class GmfEditorFactory extends AbstractEditorFactory {
/**
* Creates a new GmfEditorFactory.
*
* @param diagramClass
* expected Class of the diagram to create.
* @param expectedType
* expected diagram type (@see {@link Diagram#getType()})
*/
protected GmfEditorFactory(Class<?> diagramClass, String expectedType) {
super(diagramClass, expectedType);
}
/**
* Return true if this PageModelFactory can create a PageModel for the specified pageIdentifier.
* The pageIdentifier is an instance of Diagram.
*
* @see org.eclipse.papyrus.infra.ui.extension.diagrameditor.IPluggableEditorFactory#isPageModelFactoryFor(java.lang.Object)
* @param pageIdentifier
* @return
*
*/
@Override
public boolean isPageModelFactoryFor(Object pageIdentifier) {
if (pageIdentifier instanceof Diagram) {
Diagram diagram = (Diagram) pageIdentifier;
// disable it when diagram is a proxy (dedicated factory will handle it)
if (!diagram.eIsProxy()) {
final String type = diagram.getType();
return getExpectedType().equals(type);
}
}
// no
return false;
}
@Override
public IPageModel createIPageModel(Object pageIdentifier) {
ServicesRegistry services = getServiceRegistry();
ILabelProvider labels = ServiceUtils.getInstance().tryService(services, LabelProviderService.class)
.map(lps -> lps.getLabelProvider(pageIdentifier))
.orElseGet(NotationLabelProvider::new);
return new GMFEditorModel((Diagram) pageIdentifier, services, labels);
}
/**
* IEditorModel handling creation of the requested Editor.
*
* @author dumoulin
*
*/
class GMFEditorModel extends AbstractPageModel implements IEditorModel {
/**
* The Diagram object describing the diagram.
*/
private Diagram diagram;
/**
* The servicesRegistry provided at creation.
*/
private ServicesRegistry servicesRegistry;
/**
*
* Constructor.
*/
public GMFEditorModel(Diagram pageIdentifier, ServicesRegistry servicesRegistry, ILabelProvider labels) {
super(labels);
diagram = pageIdentifier;
this.servicesRegistry = servicesRegistry;
}
/**
* Create the IEditor for the diagram.
*
* @see org.eclipse.papyrus.infra.core.sasheditor.contentprovider.IEditorModel#createIEditorPart()
* @return
* @throws PartInitException
*
*/
@Override
public IEditorPart createIEditorPart() throws PartInitException {
GraphicalEditor editor;
try {
Constructor<?> c = getDiagramClass().getConstructor(ServicesRegistry.class, Diagram.class);
editor = (GraphicalEditor) c.newInstance(servicesRegistry, diagram);
IGraphicalEditorSupport editorSupport = servicesRegistry.getService(IGraphicalEditorSupport.class);
editorSupport.initialize(editor);
return editor;
} catch (Exception e) {
// Lets propagate. This is an implementation problem that should be solved by
// programmer.
throw new PartInitException(Messages.GmfEditorFactory_ErrorCreatingEditorPart + diagram, e);
}
}
/**
* Get the action bar requested by the Editor.
*
* @see org.eclipse.papyrus.infra.core.sasheditor.contentprovider.IEditorModel#getActionBarContributor()
* @return
*
*/
@Override
public EditorActionBarContributor getActionBarContributor() {
String actionBarId = editorDescriptor.getActionBarContributorId();
// Do nothing if no EditorActionBarContributor is specify.
if (actionBarId == null || actionBarId.length() == 0) {
return null;
}
// Try to get it.
// Get ServiceRegistry
// ServicesRegistry serviceRegistry = getServicesRegistry();
ActionBarContributorRegistry registry;
try {
registry = servicesRegistry.getService(ActionBarContributorRegistry.class);
} catch (ServiceException e) {
// Service not found
// TODO Log the error
e.printStackTrace();
return null;
}
try {
return registry.getActionBarContributor(actionBarId);
} catch (BackboneException e) {
// TODO Log the error and throw an exception instead
e.printStackTrace();
return null;
}
}
/**
* Get the underlying RawModel. Return the Diagram.
*
* @see org.eclipse.papyrus.infra.core.sasheditor.contentprovider.IPageModel#getRawModel()
* @return
*
*/
@Override
public Object getRawModel() {
return diagram;
}
}
}
|
