[Mapbender-commits] r4124 - in trunk/mapbender: http/javascripts lib

[svn_mapbender at osgeo.org]

Author: christoph
Date: 2009-06-24 11:17:05 -0400 (Wed, 24 Jun 2009)
New Revision: 4124

Modified:
   trunk/mapbender/http/javascripts/core.php
   trunk/mapbender/http/javascripts/map_obj.js
   trunk/mapbender/http/javascripts/mod_reload.php
   trunk/mapbender/lib/event.js
Log:
API

Modified: trunk/mapbender/http/javascripts/core.php
===================================================================
--- trunk/mapbender/http/javascripts/core.php	2009-06-24 15:16:04 UTC (rev 4123)
+++ trunk/mapbender/http/javascripts/core.php	2009-06-24 15:17:05 UTC (rev 4124)
@@ -27,7 +27,9 @@
  * 
  */
  var Mapbender = {
- 	events: {},
+ 	events: {
+ 		
+ 	},
  	modules: {}	
  };
 <?php

Modified: trunk/mapbender/http/javascripts/map_obj.js
===================================================================
--- trunk/mapbender/http/javascripts/map_obj.js	2009-06-24 15:16:04 UTC (rev 4123)
+++ trunk/mapbender/http/javascripts/map_obj.js	2009-06-24 15:17:05 UTC (rev 4124)
@@ -15,11 +15,11 @@
  */
  
 /**
- * Constructor
+ * Constructor: Map
  * 
  * Parameters:
  * frameName		- *[deprecated]* the name of the iframe, for backwards
- * 						compatibility only
+ * 						compatibility only, use "" for maps in DIVs
  * elementName		- the ID of the DOM node
  * width			- width of the map in pixel
  * height			- height of the map in pixel
@@ -29,7 +29,16 @@
 Mapbender.Map = function (frameName, elementName, width, height, wms_index) {
 
 	/**
+	 * Method: setExtent
+	 * 
+	 * Description:
 	 * set the extent of the wms
+	 * 
+	 * Parameters:
+	 * minx		- x of south west
+	 * miny		- y of south west
+	 * maxx		- x of north east
+	 * maxy		- y of north east
 	 */
 	this.setExtent = function(minx, miny, maxx, maxy){
 		this.extent = String(minx) + "," + String(miny) + "," + String(maxx) + "," + String(maxy);
@@ -183,8 +192,9 @@
 		return ext;
 	};
 
-
+	// private
 	this.width = width;
+	// private
 	this.height = height;
 	this.frameName = frameName;
 	this.type = (frameName !== "") ? "IFRAME" : "DIV";

Modified: trunk/mapbender/http/javascripts/mod_reload.php
===================================================================
--- trunk/mapbender/http/javascripts/mod_reload.php	2009-06-24 15:16:04 UTC (rev 4123)
+++ trunk/mapbender/http/javascripts/mod_reload.php	2009-06-24 15:17:05 UTC (rev 4124)
@@ -32,6 +32,9 @@
  * > 60,24,24,1,'','','','mod_reload.php','','mapframe1','',
  * > 'http://www.mapbender.org/index.php/Reload');
  *
+ * Help:
+ * http://www.mapbender.org/index.php/Reload
+ *
  * Maintainer: 
  * http://www.mapbender.org/User:Vera_Schulze
  */

Modified: trunk/mapbender/lib/event.js
===================================================================
--- trunk/mapbender/lib/event.js	2009-06-24 15:16:04 UTC (rev 4123)
+++ trunk/mapbender/lib/event.js	2009-06-24 15:17:05 UTC (rev 4124)
@@ -1,20 +1,23 @@
 /**
- * An event. What happens, when the event occurs, depends on which functions have been
+ * Package: Event
+ * 
+ * Description:
+ *  An event. What happens, when the event occurs, depends on which functions have been
  * registered with the event. 
  * 
  * usage:
  * 
- * // create a new Event
- * var eventAfterMapRequest = new MapbenderEvent(); 
+ * > // create a new Event
+ * > var eventAfterMapRequest = new MapbenderEvent(); 
+ * >
+ * > // register a function with that event
+ * > eventAfterMapRequest.register(function () {
+ * > 	...
+ * > })
+ * >
+ * > // trigger the event
+ * > eventAfterMapRequest.trigger();
  * 
- * // register a function with that event
- * eventAfterMapRequest.register(function () {
- * 	...
- * })
- * 
- * // trigger the event
- * eventAfterMapRequest.trigger();
- * 
  */
 var MapbenderEvent = Mapbender.Event = function () {