ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix up comments

Browse Source 
git-svn-id: http://svn.openlayers.org/trunk/openlayers@3591 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
euzuro
2007-07-05 17:57:27 +00:00
parent cb3a2566bb
commit 9e8c1a22c7
1 changed files with 54 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

116
lib/OpenLayers/Layer/MapServer.js
View File

@@ -1,7 +1,7 @@
/* Copyright (c) 2006 MetaCarta, Inc., published under a modified BSD license.
* See http://svn.openlayers.org/trunk/openlayers/repository-license.txt
* for the full text of the license. */
// @requires OpenLayers/Layer/Grid.js
/**
* @requires OpenLayers/Layer/Grid.js
*
@@ -16,37 +16,27 @@ OpenLayers.Layer.MapServer = OpenLayers.Class.create();
OpenLayers.Layer.MapServer.prototype =
OpenLayers.Class.inherit( OpenLayers.Layer.Grid, {
/**
* Constant: DEFAULT_PARAMS
* {Object} Hashtable of default parameter key/value pairs
*/
/**
* Constant: DEFAULT_PARAMS
* {Object} Hashtable of default parameter key/value pairs
*/
DEFAULT_PARAMS: {
mode: "map",
map_imagetype: "png"
},
mode: "map",
map_imagetype: "png"
},
/**
* Constructor: OpenLayers.Layer.MapServer
* Create a new MapServer layer object
*
* Example:
* (code)
* layer = new OpenLayers.Layer.MapServer( "OpenLayers WMS",
* "http://labs.metacarta.com/wms/vmap0", {layers: 'basic'},
* {gutter: 15});
* (end)
*
* Parameters:
* name - {String} A name for the layer
* url - {String} Base url for the MapServer CGI
* (e.g. http://www2.dmsolutions.ca/cgi-bin/mapserv)
* params - {Object} An object with key/value pairs representing the
* GetMap query string parameters and parameter values.
* options - {Ojbect} Hashtable of extra options to tag onto the layer
*
* Return:
* A new OpenLayers.Layer.MapServer instance
*/
/**
* Constructor: OpenLayers.Layer.MapServer
* Create a new MapServer layer object
*
* Parameters:
* name - {String} A name for the layer
* url - {String} Base url for the MapServer CGI
* (e.g. http://www2.dmsolutions.ca/cgi-bin/mapserv)
* params - {Object} An object with key/value pairs representing the
* GetMap query string parameters and parameter values.
* options - {Ojbect} Hashtable of extra options to tag onto the layer
*/
initialize: function(name, url, params, options) {
var newArguments = new Array();
newArguments.push(name, url, params, options);
@@ -90,14 +80,15 @@ OpenLayers.Layer.MapServer.prototype =
},
/**
* addTile creates a tile, initializes it, and
* adds it to the layer div.
*
* @param {<OpenLayers.Bounds>} bounds
*
* @returns The added OpenLayers.Tile.Image
* @type OpenLayers.Tile.Image
*/
* Method: addTile
* Creates a tile, initializes it, and adds it to the layer div.
*
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* {<OpenLayers.Tile.Image>} The added OpenLayers.Tile.Image
*/
addTile:function(bounds,position) {
var url = this.getURL(bounds);
return new OpenLayers.Tile.Image(this, position, bounds, url, this.tileSize);
@@ -108,12 +99,13 @@ OpenLayers.Layer.MapServer.prototype =
* Return a query string for this layer
*
* Parameters:
* bounds - {<OpenLayers.Bounds>} A bounds representing the bbox for the
* request
* bounds - {<OpenLayers.Bounds>} A bounds representing the bbox
* for the request
*
* Return:
* {String} A string with the layer's url and parameters and also the
* passed-in bounds and appropriate tile size specified as parameters
* {String} A string with the layer's url and parameters and also
* the passed-in bounds and appropriate tile size specified
* as parameters.
*/
getURL: function (bounds) {
bounds = this.adjustBounds(bounds);
@@ -136,19 +128,18 @@ OpenLayers.Layer.MapServer.prototype =
},
/**
* Method: getFullRequestString
* combine the layer's url with its params and these newParams.
*
* Parameter: {Object} newParams
* new parameters that should be added to the request string.
*
* Parameter: {String} altUrl
* optional, replace the URL in the full request string with the
* provided URL.
*
* Return: {String}
* A string with the layer's url and parameters embedded in it.
*/
* Method: getFullRequestString
* combine the layer's url with its params and these newParams.
*
* Parameter:
* newParams - {Object} New parameters that should be added to the
* request string.
* altUrl - {String} (optional) Replace the URL in the full request
* string with the provided URL.
*
* Return:
* {String} A string with the layer's url and parameters embedded in it.
*/
getFullRequestString:function(newParams, altUrl) {
// use layer's url unless altUrl passed in
var url = (altUrl == null) ? this.url : altUrl;
@@ -176,12 +167,13 @@ OpenLayers.Layer.MapServer.prototype =
}
var paramsString = OpenLayers.Util.getParameterString(allParams);
/* MapServer needs '+' seperating things like bounds/height/width.
Since typically this is URL encoded, we use a slight hack: we
depend on the list-like functionality of getParameterString to
leave ',' only in the case of list items (since otherwise it is
encoded) then do a regular expression replace on the , characters
to '+' */
// MapServer needs '+' seperating things like bounds/height/width.
// Since typically this is URL encoded, we use a slight hack: we
// depend on the list-like functionality of getParameterString to
// leave ',' only in the case of list items (since otherwise it is
// encoded) then do a regular expression replace on the , characters
// to '+'
//
paramsString = paramsString.replace(/,/g, "+");
if (paramsString != "") {
@@ -200,7 +192,7 @@ OpenLayers.Layer.MapServer.prototype =
}
return requestString;
},
/** @final @type String */
CLASS_NAME: "OpenLayers.Layer.MapServer"
});