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
|
/*******************************************************************************
* Copyright (c) 2015 Obeo.
* 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:
* Obeo - initial API and implementation
*******************************************************************************/
package org.eclipse.eef.properties.ui.legacy.internal.extension.impl;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.Multimap;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.LinkedList;
import java.util.List;
import org.eclipse.eef.properties.ui.api.IEEFTabDescriptor;
import org.eclipse.eef.properties.ui.legacy.internal.EEFPropertiesUiLegacyPlugin;
import org.eclipse.eef.properties.ui.legacy.internal.extension.IItemDescriptor;
import org.eclipse.eef.properties.ui.legacy.internal.extension.IItemRegistry;
/**
* The registry used to track the descriptors of the property tab extension.
*
* @author mbats
*/
public class LegacyPropertyTabRegistry implements IItemRegistry {
/**
* The after tab top value.
*/
private static final String TOP = "top"; //$NON-NLS-1$
/**
* The map of the identifier of the description to the {@link LegacyPropertyTabItemDescriptor}.
*/
private Multimap<String, IItemDescriptor> id2descriptors = ArrayListMultimap.create();
/**
* Get the property tabs.
*
* @param contributorId
* The contributor Id
*
* @return List of tabs
*/
public List<IEEFTabDescriptor> getPropertyTabs(String contributorId) {
// Get tabs
List<IEEFTabDescriptor> tabs = readTabDescriptors(contributorId);
// Get categories
final List<String> propertyCategories = readPropertyCategories();
// Sort the tabs according to their categories
List<IEEFTabDescriptor> sortedTabs = sortTabDescriptorsByCategory(tabs, propertyCategories);
// Sort the tabs according to the after tab attribute
sortedTabs = sortTabDescriptorsByAfterTab(sortedTabs, propertyCategories);
return sortedTabs;
}
/**
* Sorts the tab descriptors in the given list according to category.
*
* @param tabs
* Tabs to sort
* @param propertyCategories
* Property categories
* @return Sorted list of tabs according to there categories
*/
private List<IEEFTabDescriptor> sortTabDescriptorsByCategory(List<IEEFTabDescriptor> tabs, final List<String> propertyCategories) {
List<IEEFTabDescriptor> sortedTabs = new ArrayList<IEEFTabDescriptor>(tabs);
if (propertyCategories != null) {
Collections.sort(sortedTabs, new Comparator<Object>() {
@Override
public int compare(Object arg0, Object arg1) {
IEEFTabDescriptor one = (IEEFTabDescriptor) arg0;
IEEFTabDescriptor two = (IEEFTabDescriptor) arg1;
String categoryOne = one.getCategory();
String categoryTwo = two.getCategory();
if (categoryOne != null && categoryTwo != null) {
int categoryOnePosition = getIndex(propertyCategories.toArray(), categoryOne);
int categoryTwoPosition = getIndex(propertyCategories.toArray(), categoryTwo);
return categoryOnePosition - categoryTwoPosition;
}
return 0;
}
});
}
return sortedTabs;
}
/**
* Sorts the tab descriptors in the given list according to afterTab.
*
* @param tabs
* Tabs to sort
* @param propertyCategories
* Property categories
* @return Sorted list of tabs according to the afterTab attribute
*/
@SuppressWarnings("cast")
private List<IEEFTabDescriptor> sortTabDescriptorsByAfterTab(List<IEEFTabDescriptor> tabs, List<String> propertyCategories) {
if (tabs.size() == 0 || propertyCategories == null) {
return tabs;
}
List<IEEFTabDescriptor> sorted = new ArrayList<IEEFTabDescriptor>();
int categoryIndex = 0;
for (int i = 0; i < propertyCategories.size(); i++) {
// Get all the tabs of a category
final List<IEEFTabDescriptor> categoryList = new ArrayList<IEEFTabDescriptor>();
String category = propertyCategories.get(i);
int topOfCategory = categoryIndex;
int endOfCategory = categoryIndex;
while (endOfCategory < tabs.size() && tabs.get(endOfCategory).getCategory().equals(category)) {
endOfCategory++;
}
for (int j = topOfCategory; j < endOfCategory; j++) {
IEEFTabDescriptor tab = tabs.get(j);
if (tab.getAfterTab().equals(TOP)) {
categoryList.add(0, tabs.get(j));
} else {
categoryList.add(tabs.get(j));
}
}
List<IEEFTabDescriptor> sortedTabs = sortCategoryTabsByAfterTab(categoryList);
for (int j = 0; j < sortedTabs.size(); j++) {
sorted.add(sortedTabs.get(j));
}
categoryIndex = endOfCategory;
}
return sorted;
}
/**
* Sort tabs of a category by after tab.
*
* @param categoryList
* List of tabs
* @return List of tabs sorted by after tab
*/
private List<IEEFTabDescriptor> sortCategoryTabsByAfterTab(List<IEEFTabDescriptor> categoryList) {
List<IEEFTabDescriptor> sorted = new LinkedList<IEEFTabDescriptor>();
for (IEEFTabDescriptor tab : categoryList) {
String afterTabId = tab.getAfterTab();
int indexOfAfterTab = -1;
if (afterTabId != null && !afterTabId.isEmpty()) {
IEEFTabDescriptor afterTab = getTab(categoryList, afterTabId);
if (afterTab != null) {
indexOfAfterTab = sorted.indexOf(afterTab);
}
}
sorted.add(indexOfAfterTab + 1, tab);
}
return sorted;
}
/**
* Get a tab in a list of tabs according to its id.
*
* @param tabId
* The tab id
* @param tabs
* The tabs list
* @return the Tab
*/
private IEEFTabDescriptor getTab(List<IEEFTabDescriptor> tabs, String tabId) {
for (IEEFTabDescriptor tab : tabs) {
if (tabId.equals(tab.getId())) {
return tab;
}
}
return null;
}
/**
* Returns the index of the given element in the array.
*
* @param array
* Array
* @param target
* The element to search
* @return The index of the searched element in the array if it exists otherwise -1
*/
private int getIndex(Object[] array, Object target) {
for (int i = 0; i < array.length; i++) {
if (target != null && array[i] != null && array[i].equals(target)) {
return i;
}
}
return -1; // should never happen
}
/**
* Read property categories from the extension point.
*
* @return List of categories
*/
private List<String> readPropertyCategories() {
return EEFPropertiesUiLegacyPlugin.getImplementation().getTabbedPropertyContributorRegistry().getPropertyCategories();
}
/**
* Reads property tab extensions. Returns all tab descriptors for the current contributor id or an empty list if
* none is found.
*
* @param contributorId
* The contributor id
*
* @return List of static tab descriptors
*/
private List<IEEFTabDescriptor> readTabDescriptors(String contributorId) {
List<IEEFTabDescriptor> eefTabDescriptors = new ArrayList<IEEFTabDescriptor>();
Collection<IItemDescriptor> values = this.id2descriptors.values();
for (IItemDescriptor itemDescriptor : values) {
if (itemDescriptor instanceof LegacyPropertyTabItemDescriptor) {
LegacyPropertyTabItemDescriptor eefTabDescriptor = (LegacyPropertyTabItemDescriptor) itemDescriptor;
String eefTabContributorId = eefTabDescriptor.getContributorId();
if (eefTabContributorId != null && eefTabContributorId.equals(contributorId)) {
eefTabDescriptors.add(eefTabDescriptor);
}
}
}
return eefTabDescriptors;
}
/**
* {@inheritDoc}
*
* @see IItemRegistry#add(IItemDescriptor)
*/
@Override
public IItemDescriptor add(IItemDescriptor descriptor) {
boolean result = this.id2descriptors.put(descriptor.getId(), descriptor);
if (result) {
return descriptor;
}
return null;
}
/**
* {@inheritDoc}
*
* @see IItemRegistry#add(IItemDescriptor)
*/
@Override
public boolean remove(String id) {
return !this.id2descriptors.removeAll(id).isEmpty();
}
/**
* {@inheritDoc}
*
* @see IItemRegistry#clear()
*/
@Override
public void clear() {
this.id2descriptors.clear();
}
/**
* Disposes this registry.
*/
public void dispose() {
for (IItemDescriptor desc : id2descriptors.values()) {
if (desc instanceof LegacyPropertyTabItemDescriptor) {
((LegacyPropertyTabItemDescriptor) desc).dispose();
}
}
}
}
|
