1 /**********************************************************************
2 * Copyright (c) 2013, 2016 Ericsson, École Polytechnique de Montréal
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Bernd Hufmann - Initial API and implementation
11 * Geneviève Bastien - Moved some methods to TmfTimeViewer
12 * Patrick Tasse - Fix setFocus
13 **********************************************************************/
14 package org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.xycharts
;
16 import org
.eclipse
.swt
.SWT
;
17 import org
.eclipse
.swt
.events
.MouseAdapter
;
18 import org
.eclipse
.swt
.events
.MouseEvent
;
19 import org
.eclipse
.swt
.widgets
.Composite
;
20 import org
.eclipse
.swt
.widgets
.Control
;
21 import org
.eclipse
.swt
.widgets
.Display
;
22 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSelectionRangeUpdatedSignal
;
23 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalHandler
;
24 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTimestampFormatUpdateSignal
;
25 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfWindowRangeUpdatedSignal
;
26 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
27 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.TmfTimeViewer
;
28 import org
.swtchart
.Chart
;
29 import org
.swtchart
.IAxis
;
30 import org
.swtchart
.ISeries
;
31 import org
.swtchart
.ISeriesSet
;
32 import org
.swtchart
.Range
;
35 * Base class for a XY-Chart based on SWT chart. It provides a methods to define
36 * zoom, selection and tool tip providers. It also provides call backs to be
37 * notified by any changes caused by selection and zoom.
39 * @author Bernd Hufmann
41 public abstract class TmfXYChartViewer
extends TmfTimeViewer
implements ITmfChartTimeProvider
{
43 // ------------------------------------------------------------------------
45 // ------------------------------------------------------------------------
46 /** The SWT Chart reference */
47 private Chart fSwtChart
;
48 /** The mouse selection provider */
49 private TmfBaseProvider fMouseSelectionProvider
;
50 /** The mouse drag zoom provider */
51 private TmfBaseProvider fMouseDragZoomProvider
;
52 /** The mouse wheel zoom provider */
53 private TmfBaseProvider fMouseWheelZoomProvider
;
54 /** The tooltip provider */
55 private TmfBaseProvider fToolTipProvider
;
56 /** The middle mouse drag provider */
57 private TmfBaseProvider fMouseDragProvider
;
59 * Whether or not to send time alignment signals. This should be set to true
60 * for viewers that are part of an aligned view.
62 private boolean fSendTimeAlignSignals
= false;
65 // ------------------------------------------------------------------------
67 // ------------------------------------------------------------------------
70 * Constructs a TmfXYChartViewer.
73 * The parent composite
75 * The title of the viewer
77 * The label of the xAxis
79 * The label of the yAXIS
81 public TmfXYChartViewer(Composite parent
, String title
, String xLabel
, String yLabel
) {
83 fSwtChart
= new Chart(parent
, SWT
.NONE
) {
85 public boolean setFocus() {
86 return fSwtChart
.getPlotArea().setFocus();
89 fSwtChart
.getPlotArea().addMouseListener(new MouseAdapter() {
91 public void mouseDown(MouseEvent e
) {
92 fSwtChart
.getPlotArea().setFocus();
96 IAxis xAxis
= fSwtChart
.getAxisSet().getXAxis(0);
97 IAxis yAxis
= fSwtChart
.getAxisSet().getYAxis(0);
99 /* Set the title/labels, or hide them if they are not provided */
101 fSwtChart
.getTitle().setVisible(false);
103 fSwtChart
.getTitle().setText(title
);
105 if (xLabel
== null) {
106 xAxis
.getTitle().setVisible(false);
108 xAxis
.getTitle().setText(xLabel
);
110 if (yLabel
== null) {
111 yAxis
.getTitle().setVisible(false);
113 yAxis
.getTitle().setText(yLabel
);
116 fMouseSelectionProvider
= new TmfMouseSelectionProvider(this);
117 fMouseDragZoomProvider
= new TmfMouseDragZoomProvider(this);
118 fMouseWheelZoomProvider
= new TmfMouseWheelZoomProvider(this);
119 fToolTipProvider
= new TmfSimpleTooltipProvider(this);
120 fMouseDragProvider
= new TmfMouseDragProvider(this);
122 fSwtChart
.addDisposeListener((e
) -> {
127 // ------------------------------------------------------------------------
129 // ------------------------------------------------------------------------
132 * Sets the SWT Chart reference
135 * The SWT chart to set.
137 protected void setSwtChart(Chart chart
) {
142 * Gets the SWT Chart reference
144 * @return the SWT chart to set.
146 protected Chart
getSwtChart() {
151 * Sets a mouse selection provider. An existing provider will be
152 * disposed. Use <code>null</code> to disable the mouse selection provider.
155 * The selection provider to set
157 public void setSelectionProvider(TmfBaseProvider provider
) {
158 if (fMouseSelectionProvider
!= null) {
159 fMouseSelectionProvider
.dispose();
161 fMouseSelectionProvider
= provider
;
165 * Sets a mouse drag zoom provider. An existing provider will be
166 * disposed. Use <code>null</code> to disable the mouse drag zoom provider.
169 * The mouse drag zoom provider to set
171 public void setMouseDragZoomProvider(TmfBaseProvider provider
) {
172 if (fMouseDragZoomProvider
!= null) {
173 fMouseDragZoomProvider
.dispose();
175 fMouseDragZoomProvider
= provider
;
179 * Sets a mouse wheel zoom provider. An existing provider will be
180 * disposed. Use <code>null</code> to disable the mouse wheel zoom
184 * The mouse wheel zoom provider to set
186 public void setMouseWheelZoomProvider(TmfBaseProvider provider
) {
187 if (fMouseWheelZoomProvider
!= null) {
188 fMouseWheelZoomProvider
.dispose();
190 fMouseWheelZoomProvider
= provider
;
194 * Sets a tooltip provider. An existing provider will be
195 * disposed. Use <code>null</code> to disable the tooltip provider.
198 * The tooltip provider to set
200 public void setTooltipProvider(TmfBaseProvider provider
) {
201 if (fToolTipProvider
!= null) {
202 fToolTipProvider
.dispose();
204 fToolTipProvider
= provider
;
208 * Sets a mouse drag provider. An existing provider will be
209 * disposed. Use <code>null</code> to disable the mouse drag provider.
212 * The mouse drag provider to set
214 public void setMouseDrageProvider(TmfBaseProvider provider
) {
215 if (fMouseDragProvider
!= null) {
216 fMouseDragProvider
.dispose();
218 fMouseDragProvider
= provider
;
221 // ------------------------------------------------------------------------
222 // ITmfChartTimeProvider
223 // ------------------------------------------------------------------------
226 public long getTimeOffset() {
227 return getWindowStartTime() - 1;
230 // ------------------------------------------------------------------------
231 // ITmfViewer interface
232 // ------------------------------------------------------------------------
234 public Control
getControl() {
239 public void refresh() {
243 // ------------------------------------------------------------------------
245 // ------------------------------------------------------------------------
248 public void dispose() {
252 private void internalDispose() {
255 if (fMouseSelectionProvider
!= null) {
256 fMouseSelectionProvider
.dispose();
259 if (fMouseDragZoomProvider
!= null) {
260 fMouseDragZoomProvider
.dispose();
263 if (fMouseWheelZoomProvider
!= null) {
264 fMouseWheelZoomProvider
.dispose();
267 if (fToolTipProvider
!= null) {
268 fToolTipProvider
.dispose();
271 if (fMouseDragProvider
!= null) {
272 fMouseDragProvider
.dispose();
276 // ------------------------------------------------------------------------
278 // ------------------------------------------------------------------------
280 * A Method to load a trace into the viewer.
283 * A trace to apply in the viewer
286 public void loadTrace(ITmfTrace trace
) {
287 super.loadTrace(trace
);
293 * Resets the content of the viewer
296 public void reset() {
304 * Method to implement to update the chart content.
306 protected abstract void updateContent();
308 // ------------------------------------------------------------------------
310 // ------------------------------------------------------------------------
313 * Signal handler for handling of the time synch signal.
316 * The time synch signal {@link TmfSelectionRangeUpdatedSignal}
320 public void selectionRangeUpdated(TmfSelectionRangeUpdatedSignal signal
) {
321 super.selectionRangeUpdated(signal
);
322 if ((signal
.getSource() != this) && (getTrace() != null)) {
323 if (fMouseSelectionProvider
!= null) {
324 fMouseSelectionProvider
.refresh();
330 * Signal handler for handling of the window range signal.
333 * The {@link TmfWindowRangeUpdatedSignal}
337 public void windowRangeUpdated(TmfWindowRangeUpdatedSignal signal
) {
338 super.windowRangeUpdated(signal
);
343 * Signal handler for handling the signal that notifies about an updated
347 * The trace updated signal
348 * {@link TmfTimestampFormatUpdateSignal}
351 public void timestampFormatUpdated(TmfTimestampFormatUpdateSignal signal
) {
352 fSwtChart
.getAxisSet().adjustRange();
356 // ------------------------------------------------------------------------
358 // ------------------------------------------------------------------------
361 * Clears the view content.
363 protected void clearContent() {
364 if (!fSwtChart
.isDisposed()) {
365 ISeriesSet set
= fSwtChart
.getSeriesSet();
366 ISeries
[] series
= set
.getSeries();
367 for (int i
= 0; i
< series
.length
; i
++) {
368 set
.deleteSeries(series
[i
].getId());
370 for (IAxis axis
: fSwtChart
.getAxisSet().getAxes()){
371 axis
.setRange(new Range(0,1));
378 * Returns the current or default display.
380 * @return the current or default display
382 protected static Display
getDisplay() {
383 Display display
= Display
.getCurrent();
384 // may be null if outside the UI thread
385 if (display
== null) {
386 display
= Display
.getDefault();
392 * Get the offset of the point area, relative to the XY chart viewer
393 * control. We consider the point area to be from where the first point
394 * could be drawn to where the last point could be drawn.
396 * @return the offset in pixels
400 public int getPointAreaOffset() {
402 int pixelCoordinate
= 0;
403 IAxis
[] xAxes
= getSwtChart().getAxisSet().getXAxes();
404 if (xAxes
.length
> 0) {
405 IAxis axis
= xAxes
[0];
406 pixelCoordinate
= axis
.getPixelCoordinate(axis
.getRange().lower
);
408 return getSwtChart().toControl(getSwtChart().getPlotArea().toDisplay(pixelCoordinate
, 0)).x
;
412 * Get the width of the point area. We consider the point area to be from
413 * where the first point could be drawn to where the last point could be
414 * drawn. The point area differs from the plot area because there might be a
415 * gap between where the plot area start and where the fist point is drawn.
416 * This also matches the width that the use can select.
418 * @return the width in pixels
422 public int getPointAreaWidth() {
423 IAxis
[] xAxes
= getSwtChart().getAxisSet().getXAxes();
424 if (xAxes
.length
> 0) {
425 IAxis axis
= xAxes
[0];
426 int x1
= getPointAreaOffset();
427 int x2
= axis
.getPixelCoordinate(axis
.getRange().upper
);
428 x2
= getSwtChart().toControl(getSwtChart().getPlotArea().toDisplay(x2
, 0)).x
;
433 return getSwtChart().getPlotArea().getSize().x
;
437 * Sets whether or not to send time alignment signals. This should be set to
438 * true for viewers that are part of an aligned view.
440 * @param sendTimeAlignSignals
441 * whether or not to send time alignment signals
444 public void setSendTimeAlignSignals(boolean sendTimeAlignSignals
) {
445 fSendTimeAlignSignals
= sendTimeAlignSignals
;
449 * Returns whether or not to send time alignment signals.
451 * @return whether or not to send time alignment signals.
454 public boolean isSendTimeAlignSignals() {
455 return fSendTimeAlignSignals
;