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

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/TimeRangeHistogram.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/TimeRangeHistogram.java
index bf8e2030fb6f66815071b6fc5487aefe562f8bef..3aed94c38c595abc41e5a27aae7953b4e250feeb 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/TimeRangeHistogram.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/TimeRangeHistogram.java
@@ -1,14 +1,14 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2012 Ericsson
- * 
+ * Copyright (c) 2011, 2013 Ericsson
+ *
  * 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:
  *   Francois Chouinard - Initial API and implementation
- *   Bernd Hufmann - Changed to updated histogram data model   
+ *   Bernd Hufmann - Changed to updated histogram data model
  *   Francois Chouinard - Moved from LTTng to TMF
  *******************************************************************************/
 
@@ -17,13 +17,15 @@ package org.eclipse.linuxtools.tmf.ui.views.histogram;
 import org.eclipse.swt.widgets.Composite;
 
 /**
- * <b><u>TimeRangeHistogram</u></b>
- * <p>
- * A basic histogram with the following additional features:
+ * A basic histogram widget that displays the event distribution of a specific time range of a trace.
+ * It has the following additional features:
  * <ul>
  * <li>zoom in: mouse wheel up (or forward)
  * <li>zoom out: mouse wheel down (or backward)
  * </ul>
+ *
+ * @version 1.1
+ * @author Francois Chouinard
  */
 public class TimeRangeHistogram extends Histogram {
 
@@ -31,12 +33,16 @@ public class TimeRangeHistogram extends Histogram {
     // Attributes
     // ------------------------------------------------------------------------
 
-    HistogramZoom fZoom = null;
+    private HistogramZoom fZoom = null;
 
     // ------------------------------------------------------------------------
     // Constructor
     // ------------------------------------------------------------------------
-
+    /**
+     * Constructor
+     * @param view The parent histogram view
+     * @param parent The parent composite
+     */
     public TimeRangeHistogram(HistogramView view, Composite parent) {
         super(view, parent);
         fZoom = new HistogramZoom(this, fCanvas, getStartTime(), getTimeLimit());
@@ -53,15 +59,30 @@ public class TimeRangeHistogram extends Histogram {
 
     @Override
     public synchronized void clear() {
-        if (fZoom != null)
-            fZoom.stop();
+        if (fZoom != null) {
+            fZoom.setFullRange(0L, 0L);
+            fZoom.setNewRange(0L, 0L);
+        }
         super.clear();
     }
 
+    /**
+     * Sets the time range of the histogram
+     * @param startTime The start time
+     * @param duration The duration of the time range
+     */
     public synchronized void setTimeRange(long startTime, long duration) {
         fZoom.setNewRange(startTime, duration);
+        if (getDataModel().getNbEvents() == 0) {
+            getDataModel().setTimeRange(startTime, startTime + duration);
+        }
     }
 
+    /**
+     * Sets the full time range of the whole trace.
+     * @param startTime The start time
+     * @param endTime The end time
+     */
     public void setFullRange(long startTime, long endTime) {
         long currentFirstEvent = getStartTime();
         fZoom.setFullRange((currentFirstEvent == 0) ? startTime : currentFirstEvent, endTime);