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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
/*****************************************************************************
* Copyright (c) 2009 CEA LIST.
*
* 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:
* Remi Schnekenburger (CEA LIST) remi.schnekenburger@cea.fr - Initial API and implementation
*
*****************************************************************************/
package org.eclipse.papyrus.uml.diagram.common.editpolicies;
import java.util.Collection;
import org.eclipse.emf.common.notify.Notification;
import org.eclipse.emf.ecore.EAnnotation;
import org.eclipse.emf.ecore.EModelElement;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
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.IGraphicalEditPart;
import org.eclipse.gmf.runtime.gef.ui.internal.editpolicies.GraphicalEditPolicyEx;
import org.eclipse.gmf.runtime.notation.View;
import org.eclipse.papyrus.infra.core.listenerservice.IPapyrusListener;
import org.eclipse.papyrus.infra.emf.appearance.helper.VisualInformationPapyrusConstants;
import org.eclipse.papyrus.infra.gmfdiag.common.editpolicies.IMaskManagedLabelEditPolicy;
import org.eclipse.papyrus.infra.gmfdiag.common.helper.MaskLabelHelper;
import org.eclipse.papyrus.uml.diagram.common.Activator;
import org.eclipse.uml2.uml.Element;
/**
* Default Abstract implementation of the {@link IMaskManagedLabelEditPolicy}.
*/
@SuppressWarnings("restriction")
public abstract class AbstractMaskManagedEditPolicy extends GraphicalEditPolicyEx implements NotificationListener, IPapyrusListener, IMaskManagedLabelEditPolicy {
/**
* Stores the semantic element related to the edit policy. If
* resolveSemanticElement is used, there are problems when the edit part is
* getting destroyed, i.e. the link to the semantic element is removed, but
* the listeners should still be removed
*/
protected Element hostSemanticElement;
/**
*
* {@inheritDoc}
*/
@Override
public void activate() {
// retrieve the view and the element managed by the edit part
View view = getView();
if(view == null) {
return;
}
hostSemanticElement = initSemanticElement();
if(hostSemanticElement != null) {
// adds a listener on the view and the element controlled by the
// editpart
getDiagramEventBroker().addNotificationListener(view, this);
getDiagramEventBroker().addNotificationListener(hostSemanticElement, this);
addAdditionalListeners();
refreshDisplay();
} else {
Activator.log.error("No semantic element was found during activation of the mask managed label edit policy", null);
}
}
/**
* Sets the semantic element which is linked to the edit policy
*
* @return the element linked to the edit policy
*/
protected Element initSemanticElement() {
return (Element)getView().getElement();
}
/**
* Adds more listeners upon activation
*/
protected void addAdditionalListeners() {
// default implementation does nothing
}
/**
* {@inheritDoc}
*/
@Override
public void refresh() {
super.refresh();
refreshDisplay();
}
/**
*
* {@inheritDoc}
*/
@Override
public void deactivate() {
// retrieve the view and the element managed by the edit part
View view = getView();
if(view == null) {
return;
}
// remove notification on element and view
getDiagramEventBroker().removeNotificationListener(view, this);
if(hostSemanticElement != null) {
getDiagramEventBroker().removeNotificationListener(hostSemanticElement, this);
removeAdditionalListeners();
}
// removes the reference to the semantic element
hostSemanticElement = null;
}
/**
* Remove additional listeners that were added during activation of the edit
* policy
*/
protected void removeAdditionalListeners() {
// default implementation does nothing
}
/**
* Gets the diagram event broker from the editing domain.
*
* @return the diagram event broker
*/
protected DiagramEventBroker getDiagramEventBroker() {
TransactionalEditingDomain theEditingDomain = ((IGraphicalEditPart)getHost()).getEditingDomain();
if(theEditingDomain != null) {
return DiagramEventBroker.getInstance(theEditingDomain);
}
return null;
}
/**
* Returns the {@link Element} managed by this edit part.
*
* @return the {@link Element} managed by this edit part.
*/
public Element getUMLElement() {
return hostSemanticElement;
}
/**
* Returns the view controlled by the host edit part
*
* @return the view controlled by the host edit part
*/
protected View getView() {
return (View)getHost().getModel();
}
/**
* Returns <code>true</code> if the specified object is the annotation in
* charge of the mask managed label.
*
* @param object
* the object to be checked
* @return <code>true</code> if the object is an {@link EAnnotation} and its
* source is the correct one.
*/
protected boolean isMaskManagedAnnotation(Object object) {
// check the notifier is an annotation
if((object instanceof EAnnotation)) {
// notifier is the eannotation. Check this is the annotation in
// charge of the property
// label display
if(VisualInformationPapyrusConstants.CUSTOM_APPEARENCE_ANNOTATION.equals(((EAnnotation)object).getSource())) {
return true;
}
}
return false;
}
/**
* Returns <code>true</code> if the the annotation in charge of the mask
* managed label is removed from the given object which should be a View.
*
* @param object
* the object to be checked
* @param notification
* the notification passed to the policy (which is a listener)
* @return <code>true</code> if the object is an {@link EAnnotation} and its
* source is the correct one.
*/
protected boolean isRemovedMaskManagedLabelAnnotation(Object object, Notification notification) {
// object is a model element, that means it has EAnnotations
if(object instanceof EModelElement) {
// something was removed.
if(notification.getEventType() == Notification.REMOVE) {
Object oldValue = notification.getOldValue();
// this is an annotation which is returned
if(oldValue instanceof EAnnotation) {
// returns true if the annotation has the correct source
return VisualInformationPapyrusConstants.CUSTOM_APPEARENCE_ANNOTATION.equals(((EAnnotation)oldValue).getSource());
}
}
}
return false;
}
/**
* {@inheritDoc}
*/
abstract public void refreshDisplay();
/**
* @see org.eclipse.gmf.runtime.diagram.core.listener.NotificationListener#notifyChanged(org.eclipse.emf.common.notify.Notification)
*
* @param notification
* the notification object
*/
public void notifyChanged(Notification notification) {
Object object = notification.getNotifier();
if(object != null && object.equals(getView())) {
refreshDisplay();
}
}
/**
* {@inheritDoc}
*/
public void setDefaultDisplayValue() {
MaskLabelHelper.unsetMaskValues((View)getHost().getModel());
}
/**
* {@inheritDoc}
*/
public void updateDisplayValue(Collection<String> newValue) {
MaskLabelHelper.setMaskValues((View)getHost().getModel(), newValue);
}
/**
* {@inheritDoc}
*/
public Collection<String> getCurrentDisplayValue() {
Collection<String> maskValues = MaskLabelHelper.getMaskValues((View)getHost().getModel());
if(maskValues == null) {
return getDefaultDisplayValue();
}
return maskValues;
}
protected abstract Collection<String> getDefaultDisplayValue();
}
|
