tmf/lttng: Remove unneeded (non-Javadoc) comments
[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / views / uml2sd / ScrollView.java
index 087842455285bce4a5e30744fd8cebe4d322f8c4..c9c6f33fa1cd63596e0567132da7dee7ab59f313 100755 (executable)
@@ -1,16 +1,15 @@
 /**********************************************************************
- * Copyright (c) 2005, 2008 IBM Corporation and others.
- * Copyright (c) 2011, 2012 Ericsson.
- *
+ * Copyright (c) 2005, 2013 IBM Corporation, 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:
- * IBM - Initial API and implementation
- * Bernd Hufmann - Updated for TMF
+ *     IBM - Initial API and implementation
+ *     Bernd Hufmann - Updated for TMF
  **********************************************************************/
+
 package org.eclipse.linuxtools.tmf.ui.views.uml2sd;
 
 import java.util.Timer;
@@ -408,30 +407,16 @@ public class ScrollView extends Composite {
     // Methods
     // ------------------------------------------------------------------------
 
-    /*
-     * (non-Javadoc)
-     * @see org.eclipse.swt.widgets.Composite#setFocus()
-     */
     @Override
     public boolean setFocus() {
         return fViewControl.forceFocus();
     }
 
-    /*
-     * (non-Javadoc)
-     * @see org.eclipse.swt.widgets.Control#setCursor(org.eclipse.swt.graphics.Cursor)
-     */
     @Override
     public void setCursor(Cursor cursor) {
         fViewControl.setCursor(cursor);
     }
 
-    /*
-     * Dispose controls used in scroll view
-     *
-     * (non-Javadoc)
-     * @see org.eclipse.swt.widgets.Widget#dispose()
-     */
     @Override
     public void dispose() {
         if (fAutoScroll != null) {
@@ -461,29 +446,17 @@ public class ScrollView extends Composite {
         super.dispose();
     }
 
-    /*
-     * (non-Javadoc)
-     * @see org.eclipse.swt.widgets.Composite#getClientArea()
-     */
     @Override
     public Rectangle getClientArea() {
         return fViewControl.getClientArea();
     }
 
-    /*
-     * (non-Javadoc)
-     * @see org.eclipse.swt.widgets.Control#setBackground(org.eclipse.swt.graphics.Color)
-     */
     @Override
     public void setBackground(Color c) {
         super.setBackground(c);
         fViewControl.setBackground(c);
     }
 
-    /*
-     * (non-Javadoc)
-     * @see org.eclipse.swt.widgets.Control#setToolTipText(java.lang.String)
-     */
     @Override
     public void setToolTipText(String text) {
         fViewControl.setToolTipText(text);
@@ -813,14 +786,17 @@ public class ScrollView extends Composite {
      * Called when the mouse enter the ScrollView area
      *
      * @param e
+     *            Mouse event
      */
     protected void contentsMouseExit(MouseEvent e) {
     }
 
     /**
-     * Called when the mouse enter the ScrollView area after and system defined time
+     * Called when the mouse enter the ScrollView area after and system defined
+     * time
      *
      * @param e
+     *            Mouse event
      */
     protected void contentsMouseHover(MouseEvent e) {
     }
@@ -829,6 +805,7 @@ public class ScrollView extends Composite {
      * Called when the mouse enter the ScrollView area
      *
      * @param e
+     *            Mouse event
      */
     protected void contentsMouseEnter(MouseEvent e) {
     }
@@ -837,6 +814,7 @@ public class ScrollView extends Composite {
      * Called when user double on contents area.
      *
      * @param e
+     *            Mouse event
      */
     protected void contentsMouseDoubleClickEvent(MouseEvent e) {
     }
@@ -845,6 +823,7 @@ public class ScrollView extends Composite {
      * Called when mouse is on contents area and button is pressed.
      *
      * @param e
+     *            Mouse event
      */
     protected void contentsMouseDownEvent(MouseEvent e) {
         fMouseDownX = e.x;
@@ -855,10 +834,26 @@ public class ScrollView extends Composite {
      * TimerTask for auto scroll feature.
      */
     protected static class AutoScroll extends TimerTask {
+
+        /** X delta */
         public int deltaX;
+
+        /** Y delta */
         public int deltaY;
+
+        /** ScrollView object */
         public ScrollView scrollView;
 
+        /**
+         * Constructor.
+         *
+         * @param sv
+         *            ScrollView object to use
+         * @param dx
+         *            X delta
+         * @param dy
+         *            Y delta
+         */
         public AutoScroll(ScrollView sv, int dx, int dy) {
             scrollView = sv;
             deltaX = dx;
@@ -880,6 +875,7 @@ public class ScrollView extends Composite {
      * Called when mouse is on contents area and mode.
      *
      * @param event
+     *            Mouse event
      */
     protected void contentsMouseMoveEvent(MouseEvent event) {
         if ((event.stateMask & SWT.BUTTON_MASK) != 0) {
@@ -936,6 +932,7 @@ public class ScrollView extends Composite {
      * Called when mouse is on contents area and button is released
      *
      * @param event
+     *            Mouse event
      */
     protected void contentsMouseUpEvent(MouseEvent event) {
         // reset auto scroll if it's engaged
@@ -946,14 +943,20 @@ public class ScrollView extends Composite {
     }
 
     /**
-     * Responsible to draw contents area. At least rectangle clipX must be redrawn. This rectangle is given in contents
-     * coordinates. By default, no paint is produced.
+     * Responsible to draw contents area. At least rectangle clipX must be
+     * redrawn. This rectangle is given in contents coordinates. By default, no
+     * paint is produced.
      *
      * @param gc
+     *            Graphics context
      * @param clipx
+     *            X clip
      * @param clipy
+     *            Y clip
      * @param clipw
+     *            W clip
      * @param cliph
+     *            H clip
      */
     protected void drawContents(GC gc, int clipx, int clipy, int clipw, int cliph) {
     }
@@ -1287,21 +1290,11 @@ public class ScrollView extends Composite {
         return true;
     }
 
-    // redefined to return our vertical bar
-    /*
-     * (non-Javadoc)
-     * @see org.eclipse.swt.widgets.Scrollable#getVerticalBar()
-     */
     @Override
     public ScrollBar getVerticalBar() {
         return fVertScrollBar.getVerticalBar();
     }
 
-    // redefined to return out horizontal bar
-    /*
-     * (non-Javadoc)
-     * @see org.eclipse.swt.widgets.Scrollable#getHorizontalBar()
-     */
     @Override
     public ScrollBar getHorizontalBar() {
         return fHorScrollBar.getHorizontalBar();
@@ -1361,7 +1354,9 @@ public class ScrollView extends Composite {
     }
 
     /**
-     * setup scroll bars visibility, return true if one of visibility changed.
+     * Setup scroll bars visibility.
+     *
+     * @return True if one of visibility changed.
      */
     protected boolean updateScrollBarVisiblity() {
         boolean change = false;
@@ -1540,7 +1535,11 @@ public class ScrollView extends Composite {
     }
 
     /**
-     * Add support for arrow key, scroll the ... scroll view. But you can redefine this method for your convenience.
+     * Add support for arrow key, scroll the ... scroll view. But you can
+     * redefine this method for your convenience.
+     *
+     * @param event
+     *            Keyboard event
      */
     protected void keyPressedEvent(KeyEvent event) {
         switch (event.keyCode) {
@@ -1592,10 +1591,6 @@ public class ScrollView extends Composite {
         return bh + 1;
     }
 
-    /*
-     * (non-Javadoc)
-     * @see org.eclipse.swt.widgets.Scrollable#computeTrim(int, int, int, int)
-     */
     @Override
     public Rectangle computeTrim(int x, int y, int w, int h) {
         Rectangle r = new Rectangle(x, y, w, h);
@@ -1622,10 +1617,6 @@ public class ScrollView extends Composite {
          */
         boolean dontLayout = false;
 
-        /*
-         * (non-Javadoc)
-         * @see org.eclipse.swt.widgets.Layout#computeSize(org.eclipse.swt.widgets.Composite, int, int, boolean)
-         */
         @Override
         protected Point computeSize(Composite composite, int wHint, int hHint, boolean flushCache) {
             Point p = new Point(250, 250);
@@ -1638,10 +1629,6 @@ public class ScrollView extends Composite {
             return p;
         }
 
-        /*
-         * (non-Javadoc)
-         * @see org.eclipse.swt.widgets.Layout#layout(org.eclipse.swt.widgets.Composite, boolean)
-         */
         @Override
         protected void layout(Composite composite, boolean flushCache) {
             if (dontLayout) {
@@ -1839,6 +1826,11 @@ public class ScrollView extends Composite {
 
         /**
          * Process overview appear
+         *
+         * @param mx
+         *            X coordinate
+         * @param my
+         *            Y coordinate
          */
         protected void overviewAppear(int mx, int my) {
             if (fOverview == null) {
@@ -2016,10 +2008,13 @@ public class ScrollView extends Composite {
         /**
          * Convert overview coordinates to global coordinates.
          *
-         * @param loc the control reference
-         * @param x The x coordinate to convert
-         * @param y The y coordinate to convert
-         * @return
+         * @param loc
+         *            the control reference
+         * @param x
+         *            The x coordinate to convert
+         * @param y
+         *            The y coordinate to convert
+         * @return The new converted Point
          */
         protected Point toGlobalCoordinates(Control loc, int x, int y) {
             Point p = new Point(x, y);
This page took 0.027293 seconds and 5 git commands to generate.