tmf/lttng: Remove unneeded (non-Javadoc) comments
[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / views / histogram / TimeRangeHistogram.java
1 /*******************************************************************************
2 * Copyright (c) 2011, 2013 Ericsson
3 *
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
8 *
9 * Contributors:
10 * Francois Chouinard - Initial API and implementation
11 * Bernd Hufmann - Changed to updated histogram data model
12 * Francois Chouinard - Moved from LTTng to TMF
13 *******************************************************************************/
14
15 package org.eclipse.linuxtools.tmf.ui.views.histogram;
16
17 import org.eclipse.swt.widgets.Composite;
18
19 /**
20 * A basic histogram widget that displays the event distribution of a specific time range of a trace.
21 * It has the following additional features:
22 * <ul>
23 * <li>zoom in: mouse wheel up (or forward)
24 * <li>zoom out: mouse wheel down (or backward)
25 * </ul>
26 *
27 * @version 1.1
28 * @author Francois Chouinard
29 */
30 public class TimeRangeHistogram extends Histogram {
31
32 // ------------------------------------------------------------------------
33 // Attributes
34 // ------------------------------------------------------------------------
35
36 private HistogramZoom fZoom = null;
37
38 // ------------------------------------------------------------------------
39 // Constructor
40 // ------------------------------------------------------------------------
41 /**
42 * Constructor
43 * @param view The parent histogram view
44 * @param parent The parent composite
45 */
46 public TimeRangeHistogram(HistogramView view, Composite parent) {
47 super(view, parent);
48 fZoom = new HistogramZoom(this, fCanvas, getStartTime(), getTimeLimit());
49 }
50
51 // ------------------------------------------------------------------------
52 // Operations
53 // ------------------------------------------------------------------------
54
55 @Override
56 public void updateTimeRange(long startTime, long endTime) {
57 ((HistogramView) fParentView).updateTimeRange(startTime, endTime);
58 }
59
60 @Override
61 public synchronized void clear() {
62 if (fZoom != null) {
63 fZoom.setFullRange(0L, 0L);
64 fZoom.setNewRange(0L, 0L);
65 }
66 super.clear();
67 }
68
69 /**
70 * Sets the time range of the histogram
71 * @param startTime The start time
72 * @param duration The duration of the time range
73 */
74 public synchronized void setTimeRange(long startTime, long duration) {
75 fZoom.setNewRange(startTime, duration);
76 if (getDataModel().getNbEvents() == 0) {
77 getDataModel().setTimeRange(startTime, startTime + duration);
78 }
79 }
80
81 /**
82 * Sets the full time range of the whole trace.
83 * @param startTime The start time
84 * @param endTime The end time
85 */
86 public void setFullRange(long startTime, long endTime) {
87 long currentFirstEvent = getStartTime();
88 fZoom.setFullRange((currentFirstEvent == 0) ? startTime : currentFirstEvent, endTime);
89 }
90
91 }
This page took 0.0321 seconds and 5 git commands to generate.