Changeset 12298 in josm for trunk/src/org

Timestamp:

2017-06-02T15:41:37+02:00 (8 years ago)

Author:

michael2402

Message:

Rename one character variables in filter dialog, add javadoc.

Location:

trunk/src/org/openstreetmap/josm/gui/dialogs

Files:

• FilterDialog.java (modified) (3 diffs)
• FilterTableModel.java (modified) (8 diffs)

trunk/src/org/openstreetmap/josm/gui/dialogs/FilterDialog.java

@@ -57 +57 @@
 
 /**
+ * The filter dialog displays a list of filters that are active on the current edit layer.
  *
  * @author Petr_Dlouhý
@@ -296 +297 @@
     }
 
+    /**
+     * Updates the headline of this dialog to display the number of active filters.
+     */
     public void updateDialogHeader() {
         SwingUtilities.invokeLater(() -> setTitle(
@@ -301 +305 @@
     }
 
+    /**
+     * Draws a text on the map display that indicates that filters are active.
+     * @param g The graphics to draw that text on.
+     */
     public void drawOSDText(Graphics2D g) {
         filterModel.drawOSDText(g);

trunk/src/org/openstreetmap/josm/gui/dialogs/FilterTableModel.java

@@ -33 +33 @@
 
 /**
+ * The model that is used for the table in the {@link FilterDialog}.
  *
  * @author Petr_Dlouhý
@@ -38 +39 @@
 public class FilterTableModel extends AbstractTableModel {
 
+    /**
+     * The filter enabled column
+     */
     public static final int COL_ENABLED = 0;
+    /**
+     * The column indicating if the filter is hiding.
+     */
     public static final int COL_HIDING = 1;
+    /**
+     * The column that displays the filter text
+     */
     public static final int COL_TEXT = 2;
+    /**
+     * The column to invert the filter
+     */
     public static final int COL_INVERTED = 3;
 
-    // number of primitives that are disabled but not hidden
+    /**
+     * number of primitives that are disabled but not hidden
+     */
     public int disabledCount;
-    // number of primitives that are disabled and hidden
+    /**
+     * number of primitives that are disabled and hidden
+     */
     public int disabledAndHiddenCount;
 
@@ -79 +96 @@
     }
 
+    /**
+     * Runs the filters on the current edit data set.
+     */
     public void executeFilters() {
         DataSet ds = Main.getLayerManager().getEditDataSet();
@@ -126 +146 @@
     }
 
+    /**
+     * Runs the filter on a list of primitives that are part of the edit data set.
+     * @param primitives The primitives
+     */
     public void executeFilters(Collection<? extends OsmPrimitive> primitives) {
         DataSet ds = Main.getLayerManager().getEditDataSet();
@@ -179 +203 @@
     }
 
+    /**
+     * Clears all filtered flags from all primitives in the dataset
+     */
     public void clearFilterFlags() {
         DataSet ds = Main.getLayerManager().getEditDataSet();
@@ -206 +233 @@
     }
 
-    public void addFilter(Filter f) {
-        filters.add(f);
+    /**
+     * Adds a new filter to the filter list.
+     * @param filter The new filter
+     */
+    public void addFilter(Filter filter) {
+        filters.add(filter);
         savePrefs();
         updateFilters();
@@ -213 +244 @@
     }
 
-    public void moveDownFilter(int i) {
-        if (i >= filters.size() - 1)
+    /**
+     * Moves down the filter in the given row.
+     * @param rowIndex The filter row
+     */
+    public void moveDownFilter(int rowIndex) {
+        if (rowIndex >= filters.size() - 1)
             return;
-        filters.add(i + 1, filters.remove(i));
+        filters.add(rowIndex + 1, filters.remove(rowIndex));
         savePrefs();
         updateFilters();
-        fireTableRowsUpdated(i, i + 1);
-    }
-
-    public void moveUpFilter(int i) {
-        if (i == 0)
+        fireTableRowsUpdated(rowIndex, rowIndex + 1);
+    }
+
+    /**
+     * Moves up the filter in the given row
+     * @param rowIndex The filter row
+     */
+    public void moveUpFilter(int rowIndex) {
+        if (rowIndex == 0)
             return;
-        filters.add(i - 1, filters.remove(i));
+        filters.add(rowIndex - 1, filters.remove(rowIndex));
         savePrefs();
         updateFilters();
-        fireTableRowsUpdated(i - 1, i);
-    }
-
-    public void removeFilter(int i) {
-        filters.remove(i);
+        fireTableRowsUpdated(rowIndex - 1, rowIndex);
+    }
+
+    /**
+     * Removes the filter that is displayed in the given row
+     * @param rowIndex
+     */
+    public void removeFilter(int rowIndex) {
+        filters.remove(rowIndex);
         savePrefs();
         updateFilters();
-        fireTableRowsDeleted(i, i);
-    }
-
-    public void setFilter(int i, Filter f) {
-        filters.set(i, f);
+        fireTableRowsDeleted(rowIndex, rowIndex);
+    }
+
+    /**
+     * Sets/replaces the filter for a given row.
+     * @param rowIndex The row index
+     * @param filter The filter that should be placed in that row
+     */
+    public void setFilter(int rowIndex, Filter filter) {
+        filters.set(rowIndex, filter);
         savePrefs();
         updateFilters();
-        fireTableRowsUpdated(i, i);
-    }
-
-    public Filter getFilter(int i) {
-        return filters.get(i);
+        fireTableRowsUpdated(rowIndex, rowIndex);
+    }
+
+    /**
+     * Gets the filter by row index
+     * @param rowIndex The row index
+     * @return The filter in that row
+     */
+    public Filter getFilter(int rowIndex) {
+        return filters.get(rowIndex);
     }
 
@@ -382 +435 @@
     private final OSDLabel lblOSD = new OSDLabel("");
 
+    /**
+     * Draws a text on the map display that indicates that filters are active.
+     * @param g The graphics to draw that text on.
+     */
     public void drawOSDText(Graphics2D g) {
         String message = "<html>" + tr("<h2>Filter active</h2>");