[Mapbender-commits] r5633 - trunk/mapbender/http/javascripts

[svn_mapbender at osgeo.org]

Author: christoph
Date: 2010-02-24 10:53:02 -0500 (Wed, 24 Feb 2010)
New Revision: 5633

Modified:
   trunk/mapbender/http/javascripts/mod_wfs_gazetteer_client.php
Log:


Modified: trunk/mapbender/http/javascripts/mod_wfs_gazetteer_client.php
===================================================================
--- trunk/mapbender/http/javascripts/mod_wfs_gazetteer_client.php	2010-02-24 14:51:43 UTC (rev 5632)
+++ trunk/mapbender/http/javascripts/mod_wfs_gazetteer_client.php	2010-02-24 15:53:02 UTC (rev 5633)
@@ -34,6 +34,75 @@
 include '../include/dyn_css.php';
 ?>
 <script type="text/javascript">
+/**
+ * Package: gazetteerWFS
+ *
+ * Description:
+ * A WFS gazetteer for pre configured WFS configurations.
+ * 
+ * Files:
+ *  - http/javascripts/mod_wfs_gazetteer_client.php
+ *  - http/php/mod_wfs_gazetteer_server.php
+ *
+ * SQL:
+ * > INSERT INTO gui_element(fkey_gui_id, e_id, e_pos, e_public, e_comment, 
+ * > e_title, e_element, e_src, e_attributes, e_left, e_top, e_width, 
+ * > e_height, e_z_index, e_more_styles, e_content, e_closetag, e_js_file, 
+ * > e_mb_mod, e_target, e_requires, e_url) VALUES ('<appId>','gazetteerWFS',
+ * > 2,1,'a gazetteer for user in the mapbender user map','Search','iframe',
+ * > '../javascripts/mod_wfs_gazetteer_client.php?sessionID&target=mapframe1,overview',
+ * > 'frameborder = "0"',10,600,300,150,4,
+ * > 'visibility:hidden; border: 1px solid #a19c8f;','','iframe','',
+ * > 'geometry.js,requestGeometryConstructor.js,popup.js,../extensions/wz_jsgraphics.js',
+ * > 'mapframe1,overview','','http://www.mapbender.org/GazetteerWFS');
+ * >
+ * > INSERT INTO gui_element_vars (fkey_gui_id, fkey_e_id, var_name, 
+ * > var_value, context, var_type) VALUES('<appId>', 'gazetteerWFS', 
+ * > 'maxHighlightedPoints', '500', 'max number of points to highlight',
+ * > 'var');
+ * >
+ * > INSERT INTO gui_element_vars(fkey_gui_id, fkey_e_id, var_name, 
+ * > var_value, context, var_type) VALUES ('<appId>', 'gazetteerWFS', 
+ * > 'wfsConfIdString', '<value>', 'comma seperated list of WFS conf ids' ,
+ * > 'php_var');
+ * >
+ * > INSERT INTO gui_element_vars(fkey_gui_id, fkey_e_id, var_name, 
+ * > var_value, context, var_type) VALUES('<appId>', 'gazetteerWFS', 
+ * > 'wfs_spatial_request_conf_filename', 'wfs_additional_spatial_search.conf', 
+ * > 'location and name of the WFS configuration file for spatialRequest' ,
+ * > 'php_var');
+ * >
+ * > INSERT INTO gui_element_vars (fkey_gui_id, fkey_e_id, var_name, 
+ * > var_value, context, var_type) VALUES('<appId>', 'gazetteerWFS', 
+ * > 'initializeOnLoad', '0', 'start gazetteer onload' ,'var');
+ * >
+ * > INSERT INTO gui_element_vars(fkey_gui_id, fkey_e_id, var_name, 
+ * > var_value, context, var_type) VALUES('<appId>', 'gazetteerWFS', 
+ * > 'enableSearchWithoutParams', '0', 
+ * > 'define that search can be started without any search params' ,
+ * > 'var');
+ *
+ * Help:
+ * http://www.mapbender.org/GazetteerWFS
+ *
+ * Maintainer:
+ * http://www.mapbender.org/User:Verena_Diewald
+ * 
+ * Parameters:
+ * maxHighlightedPoints	- max number of points to highlight
+ * wfsConfIdString - comma seperated list of WFS conf ids
+ * wfs_spatial_request_conf_filename - location and name of the WFS 
+ * 			configuration file for spatialRequest
+ * initializeOnLoad - start gazetteer onload
+ * enableSearchWithoutParams - define that search can be started without any 
+ * 			search params
+ *
+ * License:
+ * Copyright (c) 2009, Open Source Geospatial Foundation
+ * This program is dual licensed under the GNU General Public License 
+ * and Simplified BSD license.  
+ * http://svn.osgeo.org/mapbender/trunk/mapbender/license/license.txt
+ */
 <?php 
 	include '../include/dyn_js.php';
 	include '../extensions/jquery-ui-1.7.2.custom/js/jquery-1.3.2.min.js';
@@ -213,7 +282,21 @@
 		parent.Mapbender.modules.gazetteerWFS.events = {};
 		var ev = parent.Mapbender.modules.gazetteerWFS.events;
 		ev.receiveFeatureCollection = parent.Mapbender.modules.gazetteerWFS.receiveFeatureCollection;
+		
+		/**
+		 * Property: events.onWfsConfSelect
+		 * 
+		 * Description:
+		 * event is fired whenever a new WFS is selected
+		 */
 		ev.onWfsConfSelect = new parent.Mapbender.Event();
+
+		/**
+		 * Property: events.onFormReset
+		 * 
+		 * Description:
+		 * event is fired whenever the form is resetted
+		 */
 		ev.onFormReset = new parent.Mapbender.Event();
 		initModWfsGazetteer();	
 		init_wfsSpatialRequest();