Changeset 12391 in josm for trunk/src/org/openstreetmap/josm/gui/ScrollViewport.java

Timestamp:

2017-06-11T13:57:28+02:00 (7 years ago)

Author:

michael2402

Message:

See #14794: Documentation for the gui package

File:

• trunk/src/org/openstreetmap/josm/gui/ScrollViewport.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/gui/ScrollViewport.java

@@ -31 +31 @@
     private static final int NO_SCROLL = 0;
 
+    /**
+     * Direction flag for upwards
+     */
     public static final int UP_DIRECTION = 1;
+    /**
+     * Direction flag for downwards
+     */
     public static final int DOWN_DIRECTION = 2;
+    /**
+     * Direction flag for left
+     */
     public static final int LEFT_DIRECTION = 4;
+    /**
+     * Direction flag for right
+     */
     public static final int RIGHT_DIRECTION = 8;
     /**
@@ -240 +252 @@
     }
 
+    /**
+     * Gets the current visible part of the view
+     * @return The current view rect
+     */
     public Rectangle getViewRect() {
         return vp.getViewRect();
     }
 
+    /**
+     * Gets the size of the view
+     * @return The size
+     */
     public Dimension getViewSize() {
         return vp.getViewSize();
     }
 
+    /**
+     * Gets the position (offset) of the view area
+     * @return The offset
+     */
     public Point getViewPosition() {
         return vp.getViewPosition();