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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/*****************************************************************************
* Copyright (c) 2012, 2014 CEA LIST 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:
* Patrick Tessier (CEA LIST) Patrick.tessier@cea.fr - Initial API and implementation
* Christian W. Damus (CEA) - bug 323802
* Celine Janssens (ALL4TEC) celine.janssens@all4tec.net - Bug 460356 : Refactor Stereotype Display
*
*****************************************************************************/
package org.eclipse.papyrus.uml.diagram.common.editpolicies;
import org.eclipse.draw2d.IFigure;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
import org.eclipse.emf.transaction.util.TransactionUtil;
import org.eclipse.gef.Request;
import org.eclipse.gef.commands.Command;
import org.eclipse.gef.commands.UnexecutableCommand;
import org.eclipse.gmf.runtime.diagram.core.commands.DeleteCommand;
import org.eclipse.gmf.runtime.diagram.core.listener.DiagramEventBroker;
import org.eclipse.gmf.runtime.diagram.core.listener.NotificationListener;
import org.eclipse.gmf.runtime.diagram.ui.editparts.GraphicalEditPart;
import org.eclipse.gmf.runtime.diagram.ui.editparts.IGraphicalEditPart;
import org.eclipse.gmf.runtime.diagram.ui.requests.EditCommandRequestWrapper;
import org.eclipse.gmf.runtime.emf.type.core.requests.DestroyElementRequest;
import org.eclipse.gmf.runtime.notation.View;
import org.eclipse.papyrus.infra.core.listenerservice.IPapyrusListener;
import org.eclipse.papyrus.infra.gmfdiag.common.editpart.IPapyrusEditPart;
import org.eclipse.papyrus.infra.gmfdiag.common.model.NotationUtils;
import org.eclipse.papyrus.infra.gmfdiag.common.utils.GMFUnsafe;
import org.eclipse.papyrus.uml.diagram.common.Activator;
import org.eclipse.papyrus.uml.diagram.common.figure.node.IPapyrusNodeUMLElementFigure;
import org.eclipse.papyrus.uml.diagram.common.stereotype.display.helper.StereotypeDisplayConstant;
import org.eclipse.swt.widgets.Display;
import org.eclipse.uml2.uml.Element;
import org.eclipse.uml2.uml.util.UMLUtil;
/**
* This Edit Policy is attached to AppliedStereotypeCommentEdipart, and is in charge to prevent the deletion of the Comment from model
* and launch command of deletion if it detect that no property of applied stereotype are displayed.
*
*/
public class CommentShapeForAppliedStereotypeEditPolicy extends AbstractAppliedStereotypeDisplayEditPolicy implements NotificationListener, IPapyrusListener {
/**
* Returns the uml element controlled by the host edit part
*
* @return the uml element controlled by the host edit part
*/
@Override
protected Element getUMLElement() {
Element element = null;
if ((Element) getView().getElement() != null) {
element = (Element) getView().getElement();
} else {
EObject object = NotationUtils.getEObjectValue(getView(), StereotypeDisplayConstant.STEREOTYPE_COMMENT_RELATION_NAME, null);
if (object != null) {
if (object instanceof Element) {
element = (Element) object;
} else {
if (UMLUtil.getStereotype(object) != null) {
element = UMLUtil.getStereotype(object);
}
}
}
}
return element;
}
@Override
public Command getCommand(Request request) {
if (request instanceof EditCommandRequestWrapper) {
if (((EditCommandRequestWrapper) (request)).getEditCommandRequest() instanceof DestroyElementRequest) {
return UnexecutableCommand.INSTANCE;
}
}
return super.getCommand(request);
}
/**
* Refreshes the stereotypes properties displayed above name of the element
* in this edit part.
*
* @param stereotypesPropertiesToDisplay
*/
protected void refreshAppliedStereotypesPropertiesInBrace(IPapyrusNodeUMLElementFigure figure) {
String toDisplayInBrace = helper.getStereotypePropertiesInBrace(((GraphicalEditPart) getHost()).getNotationView());
// if the string is not empty, then, the figure has to display it. Else,
// it displays nothing
if (!"".equals(toDisplayInBrace)) {
// it has to be displayed in braces, so compute the string to
// display
figure.setStereotypePropertiesInBrace(toDisplayInBrace);
} else {
figure.setStereotypePropertiesInBrace(null);
}
}
/**
* Execute Comment Deletion
*
* @param domain
* TransactionalDomain
* @param commentNode
* Node of the Comment to be deleted.
*/
protected void executeAppliedStereotypeCommentDeletion(final TransactionalEditingDomain domain, final View commentNode) {
Display.getCurrent().asyncExec(new Runnable() {
@Override
public void run() {
// because it is asynchronous the comment node's domain maybe become null
if (TransactionUtil.getEditingDomain(commentNode) == domain) {
DeleteCommand command = new DeleteCommand(commentNode);
try {
GMFUnsafe.write(domain, command);
} catch (Exception e) {
Activator.log.error(e);
}
}
}
});
}
@Override
public void activate() {
super.activate();
// retrieve the view and the element managed by the edit part
View view = getView();
if (view == null) {
return;
}
// adds a listener on the view and the element controlled by the
// editpartrefr
getDiagramEventBroker().addNotificationListener(view, this);
}
/**
*
* {@inheritDoc}
*/
@Override
public void deactivate() {
// retrieve the view and the element managed by the edit part
View view = getView();
if (view == null) {
return;
}
getDiagramEventBroker().removeNotificationListener(view, this);
}
/**
* Gets the diagram event broker from the editing domain.
*
* @return the diagram event broker
*/
@Override
protected DiagramEventBroker getDiagramEventBroker() {
TransactionalEditingDomain theEditingDomain = ((IGraphicalEditPart) getHost()).getEditingDomain();
if (theEditingDomain != null) {
return DiagramEventBroker.getInstance(theEditingDomain);
}
return null;
}
/**
* Returns the view controlled by the host edit part
*
* @return the view controlled by the host edit part
*/
@Override
protected View getView() {
return (View) getHost().getModel();
}
/**
* @see org.eclipse.papyrus.uml.diagram.common.editpolicies.AppliedStereotypeLabelDisplayEditPolicy#refreshStereotypeDisplay()
*
*/
protected void refreshStereotypeDisplay() {
IFigure figure = ((IPapyrusEditPart) getHost()).getPrimaryShape();
// refresh Brace display
if (figure instanceof IPapyrusNodeUMLElementFigure) {
refreshAppliedStereotypesPropertiesInBrace((IPapyrusNodeUMLElementFigure) figure);
}
// Deletion of Comment
View commentNode = getView();
if (commentNode != null) {
final TransactionalEditingDomain domain = TransactionUtil.getEditingDomain(commentNode);
// if Base_Element is deleted, the Comment is deleted as well
if (getUMLElement() == null) {
executeAppliedStereotypeCommentDeletion(domain, commentNode);
}
}
}
/**
* @see org.eclipse.papyrus.uml.diagram.common.editpolicies.AbstractAppliedStereotypeDisplayEditPolicy#refreshDisplay()
*
*/
@Override
public void refreshDisplay() {
refreshStereotypeDisplay();
}
}
|
