Changeset 6074 in josm

Timestamp:

2013-07-19T02:08:27+02:00 (11 years ago)

Author:

Don-vip

Message:

code cleanup in TaggingPreset* classes

Location:

trunk/src/org/openstreetmap/josm/gui/tagging

Files:

• TaggingPreset.java (modified) (4 diffs)
• TaggingPresetItem.java (modified) (3 diffs)
• TaggingPresetItems.java (modified) (1 diff)
• TaggingPresetMenu.java (modified) (7 diffs)
• TaggingPresetReader.java (modified) (4 diffs)
• TaggingPresetSearchAction.java (modified) (2 diffs)
• TaggingPresetSearchDialog.java (modified) (3 diffs)
• TaggingPresetSelector.java (modified) (1 diff)
• TaggingPresetSeparator.java (modified) (1 diff)
• TaggingPresetType.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPreset.java

@@ -1 @@
-// License: GPL. Copyright 2007 by Immanuel Scholz and others
+// License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.gui.tagging;
 
@@ -56 +56 @@
 import org.xml.sax.SAXException;
 
-
 /**
  * This class read encapsulate one tagging preset. A class method can
@@ -63 +62 @@
  *
  * It is also able to construct dialogs out of preset definitions.
+ * @since 294
  */
 public class TaggingPreset extends AbstractAction implements MapView.LayerChangeListener {
@@ -74 +74 @@
     public String name_context;
     public String locale_name;
-   public final static String OPTIONAL_TOOLTIP_TEXT = "Optional tooltip text";
+    public final static String OPTIONAL_TOOLTIP_TEXT = "Optional tooltip text";
 
     /**

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetItem.java

@@ -1 @@
-// License: GPL. Copyright 2007 by Immanuel Scholz and others
+// License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.gui.tagging;
 
@@ -14 +14 @@
 
 /**
- * This calss reperesentse single part of a preset - one field or text label that
- * is shown to user
+ * Class that represents single part of a preset - one field or text label that is shown to user
+ * @since 6068
  */
 public abstract class TaggingPresetItem {
@@ -47 +47 @@
         return null;
     }
-
 }

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetItems.java

@@ -57 +57 @@
 import static org.openstreetmap.josm.tools.I18n.trc;
 
-
 /**
- * Class that constains all subtypes of TaggingPresetItem,
- * static supplementary data, types and methods
+ * Class that contains all subtypes of TaggingPresetItem, static supplementary data, types and methods
+ * @since 6068
  */
 public final class TaggingPresetItems {

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetMenu.java

@@ -1 @@
-// License: GPL. Copyright 2007 by Immanuel Scholz and others
+// License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.gui.tagging;
 
@@ -22 +22 @@
 public class TaggingPresetMenu extends TaggingPreset {
     public JMenu menu = null; // set by TaggingPresetPreferences
+    
     @Override
     public void setDisplayName() {
@@ -31 +32 @@
         putValue("toolbar", "tagginggroup_" + getRawName());
     }
+    
     @Override
     public void setIcon(String iconName) {
@@ -60 +62 @@
     public void actionPerformed(ActionEvent e) {
         Object s = e.getSource();
-        if(menu != null && s instanceof Component)
-        {
-            Component co = (Component)s;
-
+        if (menu != null && s instanceof Component) {
             JPopupMenu pm = new JPopupMenu(getName());
             for (Component c : menu.getMenuComponents()) {
@@ -72 +71 @@
         }
     }
+    
     /**
      * Sorts the menu items using the translated item text
@@ -99 +99 @@
                     for (JMenuItem menuItem : sortarray) {
                         int oldPos;
-                        if(lastSeparator == 0){
+                        if (lastSeparator == 0){
                             oldPos=pos;
-                        }else {
+                        } else {
                             oldPos = pos+lastSeparator+1;
                         }
@@ -110 +110 @@
                     lastSeparator = 0;
                 }
-            }else if (item instanceof JSeparator){
+            } else if (item instanceof JSeparator){
                 Collections.sort(sortarray, comp);
                 int pos = 0;

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetReader.java

@@ +1 @@
+// License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.gui.tagging;
 
@@ -23 +24 @@
 import static org.openstreetmap.josm.tools.I18n.tr;
 
-
+/**
+ * The tagging presets reader.
+ * @since 6068
+ */
 public final class TaggingPresetReader {
 
+    /**
+     * Constructs a new {@code TaggingPresetReader}.
+     */
     public TaggingPresetReader() {
     }
@@ -40 +47 @@
         return sources;
     }
-
     
     public static List<TaggingPreset> readAll(Reader in, boolean validate) throws SAXException {
@@ -70 +76 @@
             parser.start(in);
         }
-        while(parser.hasNext()) {
+        while (parser.hasNext()) {
             Object o = parser.next();
             if (o instanceof TaggingPresetMenu) {
                 TaggingPresetMenu tp = (TaggingPresetMenu) o;
-                if(tp == lastmenu) {
+                if (tp == lastmenu) {
                     lastmenu = tp.group;
-                } else
-                {
+                } else {
                     tp.group = lastmenu;
                     tp.setDisplayName();
                     lastmenu = tp;
                     all.add(tp);
-
                 }
                 lastrole = null;

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetSearchAction.java

@@ -11 +11 @@
 import org.openstreetmap.josm.tools.Shortcut;
 
+/**
+ * The tagging presets search action (F3).
+ * @since 3388
+ */
 public class TaggingPresetSearchAction extends JosmAction {
 
+    /**
+     * Constructs a new {@code TaggingPresetSearchAction}.
+     */
     public TaggingPresetSearchAction() {
         super(tr("Search preset"), "dialogs/search", tr("Show preset search dialog"),
@@ -26 +33 @@
             return;
 
-        TaggingPresetSearchDialog dialog = TaggingPresetSearchDialog.getInstance();
-        dialog.showDialog();
+        TaggingPresetSearchDialog.getInstance().showDialog();
     }
-
 }

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetSearchDialog.java

@@ -11 +11 @@
 import org.openstreetmap.josm.gui.ExtendedDialog;
 
-
+/**
+ * The tagging presets search dialog (F3).
+ * @since 3388
+ */
 public class TaggingPresetSearchDialog extends ExtendedDialog {
 
@@ -17 +20 @@
 
     private static TaggingPresetSearchDialog instance;
+    
+    /**
+     * Returns the unique instance of {@code TaggingPresetSearchDialog}.
+     * @return the unique instance of {@code TaggingPresetSearchDialog}.
+     */
     public static TaggingPresetSearchDialog getInstance() {
         if (instance == null) {
@@ -23 +31 @@
         return instance;
     }
+    
     private TaggingPresetSearchDialog() {
         super(Main.parent, tr("Presets"), new String[] {tr("Select"), tr("Cancel")});

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetSelector.java

@@ -1 @@
-/*
- * To change this template, choose Tools | Templates
- * and open the template in the editor.
- */
+// License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.gui.tagging;
 

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetSeparator.java

@@ -1 @@
-// License: GPL. Copyright 2007 by Immanuel Scholz and others
+// License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.gui.tagging;
 

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetType.java

@@ -7 +7 @@
 /**
  * Enumeration of OSM primitive types associated with names and icons
+ * @since 6068
  */
 public enum TaggingPresetType {