Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 309dd045c8579f2727e960038d3110100a5b7ab6 (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
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
/*****************************************************************************
 * Copyright (c) 2008, 2015, 2019 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 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *  Cedric Dumoulin  Cedric.dumoulin@lifl.fr - Initial API and implementation
 *  Christian W. Damus (CEA) - bug 392301
 *  Christian W. Damus - bug 469188
 *  Nicolas FAUVERGUE (CEA LIST) nicolas.fauvergue@cea.fr - Bug 546686
 *  Pauline DEVILLE (CEA LIST) pauline.deville@cea.fr - Bug 546686
 *
 *****************************************************************************/
package org.eclipse.papyrus.infra.core.sasheditor.internal;

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

import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.util.Geometry;
import org.eclipse.papyrus.infra.core.sasheditor.Activator;
import org.eclipse.papyrus.infra.core.sasheditor.contentprovider.IPageModel;
import org.eclipse.papyrus.infra.core.sasheditor.contentprovider.ITabFolderModel;
import org.eclipse.papyrus.infra.core.sasheditor.editor.ICloseablePart;
import org.eclipse.papyrus.infra.core.sasheditor.editor.IFolder;
import org.eclipse.papyrus.infra.core.sasheditor.internal.dnd.DragManager;
import org.eclipse.papyrus.infra.core.sasheditor.internal.dnd.IDragOverListener;
import org.eclipse.papyrus.infra.core.sasheditor.internal.dnd.IDropTarget;
import org.eclipse.papyrus.infra.core.sasheditor.internal.dnd.PapyrusDragUtils;
import org.eclipse.papyrus.infra.tools.util.PlatformHelper;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.CTabFolderEvent;
import org.eclipse.swt.custom.CTabItem;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.events.MenuDetectEvent;
import org.eclipse.swt.events.MouseEvent;
import org.eclipse.swt.events.MouseTrackListener;
import org.eclipse.swt.graphics.Cursor;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.ui.IPropertyListener;

/**
 * Controller associated to a tabfolder.
 *
 *
 *
 * Extends MultiPageEditor to inherit methods implementations.
 *
 * @param T
 *            Common ancestor for the model provided for the sash windows by the application.
 *            This is the type used externally by the application. Sash implementation don't use this type,
 *            it just carry it to ask for the appropriate wrapper. Concrete implementation can specify
 *            a type.
 *
 *            TODO : be more precise for the generic type ?
 *            TODO : Listen to the page change event, and call setActivePage().
 */
public class TabFolderPart extends AbstractTabFolderPart implements IFolder {

	/** Interface to the model */
	protected ITabFolderModel partModel;

	/** Raw model associated to this part. We store it because the PartModel do not provide it */
	private Object rawModel;

	/** The wrapper around the CTabFolder. This represent the SWT control associated to this part. */
	protected PTabFolder pTabFolder;

	/** Ordered set of currently shown diagrams (list of their models) TODO remove */
	protected TabPartList currentTabItems = new TabPartList();

	/** The drop target associated to this folderPart */
	private DropTarget dropTarget;

	/**
	 * Track the mouse hover and fire appropriate event.
	 */
	private MouseHoverTracker mouseHoverTracker;


	/**
	 * Listener on DragOver event.
	 */
	IDragOverListener dragOverListener = new IDragOverListener() {

		/**
		 *
		 * @see org.eclipse.papyrus.infra.core.sasheditor.internal.dnd.IDragOverListener#drag(org.eclipse.swt.widgets.Control, java.lang.Object, org.eclipse.swt.graphics.Point, org.eclipse.swt.graphics.Rectangle)
		 */
		@Override
		public IDropTarget drag(Control currentControl, Object draggedObject, Point position, Rectangle dragRectangle) {
			// System.out.println(TabFolderPart.this.getClass().getSimpleName() + ".drag()");
			// System.out.println(this + ".drag()");
			return null;
		}
	};

	/**
	 * Listener on CTabFolder events.
	 */
	private PTabFolder.IPTabFolderListener cTabFolderEventListener = new PTabFolder.IPTabFolderListener() {

		@Override
		public void contextMenuDetectEvent(CTabItem tab, Event event) {
			// System.out.println("contextMenuDetect()");
		}

		/**
		 * The close cross has been pressed. Remove the corresponding tab. {@inheritDoc}
		 */
		@Override
		public void itemClosedEvent(CTabFolderEvent event, int pageIndex) {
			// System.out.println("itemClosedEvent()");
			// TODO: call appropriate method (to be determine)
			// model.removeTab(pageIndex);
			// getSashWindowContainer().getContentProvider().removeTab(model, pageIndex);
			getContentProvider().removePage(partModel, pageIndex);
		}

		@Override
		public void menuDetectEvent(CTabItem tab, MenuDetectEvent event) {
			// System.out.println("menuDetectEvent()");
		}

		/**
		 * Listen to pageChange event, and propagate to TabFolderPart.
		 *
		 * @param newPageIndex
		 */
		@Override
		public void pageChangeEvent(int newPageIndex) {
			// User has change the page. Inform the TabFolderPart
			pageChange(newPageIndex);
		}

		/**
		 * A double click is detected.
		 *
		 * @see org.eclipse.papyrus.infra.core.sasheditor.internal.PTabFolder.IPTabFolderListener#mouseDoubleClickEvent(int, org.eclipse.swt.events.MouseEvent)
		 *
		 * @param itemIndex
		 * @param e
		 */
		@Override
		public void mouseDoubleClickEvent(int itemIndex, MouseEvent e) {

			PagePart page = getPagePart(itemIndex);
			getSashWindowContainer().getFolderTabMouseEventProvider().fireMouseDoubleClickEvent(page, TabFolderPart.this, e);
		}

		/**
		 * A double click is detected.
		 *
		 * @see org.eclipse.papyrus.infra.core.sasheditor.internal.PTabFolder.IPTabFolderListener#mouseDoubleClickEvent(int, org.eclipse.swt.events.MouseEvent)
		 *
		 * @param itemIndex
		 * @param e
		 */
		@Override
		public void mouseUpEvent(int itemIndex, MouseEvent e) {

			PagePart page = getPagePart(itemIndex);
			getSashWindowContainer().getFolderTabMouseEventProvider().fireMouseUpEvent(page, TabFolderPart.this, e);
		}

		/**
		 * A double click is detected.
		 *
		 * @see org.eclipse.papyrus.infra.core.sasheditor.internal.PTabFolder.IPTabFolderListener#mouseDoubleClickEvent(int, org.eclipse.swt.events.MouseEvent)
		 *
		 * @param itemIndex
		 * @param e
		 */
		@Override
		public void mouseDownEvent(int itemIndex, MouseEvent e) {

			PagePart page = getPagePart(itemIndex);
			getSashWindowContainer().getFolderTabMouseEventProvider().fireMouseDownEvent(page, TabFolderPart.this, e);
		}

	};

	/**
	 * Constructor.
	 *
	 * @param nestedPartManager
	 * @param partModel
	 * @param rawModel
	 *
	 */
	public TabFolderPart(IPanelParent parent, ITabFolderModel partModel, Object rawModel) {
		super(parent);
		this.partModel = partModel;
		this.rawModel = rawModel;
	}

	/**
	 * Get the associated model.
	 */
	protected ITabFolderModel getPartModel() {
		return partModel;
	}

	/**
	 * Activate the part. Register as listener to required services.
	 */
	private void activate() {
		// Listen to page changes
		pTabFolder.getEventManager().addListener(cTabFolderEventListener);
		// Create the tracker that will show tooltips on tabs.
		mouseHoverTracker = new MouseHoverTracker(pTabFolder.getControl(), new ImageToolTipManager());
	}

	/**
	 * Deactivate this part.
	 * Unregistered from required service. Do not dispose the part.
	 */
	private void deactivate() {
		// Listen to page changes
		pTabFolder.getEventManager().removeListener(cTabFolderEventListener);
		mouseHoverTracker.deactivate();
	}

	/**
	 * Fill the provided part map with this parts and recursively call children to fillin.
	 *
	 * @param partMap
	 */
	@Override
	public void fillPartMap(PartLists partMap) {
		partMap.addPart(this);
		garbageState = GarbageState.UNVISITED;

		for (TabItemPart child : currentTabItems) {
			child.fillPartMap(partMap);
		}
	}

	/**
	 * Creates the control tree associated to this part.
	 * Create the control for this part, and eventually recursively call the method for the childs, if any.
	 *
	 */
	@Override
	public void createPartControl(Composite parent) {

		createControl(parent);
		// createPages();
		// model.addChangeListener(modelListener);
		// model.activate();
		activate();
	}

	/**
	 * Add a new page at the end of pages. A new tab is created for the page, and
	 * the page control is created.
	 *
	 * @param pageModel
	 * @param index
	 */
	// private void addPage(Object pageModel)
	// {
	// int index = currentTabItems.size();
	// createTabItem(pageModel, index);
	// }

	/**
	 * Create the control for this Part. Does not create children.
	 * This method is called by the parent after this folder is created.
	 *
	 */
	public void createControl(Composite parent) {
		PTabFolder res = new PTabFolder();
		pTabFolder = res;
		res.createPartControl(parent);
		initDrag(res.getControl());
		// init menu
		initMenuManager();
		// throw creation event
		getSashWindowContainer().getFolderLifeCycleEventProvider().fireFolderCreatedEvent(this);
	}

	/**
	 * Init the menuManager after the control has been created.
	 * Get the {@link MenuManager} from the {@link SashWindowsContainer}. Set it to this folder if it
	 * is not null.
	 */
	private void initMenuManager() {
		MenuManager menuManager = getSashWindowContainer().getFolderTabMenuManager();
		if (menuManager != null) {
			setFolderTabMenuManager(menuManager);
		}

	}

	/**
	 * Set a {@link MenuManager} used to manage a contextual menu that is shown on the tabs area of this folder.
	 *
	 * @param menuManager
	 *            The {@link MenuManager} used to create the menu on the tab area.
	 */
	public void setFolderTabMenuManager(MenuManager menuManager) {
		Composite folderControl = getControl();
		Menu menu = menuManager.createContextMenu(folderControl);
		folderControl.setMenu(menu);
	}


	/**
	 * Called by any widget that has detected that the page has changed. <br>
	 * As the selected page has been changed by a user ui interaction, we now need
	 * to synchronize the ActivePage.
	 * Inform the {@link SashWindowsContainer} to set the active page accordingly to
	 * the new selection.
	 *
	 * @param newPageIndex
	 */
	@Override
	protected void pageChange(int newPageIndex) {

		// System.out.println(this.getClass().getSimpleName() + ".pageChange("+ newPageIndex +")");
		// Do nothing if out of range.
		if (newPageIndex < 0 || newPageIndex > currentTabItems.size() - 1) {
			return;
		}

		getSashWindowContainer().setActivePageRequest(currentTabItems.get(newPageIndex).childPart);
	}

	/**
	 * An event signaling that the selected page is changed has been caught. Propagate the event to
	 * the container.
	 * Removed since 0.10
	 *
	 * @param newPageIndex
	 */
	// protected void pageChangedEvent(int newPageIndex) {
	//
	// // System.out.println(this.getClass().getSimpleName() + ".pageChange("+ newPageIndex +")");
	// // Do nothing if out of range.
	// if(newPageIndex < 0 || newPageIndex > currentTabItems.size() - 1)
	// return;
	//
	// getSashWindowContainer().pageChangedEvent(currentTabItems.get(newPageIndex).childPart);
	// }

	/**
	 * Select the specified page.
	 * Do nothing if the index is out of range.
	 *
	 * @param pageIndex
	 */
	protected void setSelection(int pageIndex) {
		// Assert.isTrue(pageIndex >= 0 && pageIndex < getPageCount());
		if (!isValidPageIndex(pageIndex)) {
			return;
		}

		getTabFolder().setSelection(pageIndex);
	}

	/**
	 * Set the current selection of this folder. This do not fire events.
	 * This does not set the ActivePage.
	 *
	 * @param page
	 *            the page that should be selected
	 * @since 3.3
	 */
	public final void setSelection(PagePart requestedPage) {
		// TODO There should be another way to get the index of the corresponding
		// PagePArt
		int count = getPageCount();
		for (int i = 0; i < count; i++) {
			PagePart page = getPagePart(i);
			if (page == requestedPage) {
				setSelection(i);
				break;
			}
		}
	}

	/**
	 * Dispose the TilePart and its controls.
	 *
	 * @see org.eclipse.papyrus.infra.core.sasheditor.eclipsecopy.MultiPageEditorTile#dispose()
	 */
	@Override
	public void dispose() {
		// detach menu as it is shared between folders.
		getControl().setMenu(null);
		// throw dispose event
		getSashWindowContainer().getFolderLifeCycleEventProvider().fireFolderDisposedEvent(this);

		deactivate();


		// getControl().dispose();
		pTabFolder.dispose();
	}

	/**
	 * Dispose this part and all its children.
	 * The method is called recursively on children of the part.
	 * Associated items are disposed.
	 */
	@Override
	public void disposeThisAndChildren() {

		// Dispose children if any
		for (TabItemPart child : currentTabItems) {
			if (child != null) {
				child.disposeThisAndChildren();
			}
		}

		// clean up properties to help GC
		partModel = null;
		rawModel = null;
		currentTabItems.clear();
		currentTabItems = null;
		dragOverListener = null;

	}

	/**
	 *
	 */
	private void initDrag(Composite container) {
		DragManager.getInstance().addDragTarget(container, dragOverListener);
	}


	/**
	 * Get the associated CTabFolder
	 */
	@Override
	protected CTabFolder getTabFolder() {
		return pTabFolder.getTabFolder();
	}

	/**
	 * Return the swt Control associated to this part.
	 */
	@Override
	public Composite getControl() {
		return getTabFolder();
	}

	/**
	 * The <code>MultiPageEditor</code> implementation of this <code>IWorkbenchPart</code> method sets focus on
	 * the active nested editor, if there is one.
	 * <p>
	 * Subclasses may extend or reimplement.
	 * </p>
	 */
	public void setFocus() {
		setFocus(getActivePage());
	}

	/**
	 * Sets focus to the control for the given page. If the page has an editor, this calls its <code>setFocus()</code> method. Otherwise, this calls <code>setFocus</code> on the control for the page.
	 *
	 * @param pageIndex
	 *            the index of the page
	 */
	private void setFocus(int pageIndex) {
		if (pageIndex < 0 || pageIndex >= getPageCount()) {
			// page index out of bounds, don't set focus.
			return;
		}
		getPagePart(pageIndex).setFocus();
	}

	/**
	 * Return the part containing specified point. Normally return this part, because the caller has
	 * already determine that this contain the part.
	 *
	 */
	@Override
	public AbstractPart findPart(Point toFind) {
		return this;
	}

	/**
	 * Locates the part that intersects the given point and that have the expected type
	 *
	 * @param toFind
	 * @return
	 */
	@Override
	public AbstractPart findPartAt(Point toFind, Class<?> expectedTileType) {

		if (expectedTileType == this.getClass()) {
			return this;
		}

		// ask current active tab
		TabItemPart activeTabPart = getActiveTab();
		if (activeTabPart == null) {
			return null;
		}

		return getActiveTab().findPartAt(toFind, expectedTileType);
	}

	/**
	 * Get the currently active tab.
	 *
	 * @return
	 */
	private TabItemPart getActiveTab() {
		int index = getActivePage();
		if (index != -1) {
			return currentTabItems.get(index);
		}
		return null;
	}

	/**
	 * Get the specified childPart
	 *
	 * @param index
	 *            Index of the requested childPart.
	 * @return
	 */
	protected PagePart getPagePart(int index) {
		if (index < 0) {
			return null;
		}
		return currentTabItems.get(index).getChildPart();
	}


	/**
	 * Lookup the {@link TabItemPart} associated to the specified {@link PagePart}.
	 *
	 * @param page
	 *            The page for which the {@link TabItemPart} is lookuped.
	 * @return The associated {@link TabItemPart} or null if not found.
	 */
	protected TabItemPart lookupAssociatedTabItemPart(PagePart page) {
		for (TabItemPart child : currentTabItems) {
			if (child.getChildPart() == page) {
				return child;
			}
		}
		// Not found
		return null;
	}

	/**
	 * Get the visible PagePart (from the Container point of view).
	 * The visible PagePart is the one that has its diagram area visible.
	 * From the folder point of view, this is the active PagePart.
	 *
	 * @return
	 */
	public PagePart getVisiblePagePart() {
		int index = getActivePage();
		if (index != -1) {
			return getPagePart(index);
		}
		return null;
	}

	/**
	 * Find the part associated to the provided control.
	 *
	 */
	@Override
	public AbstractPanelPart findPart(Object control) {
		if (getControl() == control) {
			return this;
		}

		// Check if it is one of the Item
		if (control instanceof CTabItem && ((CTabItem) control).getParent() == getControl()) {
			return this;
		}

		// Ask childs TODO
		return null;
	}


	/**
	 *
	 * @see org.eclipse.papyrus.infra.core.sasheditor.internal.AbstractPanelPart#getDropTarget(java.lang.Object, org.eclipse.papyrus.infra.core.sasheditor.internal.TabFolderPart, org.eclipse.swt.graphics.Point)
	 *
	 * @param draggedObject
	 * @param sourcePart
	 * @param position
	 * @return
	 */
	@Override
	public IDropTarget getDropTarget(Object draggedObject, TabFolderPart sourcePart, Point position) {
		// see org.eclipse.ui.internal.presentations.util.ReplaceDragHandler
		// Determine which tab we're currently dragging over
		CTabItem tabUnderPointer = pTabFolder.getItem(position);

		// Compute source tab index. If folder, index==-1
		int sourceIndex = PTabFolder.getDraggedObjectTabIndex(draggedObject);
		// This drop target only deals with tabs... if we're not dragging over
		// a tab, exit.
		if (tabUnderPointer == null) {
			Rectangle titleArea = pTabFolder.getTabArea();

			// If we're dragging over the title area, treat this as a drop in the last
			// tab position.
			if (titleArea.contains(position) && pTabFolder.getTabFolder().getItemCount() > 0) {
				int dragOverIndex = pTabFolder.getTabFolder().getItemCount();
				CTabItem lastTab = pTabFolder.getTabFolder().getItem(dragOverIndex - 1);

				// Can't drag to end unless you can see the end
				if (!lastTab.isShowing()) {
					return null;
				}

				// If we are unable to compute the bounds for this tab, then ignore the drop
				Rectangle lastTabBounds = lastTab.getBounds();
				if (lastTabBounds.isEmpty()) {
					return null;
				}

				// if (dragStart >= 0) {
				// dragOverIndex--;
				//
				// return createDropTarget( sourcePart, lastTabBounds, dragOverIndex);
				// // return new StackDropResult(lastTabBounds, new Integer(dragOverIndex));
				// }

				// Make the drag-over rectangle look like a tab at the end of the tab region.
				// We don't actually know how wide the tab will be when it's dropped, so just
				// make it 3 times wider than it is tall.
				// titleArea is in Display coordinate, lastTabBounds in parent coordinate
				Rectangle dropRectangle = titleArea;

				dropRectangle.x = dropRectangle.x + lastTabBounds.x + lastTabBounds.width;
				dropRectangle.width = 3 * dropRectangle.height;
				return createDropTarget(sourcePart, sourceIndex, dropRectangle, dragOverIndex);
				// return new StackDropResult(dropRectangle, new Integer(dragOverIndex));

			} else {
				// If the closest side is the side with the tabs, consider this a stack operation.
				// Otherwise, let the drop fall through to whatever the default behavior is
				Rectangle displayBounds = PapyrusDragUtils.getDisplayBounds(pTabFolder.getControl());
				int closestSide = Geometry.getClosestSide(displayBounds, position);
				if (closestSide == pTabFolder.getTabFolder().getTabPosition()) {
					return createDropTarget(sourcePart, sourceIndex, displayBounds, -1);
				}

				return null;
			}
		}

		if (!tabUnderPointer.isShowing()) {
			return null;
		}

		// Get thumbnail bounds in display coordinates
		Rectangle tabBounds = pTabFolder.getItemBounds(tabUnderPointer);

		if (tabBounds.isEmpty()) {
			return null;
		}

		return createDropTarget(sourcePart, sourceIndex, tabBounds, pTabFolder.getTabFolder().indexOf(tabUnderPointer));
	}

	/**
	 * Copied from org.eclipse.ui.internal.PartStack
	 */
	public IDropTarget createDropTarget(TabFolderPart sourcePart, int sourceIndex, Rectangle snapRectangle, int tabIndex) {

		if (dropTarget == null) {
			dropTarget = new DropTarget(sourcePart, sourceIndex, snapRectangle, tabIndex);
			return dropTarget;
		}

		dropTarget.setTarget(sourcePart, sourceIndex, snapRectangle, tabIndex);
		return dropTarget;
	}

	/**
	 * Class implementing methods required by drop targets. Drop target use when the drop occur on one of the thumbnail of the folder.
	 */
	protected class DropTarget implements IDropTarget {

		private Cursor cursor = null;

		private TabFolderPart sourcePart;

		private Rectangle snapRectangle;

		private int targetIndex;

		private int sourceIndex;

		/**
		 * Constructor. targetPart is the current folder.
		 *
		 * @param sourcePart
		 *            The sourcePart of the drag
		 * @param sourceIndex
		 *            Index of the tab from where the drop occur
		 * @param snapRectangle
		 *            the drop area.
		 * @param targetIndex
		 *            Index of the tab where the drop occur
		 */
		public DropTarget(TabFolderPart sourcePart, int sourceIndex, Rectangle snapRectangle, int targetIndex) {
			this.sourceIndex = sourceIndex;
			this.targetIndex = targetIndex;
			this.sourcePart = sourcePart;
			this.snapRectangle = snapRectangle;
		}

		public void setTarget(TabFolderPart sourcePart, int sourceIndex, Rectangle snapRectangle, int targetIndex) {
			this.sourceIndex = sourceIndex;
			this.targetIndex = targetIndex;
			this.sourcePart = sourcePart;
			this.snapRectangle = snapRectangle;
		}

		/**
		 *
		 * @see org.eclipse.papyrus.infra.core.sasheditor.internal.eclipsecopy.IDropTarget#drop()
		 */
		@Override
		public void drop() {

			// move from a folder to another
			if (sourcePart == TabFolderPart.this) {
				// move inside the same folder
				getContentProvider().movePage(sourcePart.getPartModel(), sourceIndex, targetIndex);
			} else { // move between folder
				getContentProvider().movePage(sourcePart.getPartModel(), sourceIndex, TabFolderPart.this.getPartModel(), targetIndex);
			}
		}

		/**
		 * Return the cursor used during drag.
		 *
		 * @see org.eclipse.papyrus.infra.core.sasheditor.internal.eclipsecopy.IDropTarget#getCursor()
		 */
		@Override
		public Cursor getCursor() {
			if (cursor == null) {
				cursor = DragManager.getInstance().getDragCursor(SWT.CENTER);
			}
			return cursor;
		}

		@Override
		public Rectangle getSnapRectangle() {
			// System.out.println(TabFolderPart.this.getClass().getSimpleName() + ".getSnapRectangle()-" + count);
			return snapRectangle;
		}

	}

	/**
	 * Orphan this node. The parent is set to null, but control is left unchanged. The node can be reattached with reparent().
	 *
	 * @see
	 * @return the parent
	 */
	@Override
	public void orphan() {
		// orphan only if we are in UNCHANGED state
		if (garbageState == GarbageState.UNVISITED) {
			garbageState = GarbageState.ORPHANED;
			parent = null;

		}
	}

	/**
	 *
	 * @see org.eclipse.papyrus.infra.core.sasheditor.internal.AbstractPart#getGarbageState()
	 *
	 * @return
	 */
	@Override
	public GarbageState getGarbageState() {
		return garbageState;
	}

	/**
	 * Change the parent of this method.
	 *
	 * @see org.eclipse.papyrus.infra.core.sasheditor.sash.ITilePart#reparent(org.eclipse.papyrus.infra.core.sasheditor.sash.ITilePart)
	 */
	@Override
	public void reparent(IPanelParent newParent, Composite swtParent) {
		parent = newParent;
		// Create control if needed
		// This can happen if the TilePart is just created after a refresh
		// if(getControl() == null)
		// {
		// return;
		// // createContainer(parent.getControl());
		// }
		// Reparent the control
		assert (getControl() != null);
		// getControl().setParent(newParent.getControl()) ;
		getControl().setParent(swtParent);
		garbageState = GarbageState.REPARENTED;
	}

	/**
	 * Return true if the Part is for the specified real model. Return false otherwise.
	 *
	 * @param realModel
	 *            The raw model to check
	 * @return
	 */
	@Override
	public boolean isPartFor(Object realModel) {
		return getRawModel() == realModel;
	}

	/**
	 * Get the raw model associated to this part.
	 *
	 * @return
	 */
	@Override
	public Object getRawModel() {
		return rawModel;
	}

	/**
	 * Refresh the tab of this page (I.e the name and icon in the tab).
	 *
	 * @param page
	 *            The page to be refreshed
	 */
	public void refreshPageTab(PagePart page) {
		TabItemPart itemPart = currentTabItems.getByPagePart(page);
		if (itemPart == null) {
			return;
		}

		itemPart.refreshTabDecorations();
	}

	/**
	 * Synchronize the TabFolder with the models.
	 * The Tabs order is fixed and can't be moved. So, we move the associated ITilepart if needed.
	 * For each existing Tab, compare its model and the requested model. Synchronize if necessary.
	 * If there is more new model, add new Tab
	 * If there is less newModel, remove unused Tabs.
	 *
	 * @param partLists
	 */
	@Override
	public void synchronize2(PartLists partLists) {

		// get list of model to be displayed. This is a list of Object.
		List<Object> newModels = (List<Object>) partModel.getChildren();

		// Disable redraw
		CTabFolder folder = getTabFolder();
		folder.setRedraw(false);

		// Iterate over the minimum common size
		// Synchronize each tab with the requested model
		int minSize = Math.min(newModels.size(), currentTabItems.size());
		int index;
		for (index = 0; index < minSize; index++) {
			Object curModel = newModels.get(index);
			TabItemPart curTab = currentTabItems.get(index);
			if (!curTab.isTabItemFor(curModel)) {
				resetTabItem(curTab, partLists, curModel);
				// end
			} else {
				// Change curTab state
				curTab.getChildPart().unchanged();
			}
		}

		// Check for extra tabs or extra models
		if (index < newModels.size()) {
			// There is extra models, add new tabs
			for (int i = index; i < newModels.size(); i++) {
				Object curModel = newModels.get(i);
				// Create a new TabItem associated to the curModel.
				createTabItem(partLists, curModel, i);
				// end
			}
		} else if (index < currentTabItems.size()) {
			// There is too much tabs, remove them
			List<TabItemPart> toRemove = new ArrayList<>();
			// Collect tab to be removed
			for (int i = index; i < currentTabItems.size(); i++) {
				TabItemPart curTab = currentTabItems.get(i);
				toRemove.add(curTab);
			}
			// do remove
			for (TabItemPart curTab : toRemove) {
				// removeTab(curTab)
				removeTabItem(curTab);
				// end
			}
		}


		folder.setRedraw(true);
		// folder.setSelection(activePageIndex);
		folder.redraw();

		int activePageIndex = getActivePage();
		if (activePageIndex >= 0) {
			// Set the activeTab has visible.
			// Do it here because otherwise the active tab could be not visible.
			// This come from an undefined bug setting the tab.isVisible(false) in some case.
			folder.getItem(activePageIndex).getControl().setVisible(true);
		} else {
			// Check if there is item in the CTabFolder.
			// If true, we have a trouble
			if (getTabFolder().getItemCount() > 0) {
				// We have items, but none is selected.
				// Select the first one.
				setSelection(0);
			}
		}
		// folder.update();
		// folder.showSelection();

	}

	/**
	 * Remove the specified tabItem.
	 * Also call appropriate remove() method on the tabItem.
	 *
	 * @param curTab
	 */
	private void removeTabItem(TabItemPart tabItem) {
		currentTabItems.remove(tabItem);
		tabItem.remove();
	}

	/**
	 * Create a new TabItem associated to the part corresponding to the specified newModel.
	 * The TabItem is created at the specified index.
	 * The associated parts is searched in the existingParts or created if none is found.
	 *
	 * @param existingParts
	 *            List of existing parts.
	 * @param newModel
	 * @param index
	 * @param i
	 */
	private void createTabItem(PartLists existingParts, Object newModel, int index) {
		TabItemPart newTab = null;

		PagePart modelPart = existingParts.findPagePartFor(newModel);
		if (modelPart != null) {
			// A part already exist for the model. Use it.
			modelPart.reparent(this);
			newTab = new TabItemPart(this, modelPart, index);
		} else {
			// No part found, create one
			modelPart = createChildPart(newModel);
			if (modelPart != null) {
				existingParts.addCreatedPage(modelPart);
				// Attach it to the tabItem
				newTab = new TabItemPart(this, modelPart, index);
			}
		}

		// Add to the list of items.
		if (newTab != null) {
			currentTabItems.add(index, newTab);
		}
	}

	// /**
	// * Create a new TabItem and associated part corresponding to the specified newModel.
	// * The TabItem is created at the specified index.
	// * The associated parts is created.
	// *
	// * @param existingParts List of existing parts.
	// * @param newModel
	// * @param index
	// * @param i
	// */
	// private void createTabItem(Object newModel, int index) {
	// TabItemPart newTab;
	//
	// PagePart modelPart = createChildPart( newModel );
	// // Attach it to the tabItem
	// newTab = new TabItemPart(this, modelPart, index);
	//
	// // Add to the list of items.
	// currentTabItems.add(index, newTab);
	// }

	/**
	 * Instruct the specified tabItem to use the new model. Check if a part already exist for the model
	 * and use it if any. Otherwise create a new Part.
	 *
	 * @param curTab
	 * @param existingParts
	 * @param newModel
	 */
	private void resetTabItem(TabItemPart tabItem, PartLists existingParts, Object newModel) {

		PagePart modelPart = existingParts.findPagePartFor(newModel);
		if (modelPart != null) {
			// A part already exist for the model. Use it.
			tabItem.resetChild(modelPart);
		} else {
			// No part found, create one
			modelPart = createChildPart(newModel);
			existingParts.addCreatedPage(modelPart);
			// Attach it to the tabItem
			tabItem.resetChild(modelPart);
		}
	}

	/**
	 * Factory method to create a new Part for the specified newModel.
	 * The method should always return a valid Part. In case of error while creating the requested part,
	 * the method should return a default part, maybe showing the encountered error.
	 * The control for the child is created.
	 *
	 * @param newModel
	 * @return The new part
	 */
	private PagePart createChildPart(Object newModel) {

		// Create the child PartModel. Delegate creation to this part PartModel.
		final IPageModel partModel = getPartModel().createChildSashModel(newModel);

		if (partModel != null) {
			// Delegate part creation to the container. This allow the container to provide appropriate
			// objects not available from the part.
			PagePart newPart = getSashWindowContainer().createPagePart(this, partModel, newModel);
			// Create control.
			// Fire events before and after
			getSashWindowContainer().getLifeCycleEventProvider().firePageAboutToBeOpenedEvent(newPart);
			newPart.createPartControl(getControl());
			getSashWindowContainer().getLifeCycleEventProvider().firePageOpenedEvent(newPart);

			if (newPart.getControl() != null) {
				newPart.getControl().addDisposeListener(new DisposeListener() {

					@Override
					public void widgetDisposed(DisposeEvent e) {
						// Dispose the model that generated the part
						partModel.dispose();
					}
				});
			} else {
				// No part control? Dispose the model, now
				partModel.dispose();
			}

			ICloseablePart closeable = PlatformHelper.getAdapter(newPart, ICloseablePart.class);
			if (closeable != null) {
				attachListeners(closeable, newPart);
			}

			return newPart;
		}

		// Use exception?
		return createErrorPage();
	}

	private void attachListeners(ICloseablePart closeable, PagePart part) {
		closeable.addPropertyListener(new IPropertyListener() {

			@Override
			public void propertyChanged(Object source, int propId) {
				switch (propId) {
				case ICloseablePart.PROP_CAN_CLOSE:
					// Update the presentation of the close widget, if necessary
					refreshPageTab(part);
					break;
				}
			}
		});

	}

	/**
	 * Creates an ErrorComponentPart which displays an error message to the user.
	 * Avoid returning null, which might later lead to NPEs
	 *
	 * @return
	 */
	private PagePart createErrorPage() {
		// Handle invalid tab case. Improve robustness.
		Activator.log.warn("Error: the SashWindowContainer returned an invalid tab");
		return new ErrorComponentPart(this);
	}

	/**
	 * Show tab status
	 *
	 * @debug This is fo debug purpose.
	 * @param msg
	 */
	private void showTabs(String msg) {
		System.out.println("------- " + msg);
		// Show items
		CTabFolder folder = getTabFolder();
		CTabItem items[] = folder.getItems();
		System.out.printf("sel.index %2d :\n", folder.getSelectionIndex());
		System.out.printf("items %2d :", folder.getItemCount());
		for (CTabItem item : items) {
			System.out.printf("%10s |", item.getControl());
		}
		System.out.println();

		System.out.printf("it.dispose:");
		for (CTabItem item : items) {
			System.out.printf("%10b |", item.getControl().isDisposed());
		}
		System.out.println();

		System.out.printf("it.ctrl.vis:");
		for (CTabItem item : items) {
			System.out.printf("%10s |", item.getControl().isVisible());
		}
		System.out.println();

		//
		System.out.printf("it.ctrl   :");
		for (CTabItem item : items) {
			System.out.printf("%10s |", item.getControl());
		}
		System.out.println();

		//
		// System.out.printf("tabs.ctrl :" );
		// for( TabItemPart tab : currentModels)
		// {
		// System.out.printf( "%10s |", tab.childPart.getControl());
		// }
		// System.out.println();

		//
		// System.out.printf("tab.editor:" );
		// for( TabItemPart tab : currentModels)
		// {
		// System.out.printf( "%10s |", tab.childPart.getIEditorPart());
		// }
		// System.out.println();

		//
		System.out.printf("tabs %2d :", currentTabItems.size());
		for (TabItemPart tab : currentTabItems) {
			System.out.printf("%10s |", tab);
		}
		System.out.println();

	}

	/**
	 * Show tile status.
	 */
	protected void showStatus() {
		// System.out.println( "tabfolder[" + currentModels.size() + "]:"
		// + ", disposed=" + getCTabFolder().isDisposed()
		// + ", visible=" + getCTabFolder().isVisible()
		// + ", garbState=" + garbageState
		// + ", " + this);

		CTabFolder ctrl = getTabFolder();
		System.out.printf("tabfolder[%2d]: disposed=%-5b, visible=%-5b, garbState=%-10s, %s\n", currentTabItems.size(), ctrl.isDisposed(), (ctrl.isDisposed() ? false : getTabFolder().isVisible()), garbageState, this);
	}

	/**
	 * Accept the provided visitor.
	 * Call the corresponding accept method in the visitor.
	 *
	 * @param visitor
	 * @return
	 */
	@Override
	public boolean visit(IPartVisitor visitor) {
		return visitor.accept(this);
	}

	/**
	 * Visit the children of this Tile.
	 *
	 * @param visitor
	 */
	public boolean visitChildren(IPartVisitor visitor) {

		for (TabItemPart child : currentTabItems) {
			if (!child.visit(visitor)) {
				return false;
			}
		}
		// All children have accepter the visit, continue visiting.
		return true;
	}


	/**
	 * Collection of tabpart.
	 * Add miscelenaous methods.
	 *
	 * @author dumoulin
	 *
	 */
	@SuppressWarnings("serial")
	public class TabPartList extends ArrayList<TabItemPart> {

		/**
		 * Does the list contains a part with the specified model.
		 *
		 * @param model
		 * @return
		 */
		public boolean containsModel(Object model) {
			return indexOfModel(model) >= 0;
		}

		/**
		 * Returns the index of the first occurrence of the specified element
		 * in this list, or -1 if this list does not contain the element.
		 * More formally, returns the lowest index <tt>i</tt> such that <tt>(o==null&nbsp;?&nbsp;get(i)==null&nbsp;:&nbsp;o.equals(get(i)))</tt>,
		 * or -1 if there is no such index.
		 */
		public int indexOfModel(Object o) {
			if (o == null) {
				for (int i = 0; i < size(); i++) {
					if (get(i) == null) {
						return i;
					}
				}
			} else {
				for (int i = 0; i < size(); i++) {
					if (o.equals(get(i).getChildPart().getRawModel())) {
						return i;
					}
				}
			}
			return -1;
		}


		/**
		 * Get the TabPart by its model.
		 *
		 * @param model
		 * @return
		 */
		public TabItemPart getByModel(Object model) {
			return get(indexOfModel(model));
		}

		/**
		 * Get the TabPart by its PagePart.
		 *
		 * @param page
		 * @return
		 */
		public TabItemPart getByPagePart(PagePart page) {
			return get(indexOfModel(page.getRawModel()));
		}

	}

	/**
	 * Track the mouse for flying over the tabs and show tooltip.
	 * Show the tooltip when the mouse stop over a tab.
	 * Disable the tooltip if mouse is clicked.
	 * Reenable the tooltip when exiting the tab.
	 *
	 * @author dumoulin
	 *
	 */
	public class MouseHoverTracker {

		/**
		 * Control for which a mouse tracker is requested.
		 */
		private Control control;

		/** Tooltip manager showing tooltip */
		private ImageToolTipManager toolTipManager;

		/** Anonymous mouse tracker */
		MouseTrackListener mouseTrackListener = new MouseTrackListener() {

			private int count = 0;

			@Override
			public void mouseEnter(MouseEvent e) {
				// System.out.println("MouseEnter()" + count++);

			}

			@Override
			public void mouseExit(MouseEvent e) {
				// System.out.println("MouseExit()" + count++);
				toolTipManager.closeToolTip();
			}

			@Override
			public void mouseHover(MouseEvent e) {

				// System.out.println("MouseHover(" + e.x +", "+ e.y +")");
				CTabFolder folder = getTabFolder();
				// Point pt = folder.toDisplay(e.x, e.y);
				Point pt = new Point(e.x, e.y);
				CTabItem item = folder.getItem(pt);
				int index = pTabFolder.getItemIndex(pt);
				if (index == -1) {
					toolTipManager.closeToolTip();
					return;
				}

				PagePart part = currentTabItems.get(index).getChildPart();
				// System.out.println("MouseHover(" + e.widget
				// + ", part=" + part.getPageTitle()
				// + ", item=" + item
				// + ") - " + count++);
				// TODO move it away
				// toolTipManager.showToolTip(item.getBounds(), part.getControl(), pt);
				toolTipManager.showToolTip(part, item.getBounds(), pt);
			}


		};

		/**
		 * Listener on mouse clicked.
		 * Used to disable the current tooltip.
		 */
		private Listener mouseClickedListener = new Listener() {

			private int count = 0;

			@Override
			public void handleEvent(Event event) {
				switch (event.type) {
				case SWT.MouseUp:
					// System.out.println("MouseUp()" + count++);
					toolTipManager.disableToolTip();
					break;
				}
			}
		};

		/**
		 * Build a tracker for the specified control.
		 * Constructor.
		 *
		 * @param control
		 */
		public MouseHoverTracker(Control control, ImageToolTipManager toolTipManager) {
			this.control = control;
			this.toolTipManager = toolTipManager;
			activate();
		}

		public void activate() {
			control.addMouseTrackListener(mouseTrackListener);
			control.addListener(SWT.MouseUp, mouseClickedListener);
		}

		public void deactivate() {
			control.removeMouseTrackListener(mouseTrackListener);
			control.removeListener(SWT.MouseUp, mouseClickedListener);
			toolTipManager.dispose();
		}


	}

}

Back to the top