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
|
/*****************************************************************************
* Copyright (c) 2012, 2016 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:
* Patrick Tessier (CEA LIST) Patrick.tessier@cea.fr - Initial API and implementation
* Christian W. Damus (CEA) - bug 323802
* Christian W. Damus - bug 492482
*
*****************************************************************************/
package org.eclipse.papyrus.infra.gmfdiag.common.editpolicies;
import org.eclipse.emf.common.notify.Notification;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
import org.eclipse.gef.editpolicies.GraphicalEditPolicy;
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.notation.View;
import org.eclipse.papyrus.infra.core.listenerservice.IPapyrusListener;
import org.eclipse.papyrus.infra.gmfdiag.common.Activator;
import org.eclipse.papyrus.infra.gmfdiag.common.commands.CreateShapeCompartmentViewCommand;
import org.eclipse.papyrus.infra.gmfdiag.common.commands.SetNodeVisibilityCommand;
import org.eclipse.papyrus.infra.gmfdiag.common.editpart.IPapyrusEditPart;
import org.eclipse.papyrus.infra.gmfdiag.common.editpart.IShapeCompartmentEditPart;
import org.eclipse.papyrus.infra.gmfdiag.common.service.shape.NotificationManager;
import org.eclipse.papyrus.infra.gmfdiag.common.service.shape.ShapeService;
import org.eclipse.swt.widgets.Display;
/**
* this edit policy can be apply only on {@link IPapyrusEditPart} in order to
* access to primary figure. the primary figure has to be a {@link IPapyrusNodeUMLElementFigure}.
* This edit policy manage the display of a shape in a new compartment and toggles the compartment display.
*/
public class ShapeCompartmentEditPolicy extends GraphicalEditPolicy implements AutomaticNotationEditPolicy, NotificationListener, IPapyrusListener {
/** constant for this edit policy role */
public static final String SHAPE_COMPARTMENT_EDIT_POLICY = "ShapeCompartmentEditPolicy"; //$NON-NLS-1$
/** manager for notifications: should the compartment react to the notification? */
protected NotificationManager notificationManager;
/**
* Creates a new AppliedStereotype display edit policy
*/
public ShapeCompartmentEditPolicy() {
super();
}
/**
*
* {@inheritDoc}
*/
@Override
public void activate() {
super.activate();
// retrieve the view and the element managed by the edit part
View view = getView();
if (view == null) {
return;
}
notificationManager = ShapeService.getInstance().createNotificationManager(getDiagramEventBroker(), view, this);
createShapeCompartment();
}
/**
*
* {@inheritDoc}
*/
@Override
public void deactivate() {
// retrieve the view and the element managed by the edit part
View view = getView();
if (view == null) {
return;
}
notificationManager.dispose();
notificationManager = null;
super.deactivate();
}
/**
* 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();
}
/**
* {@inheritDoc}
*/
public void refreshDisplay() {
final IGraphicalEditPart editPart = (IGraphicalEditPart) getHost();
editPart.refresh();
}
protected boolean hasToDisplayCompartment(EObject view) {
return ShapeService.getInstance().hasShapeToDisplay(view);
}
/**
* the goal of this method is to execute the a command to create a notation node for a compartment of stereotype
*
* @param editPart
* the editpart owner of the new compartment
* @param appliedstereotype
* the stereotype application
*/
protected void executeShapeCompartmentCreation(final IGraphicalEditPart editPart) {
try {
// boolean isVisible = hasToDisplayCompartment(editPart.getNotationView());
TransactionalEditingDomain domain = getEditingDomain(editPart);
CreateShapeCompartmentViewCommand command = new CreateShapeCompartmentViewCommand(domain, "Create Compartment", "Command that creates the compartment displaying shapes", editPart.getNotationView(), /* isVisible */false);
// This should not change the command stack, as this transaction will only manipulate transient views. Create a transaction manually, if needed
execute(command);
} catch (Exception e) {
Activator.log.error(e);
}
}
/**
* Returns the editing domain for the given edit Part
*
* @param editPart
* the edit part from which editing domain is searched
* @return the editing domain
*/
protected TransactionalEditingDomain getEditingDomain(IGraphicalEditPart editPart) {
return editPart.getEditingDomain();
}
/**
* 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;
}
/**
*
* {@inheritedDoc}
*/
@Override
public void notifyChanged(Notification notification) {
refreshDisplay();
}
/**
* this method creates a node for the compartment of stereotype if it does not exist.
*
* @param stereotypeApplication
* the stereotype application
*/
public void createShapeCompartment() {
final IGraphicalEditPart editPart = (IGraphicalEditPart) getHost();
final View node = editPart.getNotationView();
// Look for the node for the shape compartment
View shapeCompartment = getShapeCompartmentView(node);
// it does not exist
if (shapeCompartment == null) {
executeShapeCompartmentCreation(editPart);
}
}
/**
* Returns the view corresponding to the shape compartment
*
* @param node
* @return
*/
private View getShapeCompartmentView(View node) {
for (Object child : node.getChildren()) {
if (child instanceof View && IShapeCompartmentEditPart.VIEW_TYPE.equals(((View) child).getType())) {
return (View) child;
}
}
return null;
}
/**
* the goal of this method is to execute the a command to create a notation node for a compartment of stereotype
*
* @param editPart
* the editpart owner of the new compartment
* @param appliedstereotype
* the stereotype application
*/
protected void setVisibility(final View view, final boolean isVisible) {
final GraphicalEditPart editPart = (GraphicalEditPart) getHost();
Display.getCurrent().asyncExec(new Runnable() {
@Override
public void run() {
SetNodeVisibilityCommand setCommand = new SetNodeVisibilityCommand(editPart.getEditingDomain(), view, isVisible);
// use to avoid to put it in the command stack
execute(setCommand);
}
});
}
}
|
