Commit | Line | Data |
---|---|---|
73005152 | 1 | /********************************************************************** |
df0b8ff4 BH |
2 | * Copyright (c) 2005, 2008 IBM Corporation and others. |
3 | * Copyright (c) 2011, 2012 Ericsson. | |
4 | * | |
73005152 BH |
5 | * All rights reserved. This program and the accompanying materials |
6 | * are made available under the terms of the Eclipse Public License v1.0 | |
7 | * which accompanies this distribution, and is available at | |
8 | * http://www.eclipse.org/legal/epl-v10.html | |
73005152 BH |
9 | * |
10 | * Contributors: | |
11 | * IBM - Initial API and implementation | |
12 | * Bernd Hufmann - Updated for TMF | |
13 | **********************************************************************/ | |
14 | package org.eclipse.linuxtools.tmf.ui.views.uml2sd; | |
15 | ||
4df4581d | 16 | import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp; |
6c13869b FC |
17 | import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange; |
18 | import org.eclipse.linuxtools.tmf.core.event.TmfTimestamp; | |
73005152 BH |
19 | import org.eclipse.linuxtools.tmf.ui.views.uml2sd.util.SDMessages; |
20 | import org.eclipse.swt.SWT; | |
21 | import org.eclipse.swt.events.PaintEvent; | |
22 | import org.eclipse.swt.events.PaintListener; | |
23 | import org.eclipse.swt.graphics.Color; | |
24 | import org.eclipse.swt.graphics.Point; | |
25 | import org.eclipse.swt.layout.RowLayout; | |
26 | import org.eclipse.swt.widgets.Composite; | |
27 | import org.eclipse.swt.widgets.Display; | |
28 | import org.eclipse.swt.widgets.Shell; | |
29 | ||
30 | /** | |
df0b8ff4 | 31 | * <p> |
73005152 BH |
32 | * This class is used to reproduce the same tooltip behavior on Windows and Linux when the mouse move hover the time |
33 | * compression bar used to display elapsed time using a tooltip. The tooltip is composed of 2 parts, the text value and | |
df0b8ff4 | 34 | * below, a scale to visually locate the value in a time range (usually the minimum an maximum elapsed time in the whole |
73005152 | 35 | * diagram) |
df0b8ff4 | 36 | * </p> |
73005152 | 37 | * |
df0b8ff4 | 38 | * @version 1.0 |
73005152 BH |
39 | * @author sveyrier |
40 | */ | |
41 | public class DrawableToolTip implements PaintListener { | |
42 | ||
df0b8ff4 BH |
43 | // ------------------------------------------------------------------------ |
44 | // Attributes | |
45 | // ------------------------------------------------------------------------ | |
46 | ||
73005152 BH |
47 | /** |
48 | * The parent control where the tooltip must be drawn | |
49 | */ | |
eb63f5ff | 50 | protected Composite fParent = null; |
73005152 BH |
51 | /** |
52 | * The tooltip shell | |
53 | */ | |
eb63f5ff | 54 | protected Shell fToolTipShell = null; |
73005152 | 55 | /** |
df0b8ff4 | 56 | * The Time range data. |
73005152 | 57 | */ |
eb63f5ff | 58 | protected TmfTimeRange fMinMaxRange; |
df0b8ff4 BH |
59 | /** |
60 | * The current time. | |
61 | */ | |
eb63f5ff | 62 | protected ITmfTimestamp fCurrentValue; |
df0b8ff4 BH |
63 | /** |
64 | * The horizontal margin used for drawing. | |
65 | */ | |
eb63f5ff | 66 | private static int fHorMargin = 10; |
df0b8ff4 BH |
67 | /** |
68 | * The vertical margin used for drawing. | |
69 | */ | |
eb63f5ff | 70 | private static int fVertMargin = 10; |
df0b8ff4 BH |
71 | /** |
72 | * The minimum text scale margin. | |
73 | */ | |
eb63f5ff | 74 | private static int fTextScaleMargin = 20; |
df0b8ff4 BH |
75 | /** |
76 | * The length of the text scale. | |
77 | */ | |
eb63f5ff | 78 | private static int fScaleLength = 100; |
df0b8ff4 BH |
79 | /** |
80 | * The text to display | |
81 | */ | |
eb63f5ff | 82 | protected String fMessage; |
73005152 BH |
83 | /** |
84 | * The color array used to represent the 10 time range slices | |
85 | */ | |
eb63f5ff | 86 | protected Color[] fColors; |
73005152 | 87 | |
df0b8ff4 BH |
88 | // ------------------------------------------------------------------------ |
89 | // Constructors | |
90 | // ------------------------------------------------------------------------ | |
91 | ||
92 | /** | |
93 | * Creates a drawable tool tip instance. | |
94 | * | |
eb63f5ff | 95 | * @param parent The parent composite. |
df0b8ff4 | 96 | */ |
eb63f5ff BH |
97 | public DrawableToolTip(Composite parent) { |
98 | fParent = parent; | |
99 | fToolTipShell = new Shell(fParent.getShell(), SWT.ON_TOP); | |
100 | fToolTipShell.setLayout(new RowLayout()); | |
101 | fToolTipShell.setBackground(Display.getDefault().getSystemColor(SWT.COLOR_INFO_BACKGROUND)); | |
102 | fToolTipShell.addPaintListener(this); | |
103 | fToolTipShell.setSize(200, 50); | |
73005152 | 104 | |
eb63f5ff BH |
105 | fColors = new Color[10]; |
106 | fColors[0] = new Color(Display.getDefault(), 255, 229, 229); | |
107 | fColors[1] = new Color(Display.getDefault(), 255, 204, 204); | |
108 | fColors[2] = new Color(Display.getDefault(), 255, 178, 178); | |
109 | fColors[3] = new Color(Display.getDefault(), 255, 153, 153); | |
110 | fColors[4] = new Color(Display.getDefault(), 255, 127, 127); | |
111 | fColors[5] = new Color(Display.getDefault(), 255, 102, 102); | |
112 | fColors[6] = new Color(Display.getDefault(), 255, 76, 76); | |
113 | fColors[7] = new Color(Display.getDefault(), 255, 51, 51); | |
114 | fColors[8] = new Color(Display.getDefault(), 255, 25, 25); | |
115 | fColors[9] = new Color(Display.getDefault(), 255, 0, 0); | |
73005152 BH |
116 | } |
117 | ||
df0b8ff4 BH |
118 | // ------------------------------------------------------------------------ |
119 | // Methods | |
120 | // ------------------------------------------------------------------------ | |
121 | /** | |
122 | * Returns the message to display. | |
123 | * | |
124 | * @return the message to display. | |
125 | */ | |
126 | public String getText() { | |
eb63f5ff | 127 | return fMessage; |
df0b8ff4 BH |
128 | } |
129 | ||
130 | /** | |
131 | * Returns teh current time to display. | |
132 | * | |
133 | * @return the current time to display | |
134 | */ | |
135 | public String getAccessibleText() { | |
eb63f5ff | 136 | return fCurrentValue.toString(); |
df0b8ff4 BH |
137 | } |
138 | ||
139 | /** | |
140 | * Returns the horizontal margin. | |
141 | * | |
142 | * @return the horizontal margin. | |
143 | */ | |
144 | protected static int getHorizontalMargin() { | |
eb63f5ff | 145 | return fHorMargin; |
df0b8ff4 BH |
146 | } |
147 | ||
148 | /** | |
149 | * Sets the horizontal margin. | |
150 | * | |
151 | * @param margin The margin to set. | |
152 | */ | |
153 | protected static void setHorizontalMargin(int margin) { | |
eb63f5ff | 154 | fHorMargin = margin; |
df0b8ff4 BH |
155 | } |
156 | ||
157 | /** | |
158 | * Returns the vertical margin. | |
159 | * | |
160 | * @return the vertical margin. | |
161 | */ | |
162 | protected static int getVerticalMargin() { | |
eb63f5ff | 163 | return fVertMargin; |
df0b8ff4 BH |
164 | } |
165 | ||
166 | /** | |
167 | * Sets the vertical margin. | |
168 | * | |
169 | * @param margin The margin to set. | |
170 | */ | |
171 | protected static void setVerticalMargin(int margin) { | |
eb63f5ff | 172 | fVertMargin = margin; |
df0b8ff4 BH |
173 | } |
174 | ||
175 | /** | |
176 | * Returns the text scale margin. | |
177 | * | |
178 | * @return the text scale margin. | |
179 | */ | |
180 | protected static int getTextScaleMargin() { | |
eb63f5ff | 181 | return fTextScaleMargin; |
df0b8ff4 BH |
182 | } |
183 | ||
184 | /** | |
185 | * Sets the text scale margin. | |
186 | * @param textScaleMargin The margin to set. | |
187 | */ | |
188 | protected static void setTestScaleMargin(int textScaleMargin) { | |
eb63f5ff | 189 | fTextScaleMargin = textScaleMargin; |
df0b8ff4 BH |
190 | } |
191 | ||
192 | /** | |
193 | * Returns the scale length. | |
194 | * | |
195 | * @return the scale length. | |
196 | */ | |
197 | protected static int getScaleLength() { | |
eb63f5ff | 198 | return fScaleLength; |
df0b8ff4 BH |
199 | } |
200 | ||
201 | /** | |
202 | * Sets the scale length. | |
203 | * | |
204 | * @param scaleLength The scale length to set. | |
205 | */ | |
206 | protected static void setScaleLength(int scaleLength) { | |
eb63f5ff | 207 | fScaleLength = scaleLength; |
df0b8ff4 BH |
208 | } |
209 | ||
73005152 BH |
210 | /** |
211 | * Display the tooltip using the given time range(min,max) the current value and the time unit The tooltip will stay | |
212 | * on screen until it is told otherwise | |
213 | * | |
0d9a6d76 FC |
214 | * @param value the current in the scale |
215 | * @param min the scale min | |
216 | * @param max the scale max | |
73005152 | 217 | */ |
0d9a6d76 | 218 | public void showToolTip(ITmfTimestamp value, ITmfTimestamp min, ITmfTimestamp max) { |
eb63f5ff BH |
219 | fMinMaxRange = new TmfTimeRange(min.clone(), max.clone()); |
220 | fCurrentValue = value.clone(); | |
73005152 | 221 | |
eb63f5ff BH |
222 | int w = fToolTipShell.getBounds().width; |
223 | int h = fToolTipShell.getBounds().height; | |
73005152 | 224 | Point hr = Display.getDefault().getCursorLocation(); |
eb63f5ff BH |
225 | fToolTipShell.setBounds(hr.x, hr.y + 26, w, h); |
226 | fToolTipShell.setVisible(true); | |
73005152 BH |
227 | } |
228 | ||
229 | /** | |
df0b8ff4 | 230 | * Hide the tooltip. |
73005152 BH |
231 | */ |
232 | public void hideToolTip() { | |
eb63f5ff | 233 | fToolTipShell.setVisible(false); |
73005152 BH |
234 | } |
235 | ||
236 | /** | |
df0b8ff4 BH |
237 | * Disposes the system resource used by this kind of toolTips (a colors array essentially) |
238 | */ | |
239 | public void dispose() { | |
eb63f5ff BH |
240 | for (int i = 0; i < fColors.length; i++) |
241 | fColors[i].dispose(); | |
df0b8ff4 BH |
242 | } |
243 | ||
244 | /* | |
245 | * (non-Javadoc) | |
246 | * @see org.eclipse.swt.events.PaintListener#paintControl(org.eclipse.swt.events.PaintEvent) | |
73005152 BH |
247 | */ |
248 | @Override | |
249 | public void paintControl(PaintEvent event) { | |
eb63f5ff BH |
250 | fMessage = SDMessages._138 + " " + fCurrentValue.toString(); //$NON-NLS-1$ |
251 | Point size = event.gc.textExtent(fMessage); | |
252 | if (size.x < fScaleLength) { | |
253 | size.x = fScaleLength; | |
df0b8ff4 | 254 | } |
eb63f5ff BH |
255 | event.gc.drawText(fMessage, fHorMargin, fVertMargin, true); |
256 | event.gc.drawLine(fHorMargin, fVertMargin + fTextScaleMargin + size.y, fHorMargin + fScaleLength, fVertMargin + fTextScaleMargin + size.y); | |
73005152 | 257 | |
eb63f5ff | 258 | int step = fScaleLength / 10; |
73005152 BH |
259 | |
260 | // double gr = (max - min) / 10; | |
eb63f5ff | 261 | ITmfTimestamp minMaxdelta = (TmfTimestamp) fMinMaxRange.getEndTime().getDelta(fMinMaxRange.getStartTime()); |
73005152 BH |
262 | double gr = (minMaxdelta.getValue()) / (double) 10; |
263 | ||
264 | // double delta = currentValue-min; | |
eb63f5ff | 265 | ITmfTimestamp delta = (TmfTimestamp) fCurrentValue.getDelta(fMinMaxRange.getStartTime()); |
73005152 BH |
266 | long absDelta = Math.abs(delta.getValue()); |
267 | ||
268 | int colIndex = 0; | |
269 | if (gr != 0) { | |
270 | // colIndex = Math.round((float)(Math.log(1+delta)/gr)); | |
271 | colIndex = Math.round((float) (absDelta / gr)); | |
eb63f5ff BH |
272 | if (colIndex > fColors.length) { |
273 | colIndex = fColors.length; | |
df0b8ff4 | 274 | } else if (colIndex <= 1) { |
73005152 | 275 | colIndex = 1; |
df0b8ff4 BH |
276 | } |
277 | } else { | |
73005152 | 278 | colIndex = 1; |
df0b8ff4 | 279 | } |
73005152 BH |
280 | |
281 | for (int i = 0; i <= 10; i++) { | |
df0b8ff4 | 282 | if (i < 10) { |
eb63f5ff | 283 | event.gc.setBackground(fColors[i]); |
df0b8ff4 BH |
284 | } |
285 | if ((i < colIndex) && (i < 10)) { | |
eb63f5ff | 286 | event.gc.fillRectangle(fHorMargin + i * step, fVertMargin + fTextScaleMargin + size.y - 5, step, 11); |
df0b8ff4 BH |
287 | } |
288 | if (i == 0) { | |
eb63f5ff | 289 | event.gc.drawText(SDMessages._56, fHorMargin, size.y + 2 * fVertMargin + fTextScaleMargin, true); |
df0b8ff4 | 290 | } |
73005152 BH |
291 | if (i == 0) { |
292 | int len = event.gc.textExtent(SDMessages._55).x; | |
eb63f5ff | 293 | event.gc.drawText(SDMessages._55, fHorMargin + fScaleLength - len + 1, size.y + 2 * fVertMargin + fTextScaleMargin, true); |
73005152 BH |
294 | } |
295 | int lineWidth = 10; | |
df0b8ff4 | 296 | if ((i == 0) || (i == 10)) { |
73005152 | 297 | lineWidth = 14; |
df0b8ff4 | 298 | } |
eb63f5ff | 299 | event.gc.drawLine(fHorMargin + i * step, fVertMargin + fTextScaleMargin + size.y - lineWidth / 2, fHorMargin + i * step, fVertMargin + fTextScaleMargin + size.y + lineWidth / 2); |
73005152 | 300 | } |
eb63f5ff | 301 | fToolTipShell.setSize(size.x + 2 * fHorMargin + 2, 2 * size.y + 3 * fVertMargin + fTextScaleMargin); |
73005152 | 302 | } |
73005152 | 303 | } |