Changes between Version 46 and Version 47 of DevelopersGuide/DevelopingPlugins
- Timestamp:
- 2010-10-12T18:38:27+02:00 (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DevelopersGuide/DevelopingPlugins
v46 v47 102 102 ||Main.parent||This is the parent of all GUI elements. Use this as first parameter to JOptionPane.show* if you want to popup a message|| 103 103 ||Main.pref|| This is the global preferences file, loaded from {{{${josm.home}/preferences}}}. Use {{{Main.pref.get(...)}}} and {{{Main.pref.put(...)}}} to access the preferences. They will be saved immediately after a put, so don't put anything you dont want to have there. Please, prefix custom plugin preferences with your plugin name. || 104 || Main.proj||This is the current [source:/trunk/src/org/openstreetmap/josm/data/projection/Projection.java Projection] used in JOSM. If you want to translate between Lat/Lon and East/North, use {{{Main.proj.latlon2eastnorth}}} and {{{Main.proj.eastnorth2latlon}}}.||104 ||Main.proj||This is the current [source:/trunk/src/org/openstreetmap/josm/data/projection/Projection.java Projection] used in JOSM. If you want to translate between Lat/Lon and East/North, use {{{Main.proj.latlon2eastnorth}}} and {{{Main.proj.eastnorth2latlon}}}.|| 105 105 ||Main.map.mapView||This is the main UI component in JOSM. It provides the the view with the rendered layers. You usually access this to call methods like {{{getCenter()}}}, {{{getScale()}}} or {{{zoomTo()}}}. '''Beware''': {{{Main.map}}} can be null when no layers are created yet.|| 106 106 … … 141 141 You have to put some information into the manifest file of your jar. If you use ant, you can set these values within the {{{build.xml}}} file. 142 142 143 ||'''Plugin-Mainversion'''||required|| 143 ||'''Plugin-Mainversion'''||required||The lowest JOSM version required by this plugin.|| 144 144 ||'''Plugin-Version'''||required||The plugin version, for most plugins this is the SVN revision of the plugin SVN repository the plugin was built against|| 145 145 ||'''Plugin-Class'''||required||Points to the main class of the plugin|| 146 146 ||'''Plugin-Description'''||required||Gives the description of the plugin visible in the preferences page. For line breaks, you have to use {{{<br>}}}, ''not'' {{{<br/>}}}|| 147 ||'''Author'''||optional|| 147 ||'''Author'''||optional||The name and or email address of the author of this plugin. This is used in the error report window, if an error is detected within the plugin code.|| 148 148 ||'''Plugin-Date'''||optional||The creation date of the plugin in ISO format.|| 149 149 ||'''Plugin-Early'''||optional||Can be set to {{{true}}}, in which case the plugin is loaded as early as possible, more specific before the GUI classes are loaded. This is usefull if your plugin alters the GUI or the JOSM-startup process in any way.|| … … 154 154 ||'''Class-Path'''||optional||An space-seperated list of additional classpaths your plugin wants to use when looking for ressources and classes. The plugin itself is added automatically. Don't forget to provide the additional jar's as well, if you add dependencies here. Note that all loaded plugins are in the class-path automatically, so don't specify plugin-dependencies here.|| 155 155 ||'''<xxx>_Plugin-Url'''||optional||To support older JOSM version special entries may be added to supply older versions. This information is used by the internal plugin handler to select only matching version when updating. The entries are made like this ''<josm_version>_Plugin-Url: <plugin_version>;<url>''|| 156 || 156 ||'''<lang>_Plugin-Description'''||optional||The translated description text for the plugin. E.g. ''de_Plugin-Description'' contains the German translation.|| 157 157 158 158 For SVN managed plugins, the links to old versions and the translated descriptions are automatically added to the [http://josm.openstreetmap.de/plugin plugin information], so JOSM can use that when it displays the list of plugins in the preference dialog.
