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
|
/*******************************************************************************
* Copyright (c) 2005, 2019 IBM Corporation and others.
*
* 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.internal.cheatsheets.composite.explorer;
import java.io.IOException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.core.runtime.FileLocator;
import org.eclipse.core.runtime.Path;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.ui.internal.cheatsheets.CheatSheetPlugin;
import org.eclipse.ui.internal.cheatsheets.composite.model.TaskStateUtilities;
import org.eclipse.ui.internal.cheatsheets.composite.parser.ICompositeCheatsheetTags;
import org.eclipse.ui.internal.cheatsheets.composite.views.TaskEditorManager;
import org.eclipse.ui.internal.provisional.cheatsheets.ICompositeCheatSheetTask;
import org.eclipse.ui.internal.provisional.cheatsheets.ITaskGroup;
import org.osgi.framework.Bundle;
public class TreeLabelProvider extends LabelProvider {
private static int BLOCKED = -1;
private Image defaultImage = null; // Image for tasks with null kind
/*
* A set of related images
*/
private class ImageSet {
// Use a map rather than array so the nuber of icons is not hard coded
Map<String, Image> images = new HashMap<>();
public void put(int index, Image image) {
images.put(Integer.toString(index), image);
}
public Image getImage(int index) {
return images.get(Integer.toString(index));
}
void dispose() {
for (Image nextImage : images.values()) {
nextImage.dispose();
}
}
}
private Map<String, ImageSet> imageMap = null; // each entry is an ImageSet
public TreeLabelProvider() {
imageMap = new HashMap<>();
}
@Override
public String getText(Object obj) {
String result;
if (obj instanceof ICompositeCheatSheetTask) {
result = ((ICompositeCheatSheetTask) obj).getName();
} else {
result = obj.toString();
}
if (result == null) {
result = ""; //$NON-NLS-1$
}
return result;
}
@Override
public Image getImage(Object obj) {
if (obj instanceof ICompositeCheatSheetTask) {
ICompositeCheatSheetTask task = (ICompositeCheatSheetTask) obj;
return lookupImage(task.getKind(), task.getState(), TaskStateUtilities.isBlocked(task));
}
return super.getImage(obj);
}
public Image lookupImage(String kind, int state, boolean isBlocked) {
ImageSet images = imageMap.get(kind);
if (images == null) {
images = createImages(kind);
imageMap.put(kind, images);
}
if (isBlocked) {
return images.getImage(BLOCKED);
}
return images.getImage(state);
}
/**
* Create a set of images for a task which may be [redefined.
* @param kind
* @return
*/
private ImageSet createImages(String kind) {
ImageSet images = new ImageSet();
ImageDescriptor desc = getPredefinedImageDescriptor(kind, true);
if (desc == null) {
desc = TaskEditorManager.getInstance().getImageDescriptor(kind);
}
if (desc != null) {
Image baseImage = desc.createImage();
images.put(ICompositeCheatSheetTask.NOT_STARTED, baseImage);
createImageWithOverlay(ICompositeCheatSheetTask.IN_PROGRESS,
"$nl$/icons/ovr16/task_in_progress.png", //$NON-NLS-1$
images,
desc);
createImageWithOverlay(ICompositeCheatSheetTask.SKIPPED,
"$nl$/icons/ovr16/task_skipped.png", //$NON-NLS-1$
images,
desc);
createDisabledImage(kind, BLOCKED,
images,
baseImage);
createImageWithOverlay(ICompositeCheatSheetTask.COMPLETED,
"$nl$/icons/ovr16/task_complete.png", //$NON-NLS-1$
images,
desc);
}
return images;
}
private ImageDescriptor getPredefinedImageDescriptor(String kind, boolean isEnabled) {
String filename;
if (ICompositeCheatsheetTags.CHEATSHEET_TASK_KIND.equals(kind)) {
filename = "cheatsheet_task.png"; //$NON-NLS-1$
} else if (ITaskGroup.SET.equals(kind)) {
filename = "task_set.png"; //$NON-NLS-1$
} else if (ITaskGroup.CHOICE.equals(kind)) {
filename = "task_choice.png"; //$NON-NLS-1$
} else if (ITaskGroup.SEQUENCE.equals(kind)) {
filename = "task_sequence.png"; //$NON-NLS-1$
} else {
return null;
}
String iconPath = "$nl$/icons/"; //$NON-NLS-1$
if (isEnabled) {
iconPath += CheatSheetPlugin.T_OBJ;
} else {
iconPath += CheatSheetPlugin.T_DLCL;
}
iconPath += filename;
return createImageDescriptor(iconPath);
}
private void createImageWithOverlay(int state, String imagePath, ImageSet images, ImageDescriptor baseDescriptor) {
ImageDescriptor descriptor = createImageDescriptor(imagePath);
OverlayIcon icon = new OverlayIcon(baseDescriptor, new ImageDescriptor[][] {
{}, { descriptor } });
images.put(state, icon.createImage());
}
private void createDisabledImage(String kind, int state, ImageSet images, Image baseImage) {
// The four images for task_set, task_sequence, task_choice and cheatsheet_task can be found
// in icons/dlcl16.
// TODO extend the extension point to allow disabled images to be specified.
//if
ImageDescriptor desc = getPredefinedImageDescriptor(kind, false);
Image disabledImage;
if (desc != null) {
disabledImage = desc.createImage();
} else {
disabledImage = createGrayedImage(baseImage);
}
images.put(state, disabledImage);
}
private Image createGrayedImage(Image image) {
return new Image(image.getDevice(), image, SWT.IMAGE_DISABLE);
}
private ImageDescriptor createImageDescriptor(String relativePath) {
Bundle bundle = CheatSheetPlugin.getPlugin().getBundle();
URL url = FileLocator.find(bundle, new Path(relativePath),null);
if (url == null) return null;
try {
url = FileLocator.resolve(url);
return ImageDescriptor.createFromURL(url);
} catch (IOException e) {
return null;
}
}
@Override
public void dispose() {
if (imageMap != null) {
for (ImageSet nextImages : imageMap.values()) {
nextImages.dispose();
}
imageMap = null;
}
if (defaultImage != null) {
defaultImage.dispose();
defaultImage = null;
}
}
}
|
