-
Notifications
You must be signed in to change notification settings - Fork 96
/
StarRating.java
410 lines (372 loc) · 11.5 KB
/
StarRating.java
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
/*******************************************************************************
* Copyright (c) 2012 Laurent CARON.
*
* 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:
* Laurent CARON (laurent.caron@gmail.com) - initial API and implementation
*******************************************************************************/
package org.eclipse.nebula.widgets.opal.starrating;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.nebula.widgets.opal.commons.SelectionListenerUtil;
import org.eclipse.swt.SWT;
import org.eclipse.swt.SWTException;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Canvas;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
/**
* Instances of this class provide a rating element.
* <p>
* <dl>
* <dt><b>Styles:</b></dt>
* <dd>HORIZONTAL</dd>
* <dd>VERTICAL</dd> *
* <dt><b>Events:</b></dt>
* <dd>Selection</dd>
* </dl>
* </p>
*/
public class StarRating extends Canvas {
private static final int SIZE_SMALL = 16;
private static final int SIZE_BIG = 32;
public enum SIZE {
SMALL, BIG
};
private SIZE sizeOfStars;
private int maxNumberOfStars;
private int currentNumberOfStars;
private static final int DEFAULT_MAX_NUMBERS_OF_STARS = 5;
private final List<Star> stars;
private int orientation;
/**
* Constructs a new instance of this class given its parent and a style
* value describing its behavior and appearance.
* <p>
* The style value is either one of the style constants defined in class
* <code>SWT</code> which is applicable to instances of this class, or must
* be built by <em>bitwise OR</em>'ing together (that is, using the
* <code>int</code> "|" operator) two or more of those <code>SWT</code>
* style constants. The class description lists the style constants that are
* applicable to the class. Style bits are also inherited from superclasses.
* </p>
*
* @param parent a composite control which will be the parent of the new
* instance (cannot be null)
* @param style the style of control to construct
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the parent</li>
* </ul>
*
*/
public StarRating(final Composite parent, final int style) {
super(parent, checkStyle(style) | SWT.DOUBLE_BUFFERED);
sizeOfStars = SIZE.SMALL;
currentNumberOfStars = 0;
if ((style & SWT.VERTICAL) != 0) {
orientation = SWT.VERTICAL;
} else {
orientation = SWT.HORIZONTAL;
}
stars = new ArrayList<Star>();
setMaxNumberOfStars(DEFAULT_MAX_NUMBERS_OF_STARS);
initListeners();
}
private static int checkStyle(int style) {
if ((style & SWT.VERTICAL) != 0) {
style = style & ~SWT.VERTICAL;
}
if ((style & SWT.HORIZONTAL) != 0) {
style = style & ~SWT.HORIZONTAL;
}
return style;
}
private void initListeners() {
final Listener listener = new Listener() {
@Override
public void handleEvent(final Event event) {
switch (event.type) {
case SWT.MouseEnter:
case SWT.MouseMove:
onMouseEnterOrMove(event);
break;
case SWT.MouseExit:
onMouseExit(event);
break;
case SWT.MouseUp:
onMouseUp(event);
break;
case SWT.Paint:
onMousePaint(event);
break;
case SWT.Dispose:
onDispose(event);
break;
}
}
};
final int[] events = new int[] { SWT.MouseEnter, SWT.MouseMove, SWT.MouseExit, SWT.MouseUp, SWT.Paint, SWT.Dispose };
for (final int event : events) {
addListener(event, listener);
}
}
private void onMouseEnterOrMove(final Event event) {
for (final Star star : stars) {
star.hover = false;
}
for (final Star star : stars) {
final boolean mouseHover = star.bounds.contains(event.x, event.y);
star.hover = true;
if (mouseHover) {
break;
}
}
redraw();
update();
}
private void onMouseExit(final Event event) {
for (final Star star : stars) {
star.hover = false;
}
redraw();
update();
}
private void onMouseUp(final Event event) {
for (int i = 0; i < maxNumberOfStars; i++) {
final Star star = stars.get(i);
final boolean selected = star.bounds.contains(event.x, event.y);
if (selected) {
setCurrentNumberOfStars(i + 1);
SelectionListenerUtil.fireSelectionListeners(this,null);
redraw();
update();
break;
}
}
}
private void onMousePaint(final Event event) {
final GC gc = event.gc;
int x = 0, y = 0;
for (final Star star : stars) {
star.draw(gc, x, y);
if (orientation == SWT.VERTICAL) {
y += sizeOfStars.equals(SIZE.BIG) ? SIZE_BIG : SIZE_SMALL;
} else {
x += sizeOfStars.equals(SIZE.BIG) ? SIZE_BIG : SIZE_SMALL;
}
}
}
private void onDispose(final Event event) {
for (final Star star : stars) {
star.dispose();
}
}
/**
* Adds the listener to the collection of listeners who will be notified when the control
* is selected by the user, by sending it one of the messages defined in the
* <code>SelectionListener</code> interface.
* <p>
* <code>widgetDefaultSelected</code> is not called.
* </p>
*
* @param listener the listener which should be notified when the control is selected by the user,
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @see SelectionListener
* @see #removeSelectionListener
* @see SelectionEvent
*/
public void addSelectionListener(final SelectionListener listener) {
checkWidget();
SelectionListenerUtil.addSelectionListener(this, listener);
}
/**
* @see org.eclipse.swt.widgets.Composite#computeSize(int, int, boolean)
*/
@Override
public Point computeSize(final int wHint, final int hHint, final boolean changed) {
if (orientation == SWT.VERTICAL) {
return computeSizeVertical();
}
return computeSizeHorizontal();
}
private Point computeSizeVertical() {
final int width = sizeOfStars.equals(SIZE.BIG) ? SIZE_BIG : SIZE_SMALL;
final int height = maxNumberOfStars * width;
return new Point(width + getBorderWidth() * 2, height + getBorderWidth() * 2);
}
private Point computeSizeHorizontal() {
final int height = sizeOfStars.equals(SIZE.BIG) ? SIZE_BIG : SIZE_SMALL;
final int width = maxNumberOfStars * height;
return new Point(width + getBorderWidth() * 2, height + getBorderWidth() * 2);
}
/**
* @return the number of selected stars
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
*/
public int getCurrentNumberOfStars() {
checkWidget();
return currentNumberOfStars;
}
/**
* @return the maximum number of stars that is displayed by this component
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
*/
public int getMaxNumberOfStars() {
checkWidget();
return maxNumberOfStars;
}
/**
* @return the orientation of this widget (SWT.VERTICAL or SWT.HORIZONTAL)
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
*/
public int getOrientation() {
checkWidget();
return orientation;
}
/**
* @return the size of stars
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
*/
public SIZE getSizeOfStars() {
checkWidget();
return sizeOfStars;
}
/**
* Removes the listener from the collection of listeners who will be notified when the
* control is selected by the user.
*
* @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @see SelectionListener
* @see #addSelectionListener
*/
public void removeSelectionListener(final SelectionListener listener) {
checkWidget();
SelectionListenerUtil.removeSelectionListener(this, listener);
}
/**
* Set the current number of stars
*
* @param currentNumberOfStars current number of stars
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the number of star is negative or greater than the maximum number of stars</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
*/
public void setCurrentNumberOfStars(final int currentNumberOfStars) {
checkWidget();
if (currentNumberOfStars < 0 || currentNumberOfStars > maxNumberOfStars) {
SWT.error(SWT.ERROR_INVALID_ARGUMENT);
}
this.currentNumberOfStars = currentNumberOfStars;
for (final Star star : stars) {
star.marked = false;
}
for (int i = 0; i < currentNumberOfStars; i++) {
stars.get(i).marked = true;
}
}
/**
* Set the maximum number of stars
*
* @param currentNumberOfStars current number of stars
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
*/
public void setMaxNumberOfStars(final int maxNumberOfStars) {
this.maxNumberOfStars = maxNumberOfStars;
reinitStars();
}
private void reinitStars() {
for (final Star star : stars) {
star.dispose();
}
stars.clear();
for (int i = 0; i < maxNumberOfStars; i++) {
if (sizeOfStars.equals(SIZE.BIG)) {
stars.add(Star.initBig(this));
} else {
stars.add(Star.initSmall(this));
}
}
}
/**
* Set the current size of stars
*
* @param sizeOfStars current number of stars
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the number of star is negative or greater than the maximum number of stars</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
*/
public void setSizeOfStars(final SIZE sizeOfStars) {
checkWidget();
this.sizeOfStars = sizeOfStars;
reinitStars();
}
}