OpenLayers OpenLayers

Changeset 3592

Show
Ignore:
Timestamp:
07/05/07 14:10:22 (1 year ago)
Author:
euzuro
Message:

bring up changes from trunk

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • sandbox/euzuro/untiled3/lib/OpenLayers/Console.js

    r3545 r3592  
    202202    count: function() {}, 
    203203 
    204     /** 
    205      * Constant: CLASS_NAME 
    206      */ 
     204    /** @final @type String */ 
    207205    CLASS_NAME: "OpenLayers.Console" 
    208206}; 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Control/Navigation.js

    r3585 r3592  
    99 *  
    1010 * Class: OpenLayers.Control.Navigation 
     11 *  
     12 * Inherits: 
     13 *  - <OpenLayers.Control> 
    1114 */ 
    1215OpenLayers.Control.Navigation = OpenLayers.Class.create(); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Control/OverviewMap.js

    r3545 r3592  
    684684    }, 
    685685 
    686     /** 
    687      * Constant: CLASS_NAME 
    688      * {String} Name of this class 
    689      */ 
     686    /** @final @type String */ 
    690687    CLASS_NAME: 'OpenLayers.Control.OverviewMap' 
    691688     
  • sandbox/euzuro/untiled3/lib/OpenLayers/Format.js

    r3545 r3592  
    5757    }, 
    5858 
    59     /** 
    60      * Constant: CLASS_NAME 
    61      * {String} OpenLayers.Format 
    62      */ 
     59    /** @final @type String */ 
    6360    CLASS_NAME: "OpenLayers.Format" 
    6461 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Geometry/Collection.js

    r3545 r3592  
    274274    }, 
    275275 
    276     /** 
    277      * Constant: CLASS_NAME 
    278      * {String} Name of class. 
    279      */ 
     276    /** @final @type String */ 
    280277    CLASS_NAME: "OpenLayers.Geometry.Collection" 
    281278}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Geometry/LineString.js

    r3545 r3592  
    4545    }, 
    4646        
    47     /** 
    48      * Constant: CLASS_NAME 
    49      * {String} Name of class. 
    50      */ 
     47    /** @final @type String */ 
    5148    CLASS_NAME: "OpenLayers.Geometry.LineString" 
    5249}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Geometry/MultiLineString.js

    r3545 r3592  
    3939    }, 
    4040 
    41     /** 
    42      * Constant: CLASS_NAME 
    43      * {String} Name of class. 
    44      */ 
     41    /** @final @type String */ 
    4542    CLASS_NAME: "OpenLayers.Geometry.MultiLineString" 
    4643}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Geometry/MultiPoint.js

    r3545 r3592  
    6464    }, 
    6565 
    66     /** 
    67      * Constant: CLASS_NAME 
    68      * {String} Name of class. 
    69      */ 
     66    /** @final @type String */ 
    7067    CLASS_NAME: "OpenLayers.Geometry.MultiPoint" 
    7168}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Geometry/MultiPolygon.js

    r3545 r3592  
    4040    }, 
    4141     
    42     /** 
    43      * Constant: CLASS_NAME 
    44      * {String} Name of class. 
    45      */ 
     42    /** @final @type String */ 
    4643    CLASS_NAME: "OpenLayers.Geometry.MultiPolygon" 
    4744}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Geometry/Point.js

    r3545 r3592  
    133133    }, 
    134134 
    135     /** Constant: CLASS_NAME 
    136      * {String} Name of this class 
    137      */ 
     135    /** @final @type String */ 
    138136    CLASS_NAME: "OpenLayers.Geometry.Point" 
    139137}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Geometry/Polygon.js

    r3545 r3592  
    5959    }, 
    6060 
    61     /** 
    62      * Constant: CLASS_NAME 
    63      * {String} Name of class. 
    64      */ 
     61    /** @final @type String */ 
    6562    CLASS_NAME: "OpenLayers.Geometry.Polygon" 
    6663}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Handler/Path.js

    r3545 r3592  
    241241    }, 
    242242     
    243     /** 
    244      * Constant: CLASS_NAME 
    245      * {String} Name of class. 
    246      */ 
     243    /** @final @type String */ 
    247244    CLASS_NAME: "OpenLayers.Handler.Path" 
    248245}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Handler/Point.js

    r3545 r3592  
    264264    }, 
    265265 
    266     /** 
    267      * Constant: CLASS_NAME 
    268      * {String} Name of class. 
    269      */ 
     266    /** @final @type String */ 
    270267    CLASS_NAME: "OpenLayers.Handler.Point" 
    271268}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Layer.js

    r3585 r3592  
    413413    }, 
    414414     
    415     /**   
    416      * @returns The size that the image should be, taking into account gutters  
    417      * @tile OpenLayers.Size  
     415    /** 
     416     * APIMethod: getImageSize 
     417     *  
     418     * Return: 
     419     * {<OpenLayers.Size>} The size that the image should be, taking into  
     420     *                     account gutters. 
    418421     */  
    419422    getImageSize: function() {  
  • sandbox/euzuro/untiled3/lib/OpenLayers/Layer/EventPane.js

    r3545 r3592  
    362362    }, 
    363363 
    364     /** 
    365      * Constant: CLASS_NAME 
    366      * {String} Name of this class 
    367      */ 
     364    /** @final @type String */ 
    368365    CLASS_NAME: "OpenLayers.Layer.EventPane" 
    369366}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Layer/Image.js

    r3555 r3592  
    205205    }, 
    206206         
    207     /** 
    208      * Constant: CLASS_NAME 
    209      * {String} OpenLayers.Layer.Image 
    210      */ 
     207    /** @final @type String */ 
    211208    CLASS_NAME: "OpenLayers.Layer.Image" 
    212209}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Layer/MapServer.js

    r3555 r3592  
    22 * See http://svn.openlayers.org/trunk/openlayers/repository-license.txt  
    33 * for the full text of the license. */ 
    4 // @requires OpenLayers/Layer/Grid.js 
     4 
    55/** 
    66 * @requires OpenLayers/Layer/Grid.js 
     
    1717  OpenLayers.Class.inherit( OpenLayers.Layer.Grid, { 
    1818 
    19       /** 
    20        * Constant: DEFAULT_PARAMS 
    21        * {Object} Hashtable of default parameter key/value pairs  
    22        */ 
     19    /** 
     20     * Constant: DEFAULT_PARAMS 
     21     * {Object} Hashtable of default parameter key/value pairs  
     22     */ 
    2323    DEFAULT_PARAMS: { 
    24                       mode: "map", 
    25                       map_imagetype: "png" 
    26                      }, 
     24        mode: "map", 
     25        map_imagetype: "png" 
     26    }, 
    2727 
    28      /** 
    29       * Constructor: OpenLayers.Layer.MapServer 
    30       * Create a new MapServer layer object 
    31       * 
    32       * Example: 
    33       * (code) 
    34       * layer = new OpenLayers.Layer.MapServer( "OpenLayers WMS",  
    35       *         "http://labs.metacarta.com/wms/vmap0", {layers: 'basic'}, 
    36       *         {gutter: 15}); 
    37       * (end) 
    38       * 
    39       * Parameters: 
    40       * name - {String} A name for the layer 
    41       * url - {String} Base url for the MapServer CGI 
    42       *       (e.g. http://www2.dmsolutions.ca/cgi-bin/mapserv) 
    43       * params - {Object} An object with key/value pairs representing the 
    44       *          GetMap query string parameters and parameter values. 
    45       * options - {Ojbect} Hashtable of extra options to tag onto the layer 
    46       * 
    47       * Return: 
    48       * A new OpenLayers.Layer.MapServer instance 
    49       */ 
     28    /** 
     29     * Constructor: OpenLayers.Layer.MapServer 
     30     * Create a new MapServer layer object 
     31     * 
     32     * Parameters: 
     33     * name - {String} A name for the layer 
     34     * url - {String} Base url for the MapServer CGI 
     35     *       (e.g. http://www2.dmsolutions.ca/cgi-bin/mapserv) 
     36     * params - {Object} An object with key/value pairs representing the 
     37     *          GetMap query string parameters and parameter values. 
     38     * options - {Ojbect} Hashtable of extra options to tag onto the layer 
     39     */ 
    5040    initialize: function(name, url, params, options) { 
    5141        var newArguments = new Array(); 
     
    9181 
    9282    /** 
    93     * addTile creates a tile, initializes it, and  
    94     * adds it to the layer div.  
    95     * 
    96     * @param {<OpenLayers.Bounds>} bounds 
    97     * 
    98     * @returns The added OpenLayers.Tile.Image 
    99     * @type OpenLayers.Tile.Image 
    100     */ 
     83     * Method: addTile 
     84     * Creates a tile, initializes it, and adds it to the layer div.  
     85     * 
     86     * Parameters: 
     87     * bounds - {<OpenLayers.Bounds>} 
     88     *  
     89     * Return: 
     90     * {<OpenLayers.Tile.Image>} The added OpenLayers.Tile.Image 
     91     */ 
    10192    addTile:function(bounds,position) { 
    10293        var url = this.getURL(bounds); 
     
    109100     * 
    110101     * Parameters: 
    111      * bounds - {<OpenLayers.Bounds>} A bounds representing the bbox for the 
    112      *          request 
     102     * bounds - {<OpenLayers.Bounds>} A bounds representing the bbox  
     103     *                                for the request 
    113104     * 
    114105     * Return: 
    115      * {String} A string with the layer's url and parameters and also the 
    116      * passed-in bounds and appropriate tile size specified as parameters 
     106     * {String} A string with the layer's url and parameters and also  
     107     *          the passed-in bounds and appropriate tile size specified  
     108     *          as parameters. 
    117109     */ 
    118110    getURL: function (bounds) { 
     
    137129     
    138130    /**  
    139     * Method: getFullRequestString 
    140     * combine the layer's url with its params and these newParams.  
    141     *    
    142     * Parameter: {Object} newParams 
    143     * new parameters that should be added to the request string. 
    144     *  
    145     * Parameter: {String} altUrl 
    146     * optional, replace the URL in the full request string with the 
    147     * provided URL. 
    148     *  
    149     * Return: {String} 
    150     * A string with the layer's url and parameters embedded in it. 
    151     */ 
     131     * Method: getFullRequestString 
     132     * combine the layer's url with its params and these newParams.  
     133     *    
     134     * Parameter: 
     135     * newParams - {Object} New parameters that should be added to the  
     136     *                      request string. 
     137     * altUrl - {String} (optional) Replace the URL in the full request   
     138     *                              string with the provided URL. 
     139     *  
     140     * Return:  
     141     * {String} A string with the layer's url and parameters embedded in it. 
     142     */ 
    152143    getFullRequestString:function(newParams, altUrl) { 
    153144        // use layer's url unless altUrl passed in 
     
    177168        var paramsString = OpenLayers.Util.getParameterString(allParams); 
    178169         
    179         /* MapServer needs '+' seperating things like bounds/height/width. 
    180            Since typically this is URL encoded, we use a slight hack: we 
    181            depend on the list-like functionality of getParameterString to 
    182            leave ',' only in the case of list items (since otherwise it is 
    183            encoded) then do a regular expression replace on the , characters 
    184            to '+' */ 
     170        // MapServer needs '+' seperating things like bounds/height/width. 
     171        //   Since typically this is URL encoded, we use a slight hack: we 
     172        //  depend on the list-like functionality of getParameterString to 
     173        //  leave ',' only in the case of list items (since otherwise it is 
     174        //  encoded) then do a regular expression replace on the , characters 
     175        //  to '+' 
     176        // 
    185177        paramsString = paramsString.replace(/,/g, "+"); 
    186178         
     
    201193        return requestString; 
    202194    }, 
    203     /** 
    204      * Constant: CLASS_NAME 
    205      * {String} OpenLayers.Layer.MapServer 
    206      */ 
     195     
     196    /** @final @type String */ 
    207197    CLASS_NAME: "OpenLayers.Layer.MapServer" 
    208198}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Layer/Vector.js

    r3545 r3592  
    432432    }, 
    433433 
    434     /** 
    435      * Constant: CLASS_NAME 
    436      * {String} 'OpenLayers.Layer.Vector' 
    437      */ 
     434    /** @final @type String */ 
    438435    CLASS_NAME: "OpenLayers.Layer.Vector" 
    439436}); 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Layer/WMS.js

    r3555 r3592  
    4141    reproject: true, 
    4242  
    43     /** @type Boolean */ 
     43    /** 
     44     * APIProperty: isBaseLayer 
     45     * {Boolean} Default is true for WMS layer 
     46     */ 
    4447    isBaseLayer: true, 
    4548  
  • sandbox/euzuro/untiled3/lib/OpenLayers/Tile/Image.js

    r3555 r3592  
    233233    }, 
    234234 
    235     /** 
    236      * Constant: CLASS_NAME 
    237      * {String} Name of class. 
    238      */ 
     235    /** @final @type String */ 
    239236    CLASS_NAME: "OpenLayers.Tile.Image" 
    240237  } 
  • sandbox/euzuro/untiled3/lib/OpenLayers/Tile/WFS.js

    r3545 r3592  
    149149    }, 
    150150     
    151     /** 
    152      * Constant: CLASS_NAME 
    153      * {String} Name of class. 
    154      */ 
     151    /** @final @type String */ 
    155152    CLASS_NAME: "OpenLayers.Tile.WFS" 
    156153  }