Changeset 6814 in josm for trunk/src/org/openstreetmap/josm/actions

Timestamp:

2014-02-05T23:22:04+01:00 (10 years ago)

Author:

Don-vip

Message:

fix #8234 - remove duplicated/unused icons + javadoc

Location:

trunk/src/org/openstreetmap/josm/actions

Files:

• AlignInCircleAction.java (modified) (4 diffs)
• CreateCircleAction.java (modified) (3 diffs)
• DownloadReferrersAction.java (modified) (5 diffs)
• JoinNodeWayAction.java (modified) (2 diffs)
• JosmAction.java (modified) (3 diffs)
• UpdateModifiedAction.java (modified) (1 diff)
• UpdateSelectionAction.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/actions/AlignInCircleAction.java

@@ -32 +32 @@
  * Aligns all selected nodes within a circle. (Useful for roundabouts)
  *
+ * @since 146
+ *
  * @author Matthew Newton
  * @author Petr Dlouhý
@@ -48 +50 @@
     }
 
-    public double distance(EastNorth n, EastNorth m) {
+    private static double distance(EastNorth n, EastNorth m) {
         double easd, nord;
         easd = n.east() - m.east();
@@ -55 +57 @@
     }
 
-    public class PolarCoor {
+    public static class PolarCoor {
         double radius;
         double angle;
@@ -250 +252 @@
      * @return true if all nodes in the given collection are referred by the same object, and no other one (see #8431)
      */
-    protected boolean allowRegularPolygon(Collection<Node> nodes) {
+    protected static boolean allowRegularPolygon(Collection<Node> nodes) {
         Set<OsmPrimitive> allReferrers = new HashSet<OsmPrimitive>();
         for (Node n : nodes) {

trunk/src/org/openstreetmap/josm/actions/CreateCircleAction.java

@@ -38 +38 @@
  * BTW: Someone might want to implement projection corrections for this...
  *
+ * @since 996
+ *
  * @author Henry Loenwind, based on much copy&Paste from other Actions.
  * @author Sebastian Masch
@@ -47 +49 @@
      */
     public CreateCircleAction() {
-        super(tr("Create Circle"), "createcircle", tr("Create a circle from three selected nodes."),
+        super(tr("Create Circle"), "aligncircle", tr("Create a circle from three selected nodes."),
             Shortcut.registerShortcut("tools:createcircle", tr("Tool: {0}", tr("Create Circle")),
-            KeyEvent.VK_O, Shortcut.SHIFT), true);
+            KeyEvent.VK_O, Shortcut.SHIFT), true, "createcircle", true);
         putValue("help", ht("/Action/CreateCircle"));
     }
@@ -276 +278 @@
         Main.map.repaint();
     }
-    
+
     private static void notifyNodesNotOnCircle() {
         new Notification(

trunk/src/org/openstreetmap/josm/actions/DownloadReferrersAction.java

@@ -20 +20 @@
 
 /**
- * This action loads the set of primitives referring to the current selection from the OSM
- * server.
- *
+ * This action loads the set of primitives referring to the current selection from the OSM server.
+ * @since 1810
  */
-public class DownloadReferrersAction extends JosmAction{
+public class DownloadReferrersAction extends JosmAction {
 
+        /**
+         * Constructs a new {@code DownloadReferrersAction}.
+         */
     public DownloadReferrersAction() {
-        super(tr("Download parent ways/relations..."), "downloadreferrers", tr("Download objects referring to one of the selected objects"),
-                Shortcut.registerShortcut("file:downloadreferrers", tr("File: {0}", tr("Download parent ways/relations...")), KeyEvent.VK_D, Shortcut.ALT_CTRL), true);
+        super(tr("Download parent ways/relations..."), "download",
+                        tr("Download objects referring to one of the selected objects"),
+                Shortcut.registerShortcut("file:downloadreferrers",
+                                tr("File: {0}", tr("Download parent ways/relations...")), KeyEvent.VK_D, Shortcut.ALT_CTRL),
+                true, "downloadreferrers", true);
         putValue("help", ht("/Action/DownloadParentWaysAndRelation"));
     }
@@ -41 +46 @@
      * @exception IllegalArgumentException thrown if targetLayer is null
      */
-    static public void downloadReferrers(OsmDataLayer targetLayer, Collection<OsmPrimitive> children) throws IllegalArgumentException {
+    public static void downloadReferrers(OsmDataLayer targetLayer, Collection<OsmPrimitive> children) throws IllegalArgumentException {
         if (children == null || children.isEmpty()) return;
         Main.worker.submit(new DownloadReferrersTask(targetLayer, children));
@@ -55 +60 @@
      * @exception IllegalArgumentException thrown if targetLayer is null
      */
-    static public void downloadReferrers(OsmDataLayer targetLayer, Map<Long, OsmPrimitiveType> children) throws IllegalArgumentException {
+    public static void downloadReferrers(OsmDataLayer targetLayer, Map<Long, OsmPrimitiveType> children) throws IllegalArgumentException {
         if (children == null || children.isEmpty()) return;
         Main.worker.submit(new DownloadReferrersTask(targetLayer, children));
@@ -64 +69 @@
      * <code>type</code>.
      *
-     *
      * @param targetLayer  the target layer. Must not be null.
      * @param id the primitive id. id > 0 required.
@@ -72 +76 @@
      * @exception IllegalArgumentException thrown if type == null
      */
-    static public void downloadReferrers(OsmDataLayer targetLayer, long id, OsmPrimitiveType type) throws IllegalArgumentException {
+    public static void downloadReferrers(OsmDataLayer targetLayer, long id, OsmPrimitiveType type) throws IllegalArgumentException {
         if (id <= 0)
             throw new IllegalArgumentException(MessageFormat.format("Id > 0 required, got {0}", id));

trunk/src/org/openstreetmap/josm/actions/JoinNodeWayAction.java

@@ -27 +27 @@
 
 public class JoinNodeWayAction extends JosmAction {
+
+    /**
+     * Constructs a new {@code JoinNodeWayAction}.
+     */
     public JoinNodeWayAction() {
         super(tr("Join Node to Way"), "joinnodeway", tr("Include a node into the nearest way segments"),
@@ -53 +57 @@
             HashMap<Way, List<Integer>> insertPoints = new HashMap<Way, List<Integer>>();
             for (WaySegment ws : wss) {
-                // Maybe cleaner to pass a "isSelected" predicate to getNearestWaySegements, but this is atm. less invasive.
+                // Maybe cleaner to pass a "isSelected" predicate to getNearestWaySegments, but this is less invasive.
                 if(restrictToSelectedWays && !ws.way.isSelected()) {
                     continue;

trunk/src/org/openstreetmap/josm/actions/JosmAction.java

@@ -44 +44 @@
     private SelectionChangeAdapter selectionChangeAdapter;
 
+    /**
+     * Returns the shortcut for this action.
+     * @return the shortcut for this action, or "No shortcut" if none is defined
+     */
     public Shortcut getShortcut() {
         if (sc == null) {
@@ -110 +114 @@
     }
 
+    /**
+     * Constructs a new {@code JosmAction}.
+     *
+     * Use this super constructor to setup your action.
+     *
+     * @param name the action's text as displayed on the menu (if it is added to a menu)
+     * @param iconName the filename of the icon to use
+     * @param tooltip  a longer description of the action that will be displayed in the tooltip. Please note
+     *           that html is not supported for menu actions on some platforms.
+     * @param shortcut a ready-created shortcut object or null if you don't want a shortcut. But you always
+     *            do want a shortcut, remember you can always register it with group=none, so you
+     *            won't be assigned a shortcut unless the user configures one. If you pass null here,
+     *            the user CANNOT configure a shortcut for your action.
+     * @param registerInToolbar register this action for the toolbar preferences?
+     * @param installAdapters false, if you don't want to install layer changed and selection changed adapters
+     */
     public JosmAction(String name, String iconName, String tooltip, Shortcut shortcut, boolean registerInToolbar, boolean installAdapters) {
         this(name, iconName, tooltip, shortcut, registerInToolbar, null, installAdapters);
     }
 
+    /**
+     * Constructs a new {@code JosmAction}.
+     *
+     * Use this super constructor to setup your action.
+     *
+     * @param name the action's text as displayed on the menu (if it is added to a menu)
+     * @param iconName the filename of the icon to use
+     * @param tooltip  a longer description of the action that will be displayed in the tooltip. Please note
+     *           that html is not supported for menu actions on some platforms.
+     * @param shortcut a ready-created shortcut object or null if you don't want a shortcut. But you always
+     *            do want a shortcut, remember you can always register it with group=none, so you
+     *            won't be assigned a shortcut unless the user configures one. If you pass null here,
+     *            the user CANNOT configure a shortcut for your action.
+     * @param registerInToolbar register this action for the toolbar preferences?
+     */
     public JosmAction(String name, String iconName, String tooltip, Shortcut shortcut, boolean registerInToolbar) {
         this(name, iconName, tooltip, shortcut, registerInToolbar, null, true);
     }
 
+    /**
+     * Constructs a new {@code JosmAction}.
+     */
     public JosmAction() {
         this(true);
     }
 
+    /**
+     * Constructs a new {@code JosmAction}.
+     *
+     * @param installAdapters false, if you don't want to install layer changed and selection changed adapters
+     */
     public JosmAction(boolean installAdapters) {
         setHelpId();
@@ -146 +189 @@
     }
 
+    /**
+     * Sets the tooltip text of this action.
+     * @param tooltip The text to display in tooltip. Can be {@code null}
+     */
     public void setTooltip(String tooltip) {
         if (tooltip != null) {

trunk/src/org/openstreetmap/josm/actions/UpdateModifiedAction.java

@@ -14 +14 @@
 /**
  * This action synchronizes a set of primitives with their state on the server.
- *
+ * @since 2682
  */
 public class UpdateModifiedAction extends UpdateSelectionAction {
 
     /**
-     * constructor
+     * Constructs a new {@code UpdateModifiedAction}.
      */
     public UpdateModifiedAction() {
-        super(tr("Update modified"),
-                "updatemodified",
+        super(tr("Update modified"), "updatedata",
                 tr("Updates the currently modified objects from the server (re-downloads data)"),
                 Shortcut.registerShortcut("file:updatemodified",
                         tr("File: {0}", tr("Update modified")), KeyEvent.VK_M,
                         Shortcut.ALT_CTRL),
-                        true);
+                        true, "updatemodified");
         putValue("help", ht("/Action/UpdateModified"));
     }

trunk/src/org/openstreetmap/josm/actions/UpdateSelectionAction.java

@@ -26 +26 @@
 /**
  * This action synchronizes a set of primitives with their state on the server.
- *
+ * @since 1670
  */
 public class UpdateSelectionAction extends JosmAction {
@@ -34 +34 @@
      *
      * @param id the primitive id
+     * @param type The primitive type. Must be one of {@link OsmPrimitiveType#NODE NODE}, {@link OsmPrimitiveType#WAY WAY}, {@link OsmPrimitiveType#RELATION RELATION}
      */
     public static void handlePrimitiveGoneException(long id, OsmPrimitiveType type) {
         MultiFetchServerObjectReader reader = new MultiFetchServerObjectReader();
-        reader.append(getCurrentDataSet(),id, type);
+        reader.append(getCurrentDataSet(), id, type);
         try {
             DataSet ds = reader.parseOsm(NullProgressMonitor.INSTANCE);
@@ -80 +81 @@
 
     /**
-     * constructor
+     * Constructs a new {@code UpdateSelectionAction}.
      */
     public UpdateSelectionAction() {
-        super(tr("Update selection"),
-                "updateselection",
+        super(tr("Update selection"), "updatedata",
                 tr("Updates the currently selected objects from the server (re-downloads data)"),
                 Shortcut.registerShortcut("file:updateselection",
                         tr("File: {0}", tr("Update selection")), KeyEvent.VK_U,
                         Shortcut.ALT_CTRL),
-                true);
+                true, "updateselection", true);
         putValue("help", ht("/Action/UpdateSelection"));
     }
-    public UpdateSelectionAction(String name, String iconName, String tooltip,
-            Shortcut shortcut, boolean register) {
-        super(name, iconName, tooltip, shortcut, register);
+
+    /**
+     * Constructs a new {@code UpdateSelectionAction}.
+     *
+     * @param name the action's text as displayed on the menu (if it is added to a menu)
+     * @param iconName the filename of the icon to use
+     * @param tooltip  a longer description of the action that will be displayed in the tooltip. Please note
+     *           that html is not supported for menu actions on some platforms.
+     * @param shortcut a ready-created shortcut object or null if you don't want a shortcut. But you always
+     *            do want a shortcut, remember you can always register it with group=none, so you
+     *            won't be assigned a shortcut unless the user configures one. If you pass null here,
+     *            the user CANNOT configure a shortcut for your action.
+     * @param register register this action for the toolbar preferences?
+     * @param toolbarId identifier for the toolbar preferences. The iconName is used, if this parameter is null
+     */
+    public UpdateSelectionAction(String name, String iconName, String tooltip, Shortcut shortcut, boolean register, String toolbarId) {
+        super(name, iconName, tooltip, shortcut, register, toolbarId, true);
     }
 
@@ -111 +125 @@
     }
 
-    /**
-     * action handler
-     */
     @Override
     public void actionPerformed(ActionEvent e) {
         if (! isEnabled())
             return;
-        Collection<OsmPrimitive> toUpdate =getData();
+        Collection<OsmPrimitive> toUpdate = getData();
         if (toUpdate.isEmpty()) {
             JOptionPane.showMessageDialog(
@@ -131 +142 @@
     }
 
+    /**
+     * Returns the data on which this action operates. Override if needed.
+     * @return the data on which this action operates
+     */
     public Collection<OsmPrimitive> getData() {
         return getCurrentDataSet().getAllSelected();