Changeset 12301 in josm for trunk/src/org

Timestamp:

2017-06-02T17:23:36+02:00 (7 years ago)

Author:

michael2402

Message:

Add missing javadoc in the org.openstreetmap.josm.gui.dialogs package.

Location:

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

Files:

• DeleteFromRelationConfirmationDialog.java (modified) (5 diffs)
• LatLonDialog.java (modified) (7 diffs)
• LayerListPopup.java (modified) (1 diff)
• OsmIdSelectionDialog.java (modified) (1 diff)
• ValidatorDialog.java (modified) (2 diffs)

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

@@ -183 +183 @@
     /**
      * The table model which manages the list of relation-to-child references
-     *
      */
     public static class RelationMemberTableModel extends DefaultTableModel {
@@ -213 +212 @@
         }
 
+        /**
+         * Sets the data that should be displayed in the list.
+         * @param references A list of references to display
+         */
         public void populate(Collection<RelationToChildReference> references) {
             data.clear();
@@ -222 +225 @@
         }
 
+        /**
+         * Gets the list of children that are currently displayed.
+         * @return The children.
+         */
         public Set<OsmPrimitive> getObjectsToDelete() {
             Set<OsmPrimitive> ret = new HashSet<>();
@@ -230 +237 @@
         }
 
+        /**
+         * Gets the number of elements {@link #getObjectsToDelete()} would return.
+         * @return That number.
+         */
         public int getNumObjectsToDelete() {
             return getObjectsToDelete().size();
         }
 
+        /**
+         * Gets the set of parent relations
+         * @return All parent relations of the references
+         */
         public Set<OsmPrimitive> getParentRelations() {
             Set<OsmPrimitive> ret = new HashSet<>();
@@ -242 +257 @@
         }
 
+        /**
+         * Gets the number of elements {@link #getParentRelations()} would return.
+         * @return That number.
+         */
         public int getNumParentRelations() {
             return getParentRelations().size();

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

@@ -34 +34 @@
 import org.openstreetmap.josm.tools.WindowGeometry;
 
+/**
+ * A dialog that lets the user add a node at the coordinates he enters.
+ */
 public class LatLonDialog extends ExtendedDialog {
     private static final Color BG_COLOR_ERROR = new Color(255, 224, 224);
 
+    /**
+     * The tabs that define the coordinate mode.
+     */
     public JTabbedPane tabs;
     private JosmTextField tfLatLon, tfEastNorth;
@@ -155 +161 @@
     }
 
+    /**
+     * Creates a new {@link LatLonDialog}
+     * @param parent The parent
+     * @param title The title of this dialog
+     * @param help The help text to use
+     */
     public LatLonDialog(Component parent, String title, String help) {
         super(parent, title, tr("Ok"), tr("Cancel"));
@@ -164 +176 @@
     }
 
+    /**
+     * Check if lat/lon mode is active
+     * @return <code>true</code> iff the user selects lat/lon coordinates
+     */
     public boolean isLatLon() {
         return tabs.getModel().getSelectedIndex() == 0;
     }
 
+    /**
+     * Sets the coordinate fields to the given coordinates
+     * @param ll The lat/lon coordinates
+     */
     public void setCoordinates(LatLon ll) {
         LatLon llc = Optional.ofNullable(ll).orElse(LatLon.ZERO);
@@ -180 +200 @@
     }
 
+    /**
+     * Gets the coordinates that are entered by the user.
+     * @return The coordinates
+     */
     public LatLon getCoordinates() {
         if (isLatLon()) {
@@ -189 +213 @@
     }
 
+    /**
+     * Gets the coordinates that are entered in the lat/lon field
+     * @return The lat/lon coordinates
+     */
     public LatLon getLatLonCoordinates() {
         return latLonCoordinates;
     }
 
+    /**
+     * Gets the coordinates that are entered in the east/north field
+     * @return The east/north coordinates
+     */
     public EastNorth getEastNorthCoordinates() {
         return eastNorthCoordinates;
@@ -320 +352 @@
     }
 
+    /**
+     * Parses a east/north coordinate string
+     * @param s The coordinates
+     * @return The east/north coordinates or <code>null</code> on error.
+     */
     public static EastNorth parseEastNorth(String s) {
         String[] en = s.split("[;, ]+");
@@ -332 +369 @@
     }
 
+    /**
+     * Gets the text entered in the lat/lon text field.
+     * @return The text the user entered
+     */
     public String getLatLonText() {
         return tfLatLon.getText();
     }
 
+    /**
+     * Set the text in the lat/lon text field.
+     * @param text The new text
+     */
     public void setLatLonText(String text) {
         tfLatLon.setText(text);
     }
 
+    /**
+     * Gets the text entered in the east/north text field.
+     * @return The text the user entered
+     */
     public String getEastNorthText() {
         return tfEastNorth.getText();
     }
 
+    /**
+     * Set the text in the east/north text field.
+     * @param text The new text
+     */
     public void setEastNorthText(String text) {
         tfEastNorth.setText(text);

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

@@ -32 +32 @@
 public class LayerListPopup extends JPopupMenu {
 
+    /**
+     * An action that displays the layer information.
+     * @see Layer#getInfoComponent()
+     */
     public static final class InfoAction extends AbstractAction {
         private final transient Layer layer;

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

@@ -52 +52 @@
     protected final transient GroupLayout layout = new GroupLayout(panel);
 
+    /**
+     * Creates a new OsmIdSelectionDialog
+     * @param parent       The parent element that will be used for position and maximum size
+     * @param title        The text that will be shown in the window titlebar
+     * @param buttonTexts  String Array of the text that will appear on the buttons. The first button is the default one.
+     */
     public OsmIdSelectionDialog(Component parent, String title, String... buttonTexts) {
         super(parent, title, buttonTexts);
     }
 
+    /**
+     * Creates a new OsmIdSelectionDialog
+     * @param parent The parent element that will be used for position and maximum size
+     * @param title The text that will be shown in the window titlebar
+     * @param buttonTexts String Array of the text that will appear on the buttons. The first button is the default one.
+     * @param modal Set it to {@code true} if you want the dialog to be modal
+     */
     public OsmIdSelectionDialog(Component parent, String title, String[] buttonTexts, boolean modal) {
         super(parent, title, buttonTexts, modal);
     }
 
+    /**
+     * Creates a new OsmIdSelectionDialog
+     * @param parent The parent element that will be used for position and maximum size
+     * @param title The text that will be shown in the window titlebar
+     * @param buttonTexts String Array of the text that will appear on the buttons. The first button is the default one.
+     * @param modal Set it to {@code true} if you want the dialog to be modal
+     * @param disposeOnClose whether to call {@link #dispose} when closing the dialog
+     */
     public OsmIdSelectionDialog(Component parent, String title, String[] buttonTexts, boolean modal, boolean disposeOnClose) {
         super(parent, title, buttonTexts, modal, disposeOnClose);

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

@@ -529 +529 @@
     }
 
+    /**
+     * A visitor that is used to compute the bounds of an error.
+     */
     public static class ValidatorBoundingXYVisitor extends BoundingXYVisitor implements ValidatorVisitor {
         @Override
@@ -560 +563 @@
     }
 
+    /**
+     * Called when the selection was changed to update the list of displayed errors
+     * @param newSelection The new selection
+     */
     public void updateSelection(Collection<? extends OsmPrimitive> newSelection) {
         if (!Main.pref.getBoolean(ValidatorPreference.PREF_FILTER_BY_SELECTION, false))