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
|
/*******************************************************************************
* Copyright (c) 2011 Wind River Systems, Inc. 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:
* Wind River Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.tcf.te.ui.jface.images;
import org.eclipse.core.runtime.Assert;
import org.eclipse.jface.resource.CompositeImageDescriptor;
import org.eclipse.jface.resource.ImageRegistry;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.ImageData;
import org.eclipse.swt.graphics.Point;
/**
* Extended composite image descriptor.
* <p>
* The image descriptor implementation adds method for easily drawing overlay
* images on different positions on top of a base image.
*/
public abstract class AbstractImageDescriptor extends CompositeImageDescriptor {
// The parent image registry providing the images for drawing
private final ImageRegistry parentImageRegistry;
// The image descriptor key
private String descriptorKey = null;
/**
* Constructor.
*
* @param parent The parent image registry. Must not be <code>null</code>.
*/
public AbstractImageDescriptor(ImageRegistry parent) {
super();
Assert.isNotNull(parent);
parentImageRegistry = parent;
}
/**
* Returns the parent image registry.
*
* @return The parent image registry instance.
*/
protected final ImageRegistry getParentImageRegistry() {
return parentImageRegistry;
}
/**
* Set the image descriptor key.
*
* @param key The image descriptor key. Must not be <code>null</code>.
*/
protected final void setDecriptorKey(String key) {
Assert.isNotNull(key);
descriptorKey = key;
}
/**
* Returns the image descriptor key.
*
* @return The image descriptor key, or <code>null</code> if not set.
*/
public final String getDecriptorKey() {
return descriptorKey;
}
/**
* Draw the image, found under the specified key, centered within the
* rectangle given by width x height.
*
* @param key The image key. Must not be <code>null</code>.
* @param width The width of the rectangle to center the image in.
* @param height The height of the rectangle to center the image in.
*/
protected void drawCentered(String key, int width, int height) {
Assert.isNotNull(key);
drawCentered(parentImageRegistry.get(key), width, height);
}
/**
* Draw the given image centered within the rectangle
* defined by the specified width x height.
*
* @param image The image. Must not be <code>null</code>.
* @param width The width of the rectangle to center the image in.
* @param height The height of the rectangle to center the image in.
*/
protected void drawCentered(Image image, int width, int height) {
if (image != null) {
ImageData imageData = image.getImageData();
if (imageData != null) {
int x = StrictMath.max(0, (width - imageData.width + 1) / 2);
int y = StrictMath.max(0, (height - imageData.height + 1) / 2);
drawImage(imageData, x, y);
}
}
}
/**
* Draw the overlay image, found under the specified key in the parent
* image registry, centered right on top of the base image.
*
* @param key The overlay image key. Must not be <code>null</code>.
* @param width The width of the base image.
* @param height The height of the base image.
*/
protected void drawCenterRight(String key, int width, int height) {
Image image = parentImageRegistry.get(key);
if (image != null) {
ImageData imageData = image.getImageData();
if (imageData != null) {
int x = StrictMath.max(0, width - imageData.width);
int y = StrictMath.max(0, (height - imageData.height + 1) / 2);
drawImage(imageData, x, y);
}
}
}
/**
* Draw the overlay image, found under the specified key in the parent
* image registry, top left on top of the base image.
*
* @param key The overlay image key. Must not be <code>null</code>.
*/
protected void drawTopLeft(String key) {
Image image = parentImageRegistry.get(key);
if (image != null) {
ImageData imageData = image.getImageData();
if (imageData != null) {
drawImage(imageData, 0, 0);
}
}
}
/**
* Draw the overlay image, found under the specified key in the parent
* image registry, top right on top of the base image.
*
* @param key The overlay image key. Must not be <code>null</code>.
*/
protected void drawTopRight(String key) {
if (getSize() != null) {
Point size = getSize();
drawTopRight(key, size.x, size.y);
} else {
// the default eclipse style guide recommendation is 16x16
drawTopRight(key, 16, 16);
}
}
/**
* Draw the overlay image, found under the specified key in the parent
* image registry, top right on top of the base image.
*
* @param key The overlay image key. Must not be <code>null</code>.
* @param width The width of the base image.
* @param height The height of the base image.
*/
protected void drawTopRight(String key, int width, int height) {
Image image = parentImageRegistry.get(key);
if (image != null) {
ImageData imageData = image.getImageData();
if (imageData != null) {
int x = StrictMath.max(0, width - imageData.width);
drawImage(imageData, x, 0);
}
}
}
/**
* Draw the overlay image, found under the specified key in the parent
* image registry, bottom center on top of the base image.
*
* @param key The overlay image key. Must not be <code>null</code>.
* @param width The width of the base image.
* @param height The height of the base image.
*/
protected void drawBottomCenter(String key, int width, int height) {
Image image = parentImageRegistry.get(key);
if (image != null) {
ImageData imageData = image.getImageData();
if (imageData != null) {
int x = StrictMath.max(0, (width - imageData.width + 1) / 2);
int y = StrictMath.max(0, height - imageData.height);
drawImage(imageData, x, y);
}
}
}
/**
* Draw the overlay image, found under the specified key in the parent
* image registry, bottom left on top of the base image.
*
* @param key The overlay image key. Must not be <code>null</code>.
* @param width The width of the base image.
* @param height The height of the base image.
*/
protected void drawBottomLeft(String key, int width, int height) {
Image image = parentImageRegistry.get(key);
if (image != null) {
ImageData imageData = image.getImageData();
if (imageData != null) {
int y = StrictMath.max(0, height - imageData.height);
drawImage(imageData, 0, y);
}
}
}
/**
* Draw the overlay image, found under the specified key in the parent
* image registry, center left on top of the base image.
*
* @param key The overlay image key. Must not be <code>null</code>.
* @param width The width of the base image.
* @param height The height of the base image.
*/
protected void drawCenterLeft(String key, int width, int height) {
Image image = parentImageRegistry.get(key);
if (image != null) {
ImageData imageData = image.getImageData();
if (imageData != null) {
int y = StrictMath.max(0, (height - imageData.height) / 2);
drawImage(imageData, 0, y);
}
}
}
/**
* Draw the overlay image, found under the specified key in the parent
* image registry, bottom right on top of the base image.
*
* @param key The overlay image key. Must not be <code>null</code>.
*/
protected void drawBottomRight(String key) {
if (getSize() != null) {
Point size = getSize();
drawBottomRight(key, size.x, size.y);
} else {
// the default eclipse style guide recommendation is 16x16
drawBottomRight(key, 16, 16);
}
}
/**
* Draw the overlay image, found under the specified key in the parent
* image registry, bottom right on top of the base image.
*
* @param key The overlay image key. Must not be <code>null</code>.
* @param width The width of the base image.
* @param height The height of the base image.
*/
protected void drawBottomRight(String key, int width, int height) {
Image image = parentImageRegistry.get(key);
if (image != null) {
ImageData imageData = image.getImageData();
if (imageData != null) {
int x = StrictMath.max(0, width - imageData.width);
int y = StrictMath.max(0, height - imageData.height);
drawImage(imageData, x, y);
}
}
}
/**
* Returns the base image used for the combined image description. This
* method is called from <code>getTransparentPixel()</code> to query the
* transparent color of the palette.
*
* @return The base image or <code>null</code> if none.
*/
protected abstract Image getBaseImage();
/* (non-Javadoc)
* @see org.eclipse.jface.resource.CompositeImageDescriptor#getTransparentPixel()
*/
@Override
protected int getTransparentPixel() {
Image baseImage = getBaseImage();
if (baseImage != null && baseImage.getImageData() != null) {
return baseImage.getImageData().transparentPixel;
}
return super.getTransparentPixel();
}
}
|
