Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: aea47aa986344c4848a36188767798c6fcf420d1 (plain) (blame)
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
/*******************************************************************************
 * Copyright (c) 2013 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:
 *     Cedric Dumoulin - cedric.dumoulin@lifl.fr
 ******************************************************************************/
package org.eclipse.papyrus.layers.runtime;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.emf.common.notify.Adapter;
import org.eclipse.emf.common.notify.Notification;
import org.eclipse.emf.common.notify.impl.AdapterImpl;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.gmf.runtime.notation.Diagram;
import org.eclipse.papyrus.infra.gmfdiag.common.model.NotationModel;
import org.eclipse.papyrus.layers.stackmodel.layers.LayersStack;
import org.eclipse.papyrus.layers.stackmodel.layers.LayersStackApplication;


/**
 * This class listen to a {@link Resource} and send following events to listeners:
 * <ul>
 * <li>diagram removed</li>
 * </ul>
 *
 * @author cedric dumoulin
 *
 */
public class NotationDiagramRemovedFromResourceEventNotifier {

	protected NotationModel notationModel;

	/**
	 * List of listener to notify.
	 */
	protected List<INotationDiagramRemovedEventListener> listeners = new ArrayList<INotationDiagramRemovedEventListener>();

	protected Adapter notationDiagramRemovedListener = new AdapterImpl() {
		@Override
		public void notifyChanged(Notification msg) {

			// TODO When a Resource is unloaded, each diagram is removed and a corresponding event is fired.
			// We need to separate event from a regular removal (user choose to remove a diagram) from events
			// event fired by 'resource.unload()' (to be done).
			if (msg.getEventType() == Notification.REMOVE
					&& msg.getNotifier() instanceof Resource
					&& msg.getOldValue() instanceof Diagram) {
				// A diagram is removed from its resource
				// System.err.println("Resource notified. Feature=" + msg.getFeature()
				// + ", type="+ msg.getEventType()
				// + ", newValue=" + msg.getNewValue()
				// + ", oldValue=" + msg.getOldValue());
				Resource resource = (Resource) msg.getNotifier();
				// Fire event only if resource is loaded. This should avoid firing event when the
				// diagram is removed because the resource is unloading.
				if (resource.isLoaded()) {
					fireDiagramRemovedEvent(msg);
				}
			}
		};

	};

	/**
	 * Constructor.
	 *
	 * @param layersModel
	 */
	public NotationDiagramRemovedFromResourceEventNotifier(NotationModel notationModel) {
		this.notationModel = notationModel;
		activate();
	}

	/**
	 * Activate the listeners.
	 *
	 */
	protected void activate() {
		// Listen on diagram removed events
		notationModel.getResource().eAdapters().add(notationDiagramRemovedListener);
	}

	/**
	 * Deactivate listeners
	 */
	protected void deactivate() {
		// Listen on diagram removed events
		notationModel.getResource().eAdapters().remove(notationDiagramRemovedListener);
	}

	/**
	 * Dispose the synchronizer
	 */
	protected void dispose() {
		// Deactivate listeners
		deactivate();
		notationModel = null;
	}

	/**
	 * Return true if the object is disposed.
	 * 
	 * @return
	 */
	protected boolean isDisposed() {
		return notationModel == null;
	}

	/**
	 * Add the specified listener to the list of listener.
	 * Do not add it if the listener is already in the list.
	 *
	 * @param listener
	 */
	public void addLayersModelEventListener(INotationDiagramRemovedEventListener listener) {

		if (listener == null) {
			return;
		}

		// Check if exist
		if (listeners.contains(listener)) {
			return;
		}

		listeners.add(listener);
	}

	/**
	 * Remove the specified listener from the list of listeners.
	 * 
	 * @param listener
	 */
	public void removeLayersModelEventListener(INotationDiagramRemovedEventListener listener) {

		listeners.remove(listener);
	}

	/**
	 * Called by events when a {@link LayersStack} is added to the {@link LayersStackApplication}
	 * 
	 * @param msg
	 */
	protected void fireDiagramRemovedEvent(Notification msg) {
		for (INotationDiagramRemovedEventListener listener : listeners) {
			listener.diagramRemoved(msg);
		}
	}

	/**
	 * Get the removed diagram in case of diagramRemoved event
	 * 
	 * @param msg
	 * @return
	 */
	public static Diagram getRemovedDiagram(Notification msg) {
		return (Diagram) msg.getOldValue();
	}


}

Back to the top