Changeset 3574 in osm for applications/editors/josm/plugins/ywms/src

Timestamp:

2007-07-12T21:15:19+02:00 (17 years ago)

Author:

frsantos

Message:

Javadoc
Imported class Util from validator plugin

Location:

applications/editors/josm/plugins/ywms/src/org/openstreetmap/josm/plugins/ywms

Files:

• ImageLoader.java (modified) (4 diffs)
• YWMSPlugin.java (modified) (4 diffs)
• YWMSPreferenceSetting.java (modified) (7 diffs)

applications/editors/josm/plugins/ywms/src/org/openstreetmap/josm/plugins/ywms/ImageLoader.java

@@ -51 +51 @@
         public static final String GECKO_DEBUG_LINE = "GECKO: PAINT FORCED AFTER ONLOAD:";
 
+        /** THe yahoo URL request */
         private URL yahooUrl;
+        /** Original bounding box */
         double[] orig_bbox = null;
+        /** Original width */
     int width = -1;
+        /** Original height */
     int height = -1;
+        /** Final image width */
     int final_width = -1;
+        /** Final image width */
     int final_height = -1;
+    /** The loaded image */
         Image image;
+        /** Files created by firefox, that can be deleted */
         List<String> firefoxFiles = new ArrayList<String>();
 
@@ -67 +75 @@
          * 
          * @param wmsUrl The WMS request
-         * @param pluginDir The directory of the plugin
          * @throws ImageLoaderException When error loading the image
          */
@@ -76 +83 @@
                         URL request = new URL("file:///page" + wmsUrl);
                         String query = request.getQuery().toLowerCase();
-                        yahooUrl = new File(YWMSPlugin.getStaticPluginDir(), "ymap.html").toURI().toURL();
+                        yahooUrl = new File(Util.getPluginDir(), "ymap.html").toURI().toURL();
                         yahooUrl = new URL( yahooUrl.toExternalForm() + "?" + query);
                         
@@ -260 +267 @@
          * Saves the current image as a PNG file
          * @param fileName The name of the new file 
-         * @throws IOException When error saving the file
          */
         public void save(String fileName)

applications/editors/josm/plugins/ywms/src/org/openstreetmap/josm/plugins/ywms/YWMSPlugin.java

@@ -6 +6 @@
 import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
 import org.openstreetmap.josm.plugins.Plugin;
-import org.openstreetmap.josm.plugins.PluginProxy;
 
 /**
@@ -77 +76 @@
 public class YWMSPlugin extends Plugin 
 {
+        /** The HTTP server this plugin launches */
         static HTTPServer server;
     
@@ -84 +84 @@
         public YWMSPlugin()
         {
-        WARNING. This compilation error is made on purpose. 
-        We are not allowed to use this plugin at present.
-        Please, don not use it until all legal issues are resolved.
-        
                 try
                 {
@@ -136 +132 @@
                 }
         }
-        
-    /** 
-     * Returns the plugin's directory
-     * <p>
-     * Utility method for classes that can't acces the plugin object
-     * 
-     * @return The directory of the plugin
-     */
-    public static String getStaticPluginDir()
-    {
-        YWMSPlugin plugin = getPlugin();
-        return ( plugin != null ) ? plugin.getPluginDir() : null;
-    }
-
-    /**
-     * Utility method to retrieve the plugin for classes that can't access to the plugin object directly.
-     * 
-     * @return The YWMS plugin
-     */
-    public static YWMSPlugin getPlugin()
-    {
-        for (PluginProxy plugin : Main.plugins)
-        {
-            if( plugin.info.className.equals(YWMSPlugin.class.getName()) )
-            {
-                return (YWMSPlugin)plugin.plugin;
-            }
-        }
-        
-        return null;
-    }
 }

applications/editors/josm/plugins/ywms/src/org/openstreetmap/josm/plugins/ywms/YWMSPreferenceSetting.java

@@ -14 +14 @@
 import org.openstreetmap.josm.gui.preferences.PreferenceDialog;
 import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
+import org.openstreetmap.josm.plugins.ywms.Util.Version;
 import org.openstreetmap.josm.tools.GBC;
 import org.openstreetmap.josm.tools.I18n;
@@ -29 +30 @@
     public static final String WMS_URL_PARAMS = "/ymap?request=GetMap&format=image/jpeg";
 
+    /** Firefox path text field */
     private JTextField firefox = new JTextField(10);
+    /** Server port text field */
     private JTextField port    = new JTextField(10);
+    /** Firefox profile text field */
     private JTextField profile = new JTextField(10);
     
@@ -46 +50 @@
                                                          ));
 
-        JPanel ywms = gui.createPreferenceTab("yahoo.gif", I18n.tr("Yahoo! WMS server"), I18n.tr("Settings for the Yahoo! imagery server."));
+                Version ver = Util.getVersion();
+                String description = tr("A WMS server for Yahoo imagery based on Firefox.");
+                if( ver != null )
+                        description += "<br><br>" + tr("Version: {0}<br>Last change at {1}", ver.revision, ver.time);
+        JPanel ywms = gui.createPreferenceTab("yahoo.gif", I18n.tr("Yahoo! WMS server"), description + I18n.tr("Settings for the Yahoo! imagery server."));
         ywms.add(new JLabel(tr("YWMS options")), GBC.eol().insets(0,5,0,0));
 
@@ -79 +87 @@
         if( !oldPort.equals(port.getText()) )
         {
-            YWMSPlugin plugin = YWMSPlugin.getPlugin();
+            YWMSPlugin plugin = (YWMSPlugin)Util.getPlugin(YWMSPlugin.class);
             plugin.restartServer();
         }
@@ -90 +98 @@
     private final class WMSConfigurationActionListener implements ActionListener, FocusListener
     {
+        /** If the action is already handled */
         boolean alreadyHandled = false;
         public void actionPerformed(ActionEvent e) 
@@ -145 +154 @@
                         }
                         
-                        String configFile = new File(YWMSPlugin.getStaticPluginDir(), "config.html").toURL().toString(); 
+                        String configFile = new File(Util.getPluginDir(), "config.html").toURL().toString(); 
                         GeckoSupport.browse(firefox.getText(), profile.getText(), configFile, false);
                         configureWMSPluginPreferences();
@@ -171 +180 @@
     /**
      * Configures WMSPlugin preferences with a server "Yahoo" pointing to YWMS  
-     * @param gui 
      */
     private void configureWMSPluginPreferences()