tmf/lttng: Remove unneeded (non-Javadoc) comments

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / views / histogram / FullTraceHistogram.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/FullTraceHistogram.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/FullTraceHistogram.java
index f95d39d4565f5451be1845c0b5378496b4cde834..9560e297d5fdeaa0a1634b329ad78cc241f76d7e 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/FullTraceHistogram.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/FullTraceHistogram.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * 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
@@ -9,7 +9,6 @@
  * Contributors:
  *   Francois Chouinard - Initial API and implementation
  *   Bernd Hufmann - Changed to updated histogram data model
- *   Francois Chouinard - Initial API and implementation
  *******************************************************************************/
 
 package org.eclipse.linuxtools.tmf.ui.views.histogram;
@@ -25,11 +24,12 @@ import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Display;
 
 /**
- * <b><u>FullTraceHistogram</u></b>
- * <p>
- * A histogram that displays the full trace.
+ * A histogram widget that displays the event distribution of a whole trace.
  * <p>
  * It also features a selected range window that can be dragged and zoomed.
+ *
+ * @version 1.1
+ * @author Francois Chouinard
  */
 public class FullTraceHistogram extends Histogram implements MouseMoveListener {
 
@@ -46,13 +46,19 @@ public class FullTraceHistogram extends Histogram implements MouseMoveListener {
 
     private final HistogramZoom fZoom;
 
-    private long fRangeStartTime;
+    private long fRangeStartTime = 0L;
     private long fRangeDuration;
 
     // ------------------------------------------------------------------------
     // Construction
     // ------------------------------------------------------------------------
 
+    /**
+     * Full Constructor
+     *
+     * @param view A reference to the parent histogram view
+     * @param parent A reference to the parent composite
+     */
     public FullTraceHistogram(HistogramView view, Composite parent) {
         super(view, parent);
         fZoom = new HistogramZoom(this, fCanvas, getStartTime(), getTimeLimit());
@@ -69,10 +75,33 @@ public class FullTraceHistogram extends Histogram implements MouseMoveListener {
     // Operations
     // ------------------------------------------------------------------------
 
+    @Override
+    public void clear() {
+        fRangeStartTime = 0L;
+        fRangeDuration = 0L;
+        if (fZoom != null) {
+            fZoom.setFullRange(0L, 0L);
+            fZoom.setNewRange(0L, 0L);
+        }
+        super.clear();
+    }
+
+    /**
+     * Sets the time range of the full histogram.
+     *
+     * @param startTime A start time
+     * @param endTime A end time
+     */
     public void setFullRange(long startTime, long endTime) {
         fZoom.setFullRange(startTime, endTime);
     }
 
+    /**
+     * Sets the selected time range.
+     *
+     * @param startTime The histogram start time
+     * @param duration The histogram duration
+     */
     public void setTimeRange(long startTime, long duration) {
         fRangeStartTime = startTime;
         fRangeDuration = duration;
@@ -97,7 +126,7 @@ public class FullTraceHistogram extends Histogram implements MouseMoveListener {
         fMouseDown = true;
         fStartPosition = event.x;
     }
- 
+
     @Override
     public void mouseUp(MouseEvent event) {
         if (fMouseDown) {
@@ -107,13 +136,13 @@ public class FullTraceHistogram extends Histogram implements MouseMoveListener {
                 super.mouseDown(event);
                 return;
             }
- 
-            ((HistogramView) fParentView).updateTimeRange(fRangeStartTime, fRangeStartTime + fZoom.getDuration());
+
+            ((HistogramView) fParentView).updateTimeRange(fRangeStartTime, fRangeStartTime + fRangeDuration);
 
         }
     }
- 
-    
+
+
     // ------------------------------------------------------------------------
     // MouseMoveListener
     // ------------------------------------------------------------------------
@@ -153,7 +182,7 @@ public class FullTraceHistogram extends Histogram implements MouseMoveListener {
         GC rangeWindowGC = new GC(rangeRectangleImage);
 
         if ((fScaledData != null) && (fRangeStartTime != 0)) {
-            drawTimeRangeWindow(rangeWindowGC, rangeRectangleImage);
+            drawTimeRangeWindow(rangeWindowGC);
         }
 
         // Draws the buffer image onto the canvas.
@@ -163,16 +192,16 @@ public class FullTraceHistogram extends Histogram implements MouseMoveListener {
         rangeRectangleImage.dispose();
     }
 
-    private void drawTimeRangeWindow(GC imageGC, Image image) {
+    private void drawTimeRangeWindow(GC imageGC) {
 
         // Map times to histogram coordinates
-        long bucketSpan = Math.max(fScaledData.fBucketDuration,1);
+        long bucketSpan = Math.max(fScaledData.fBucketDuration, 1);
         int rangeWidth = (int) (fRangeDuration / bucketSpan);
 
         int left = (int) ((fRangeStartTime - fDataModel.getFirstBucketTime()) / bucketSpan);
         int right = left + rangeWidth;
         int center = (left + right) / 2;
-        int height = fCanvas.getSize().y - 2;
+        int height = fCanvas.getSize().y;
 
         // Draw the selection window
         imageGC.setForeground(fTimeRangeColor);