OpenLayers OpenLayers

Changeset 3543

Show
Ignore:
Timestamp:
06/29/07 11:31:09 (1 year ago)
Author:
crschmidt
Message:

Applying a reworked version of #768. The benefits of this are largely
maintenance related: this cleans up a global flag (_OPENLAYERS_SFL_), replacing
it with something in the OpenLayers namespace, and adds documentation/comments
to the code here that weren't before. Approved by El Chairman Uz.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/openlayers/lib/OpenLayers.js

    r3421 r3543  
    33 * for the full text of the license. */ 
    44 
    5 /* @requires OpenLayers/BaseTypes.js 
     5/*  
     6 * @requires OpenLayers/BaseTypes.js 
    67 */  
    78 
    …… 
    910/// This blob sucks in all the files in uncompressed form for ease of use 
    1011/// 
     12(function() { 
     13    /** 
     14     * Before creating the OpenLayers namespace, check to see if 
     15     * OpenLayers.singleFile is true.  This occurs if the 
     16     * OpenLayers/SingleFile.js script is included before this one - as is the 
     17     * case with single file builds. 
     18     */ 
     19    var singleFile = (typeof OpenLayers == "object" && OpenLayers.singleFile); 
     20    /** 
     21     * The OpenLayers object provides a namespace for all things OpenLayers 
     22     * @type Object 
     23     */ 
     24    OpenLayers = { 
     25         
     26        /** 
     27         * @type String 
     28         * @private 
     29         */ 
     30        _scriptName: (!singleFile) ? "lib/OpenLayers.js" : "OpenLayers.js", 
    1131 
    12 OpenLayers = new Object(); 
     32        /** 
     33         * @type String 
     34         * @returns Path to this script 
     35         * @private 
     36         */ 
     37        _getScriptLocation: function () { 
     38            var scriptLocation = ""; 
     39            var scriptName = OpenLayers._scriptName; 
     40          
     41            var scripts = document.getElementsByTagName('script'); 
     42            for (var i = 0; i < scripts.length; i++) { 
     43                var src = scripts[i].getAttribute('src'); 
     44                if (src) { 
     45                    var index = src.lastIndexOf(scriptName);  
     46                    // is it found, at the end of the URL? 
     47                    if ((index > -1) && (index + scriptName.length == src.length)) {   
     48                        scriptLocation = src.slice(0, -scriptName.length); 
     49                        break; 
     50                    } 
     51                } 
     52            } 
     53            return scriptLocation; 
     54         } 
     55    }; 
     56    /** 
     57     * OpenLayers.singleFile is a flag indicating this file is being included 
     58     * in a Single File Library build of the OpenLayers Library. 
     59     *  
     60     * When we are *not* part of a SFL build we dynamically include the 
     61     * OpenLayers library code. 
     62     *  
     63     * When we *are* part of a SFL build we do not dynamically include the  
     64     * OpenLayers library code as it will be appended at the end of this file. 
     65      */ 
     66    if(!singleFile) { 
     67        var jsfiles = new Array( 
     68            "OpenLayers/BaseTypes.js", 
     69            "OpenLayers/Util.js", 
     70            "OpenLayers/Console.js", 
     71            "Rico/Corner.js", 
     72            "Rico/Color.js", 
     73            "OpenLayers/Ajax.js", 
     74            "OpenLayers/Events.js", 
     75            "OpenLayers/Map.js", 
     76            "OpenLayers/Layer.js", 
     77            "OpenLayers/Icon.js", 
     78            "OpenLayers/Marker.js", 
     79            "OpenLayers/Marker/Box.js", 
     80            "OpenLayers/Popup.js", 
     81            "OpenLayers/Tile.js", 
     82            "OpenLayers/Feature.js", 
     83            "OpenLayers/Feature/Vector.js", 
     84            "OpenLayers/Feature/WFS.js", 
     85            "OpenLayers/Tile/Image.js", 
     86            "OpenLayers/Tile/WFS.js", 
     87            "OpenLayers/Layer/Image.js", 
     88            "OpenLayers/Layer/EventPane.js", 
     89            "OpenLayers/Layer/FixedZoomLevels.js", 
     90            "OpenLayers/Layer/Google.js", 
     91            "OpenLayers/Layer/VirtualEarth.js", 
     92            "OpenLayers/Layer/Yahoo.js", 
     93            "OpenLayers/Layer/HTTPRequest.js", 
     94            "OpenLayers/Layer/Grid.js", 
     95            "OpenLayers/Layer/MapServer.js", 
     96            "OpenLayers/Layer/MapServer/Untiled.js", 
     97            "OpenLayers/Layer/KaMap.js", 
     98            "OpenLayers/Layer/MultiMap.js", 
     99            "OpenLayers/Layer/Markers.js", 
     100            "OpenLayers/Layer/Text.js", 
     101            "OpenLayers/Layer/WorldWind.js", 
     102            "OpenLayers/Layer/WMS.js", 
     103            "OpenLayers/Layer/WMS/Untiled.js", 
     104            "OpenLayers/Layer/GeoRSS.js", 
     105            "OpenLayers/Layer/Boxes.js", 
     106            "OpenLayers/Layer/TMS.js", 
     107            "OpenLayers/Popup/Anchored.js", 
     108            "OpenLayers/Popup/AnchoredBubble.js", 
     109            "OpenLayers/Handler.js", 
     110            "OpenLayers/Handler/Point.js", 
     111            "OpenLayers/Handler/Path.js", 
     112            "OpenLayers/Handler/Polygon.js", 
     113            "OpenLayers/Handler/Feature.js", 
     114            "OpenLayers/Handler/Drag.js", 
     115            "OpenLayers/Handler/Box.js", 
     116            "OpenLayers/Handler/MouseWheel.js", 
     117            "OpenLayers/Handler/Keyboard.js", 
     118            "OpenLayers/Control.js", 
     119            "OpenLayers/Control/ZoomBox.js", 
     120            "OpenLayers/Control/ZoomToMaxExtent.js", 
     121            "OpenLayers/Control/DragPan.js", 
     122            "OpenLayers/Control/Navigation.js", 
     123            "OpenLayers/Control/MouseDefaults.js", 
     124            "OpenLayers/Control/MousePosition.js", 
     125            "OpenLayers/Control/OverviewMap.js", 
     126            "OpenLayers/Control/KeyboardDefaults.js", 
     127            "OpenLayers/Control/PanZoom.js", 
     128            "OpenLayers/Control/PanZoomBar.js", 
     129            "OpenLayers/Control/ArgParser.js", 
     130            "OpenLayers/Control/Permalink.js", 
     131            "OpenLayers/Control/Scale.js", 
     132            "OpenLayers/Control/LayerSwitcher.js", 
     133            "OpenLayers/Control/DrawFeature.js", 
     134            "OpenLayers/Control/Panel.js", 
     135            "OpenLayers/Control/SelectFeature.js", 
     136            "OpenLayers/Geometry.js", 
     137            "OpenLayers/Geometry/Rectangle.js", 
     138            "OpenLayers/Geometry/Collection.js", 
     139            "OpenLayers/Geometry/Point.js", 
     140            "OpenLayers/Geometry/MultiPoint.js", 
     141            "OpenLayers/Geometry/Curve.js", 
     142            "OpenLayers/Geometry/LineString.js", 
     143            "OpenLayers/Geometry/LinearRing.js",         
     144            "OpenLayers/Geometry/Polygon.js", 
     145            "OpenLayers/Geometry/MultiLineString.js", 
     146            "OpenLayers/Geometry/MultiPolygon.js", 
     147            "OpenLayers/Geometry/Surface.js", 
     148            "OpenLayers/Renderer.js", 
     149            "OpenLayers/Renderer/Elements.js", 
     150            "OpenLayers/Renderer/SVG.js", 
     151            "OpenLayers/Renderer/VML.js", 
     152            "OpenLayers/Layer/Vector.js", 
     153            "OpenLayers/Layer/GML.js", 
     154            "OpenLayers/Format.js", 
     155            "OpenLayers/Format/GML.js", 
     156            "OpenLayers/Format/KML.js", 
     157            "OpenLayers/Format/GeoRSS.js", 
     158            "OpenLayers/Format/WFS.js", 
     159            "OpenLayers/Format/WKT.js", 
     160            "OpenLayers/Layer/WFS.js", 
     161            "OpenLayers/Control/MouseToolbar.js", 
     162            "OpenLayers/Control/NavToolbar.js", 
     163            "OpenLayers/Control/EditingToolbar.js" 
     164        ); // etc. 
    13165 
    14 OpenLayers._scriptName = (  
    15     typeof(_OPENLAYERS_SFL_) == "undefined" ? "lib/OpenLayers.js"  
    16                                             : "OpenLayers.js" ); 
    17166 
    18 OpenLayers._getScriptLocation = function () { 
    19     var scriptLocation = ""; 
    20     var SCRIPT_NAME = OpenLayers._scriptName; 
    21   
    22     var scripts = document.getElementsByTagName('script'); 
    23     for (var i = 0; i < scripts.length; i++) { 
    24         var src = scripts[i].getAttribute('src'); 
    25         if (src) { 
    26             var index = src.lastIndexOf(SCRIPT_NAME);  
    27             // is it found, at the end of the URL? 
    28             if ((index > -1) && (index + SCRIPT_NAME.length == src.length)) {   
    29                 scriptLocation = src.slice(0, -SCRIPT_NAME.length); 
    30                 break; 
     167 
     168        var allScriptTags = ""; 
     169        var host = OpenLayers._getScriptLocation() + "lib/"; 
     170     
     171        for (var i = 0; i < jsfiles.length; i++) { 
     172            if (/MSIE/.test(navigator.userAgent) || /Safari/.test(navigator.userAgent)) { 
     173                var currentScriptTag = "<script src='" + host + jsfiles[i] + "'></script>";  
     174                allScriptTags += currentScriptTag; 
     175            } else { 
     176                var s = document.createElement("script"); 
     177                s.src = host + jsfiles[i]; 
     178                var h = document.getElementsByTagName("head").length ?  
     179                           document.getElementsByTagName("head")[0] :  
     180                           document.body; 
     181                h.appendChild(s); 
    31182            } 
    32183        } 
     184        if (allScriptTags) document.write(allScriptTags); 
    33185    } 
    34     return scriptLocation; 
    35 } 
    36  
    37 /* 
    38   `_OPENLAYERS_SFL_` is a flag indicating this file is being included 
    39   in a Single File Library build of the OpenLayers Library. 
    40  
    41   When we are *not* part of a SFL build we dynamically include the 
    42   OpenLayers library code. 
    43  
    44   When we *are* part of a SFL build we do not dynamically include the  
    45   OpenLayers library code as it will be appended at the end of this file. 
    46 */ 
    47 if (typeof(_OPENLAYERS_SFL_) == "undefined") { 
    48     /* 
    49       The original code appeared to use a try/catch block 
    50       to avoid polluting the global namespace, 
    51       we now use a anonymous function to achieve the same result. 
    52      */ 
    53     (function() { 
    54     var jsfiles=new Array( 
    55         "OpenLayers/BaseTypes.js", 
    56         "OpenLayers/Util.js", 
    57         "OpenLayers/Console.js", 
    58         "Rico/Corner.js", 
    59         "Rico/Color.js", 
    60         "OpenLayers/Ajax.js", 
    61         "OpenLayers/Events.js", 
    62         "OpenLayers/Map.js", 
    63         "OpenLayers/Layer.js", 
    64         "OpenLayers/Icon.js", 
    65         "OpenLayers/Marker.js", 
    66         "OpenLayers/Marker/Box.js", 
    67         "OpenLayers/Popup.js", 
    68         "OpenLayers/Tile.js", 
    69         "OpenLayers/Feature.js", 
    70         "OpenLayers/Feature/Vector.js", 
    71         "OpenLayers/Feature/WFS.js", 
    72         "OpenLayers/Tile/Image.js", 
    73         "OpenLayers/Tile/WFS.js", 
    74         "OpenLayers/Layer/Image.js", 
    75         "OpenLayers/Layer/EventPane.js", 
    76         "OpenLayers/Layer/FixedZoomLevels.js", 
    77         "OpenLayers/Layer/Google.js", 
    78         "OpenLayers/Layer/VirtualEarth.js", 
    79         "OpenLayers/Layer/Yahoo.js", 
    80         "OpenLayers/Layer/HTTPRequest.js", 
    81         "OpenLayers/Layer/Grid.js", 
    82         "OpenLayers/Layer/MapServer.js", 
    83         "OpenLayers/Layer/MapServer/Untiled.js", 
    84         "OpenLayers/Layer/KaMap.js", 
    85         "OpenLayers/Layer/MultiMap.js", 
    86         "OpenLayers/Layer/Markers.js", 
    87         "OpenLayers/Layer/Text.js", 
    88         "OpenLayers/Layer/WorldWind.js", 
    89         "OpenLayers/Layer/WMS.js", 
    90         "OpenLayers/Layer/WMS/Untiled.js", 
    91         "OpenLayers/Layer/GeoRSS.js", 
    92         "OpenLayers/Layer/Boxes.js", 
    93         "OpenLayers/Layer/TMS.js", 
    94         "OpenLayers/Popup/Anchored.js", 
    95         "OpenLayers/Popup/AnchoredBubble.js", 
    96         "OpenLayers/Handler.js", 
    97         "OpenLayers/Handler/Point.js", 
    98         "OpenLayers/Handler/Path.js", 
    99         "OpenLayers/Handler/Polygon.js", 
    100         "OpenLayers/Handler/Feature.js", 
    101         "OpenLayers/Handler/Drag.js", 
    102         "OpenLayers/Handler/Box.js", 
    103         "OpenLayers/Handler/MouseWheel.js", 
    104         "OpenLayers/Handler/Keyboard.js", 
    105         "OpenLayers/Control.js", 
    106         "OpenLayers/Control/ZoomBox.js", 
    107         "OpenLayers/Control/ZoomToMaxExtent.js", 
    108         "OpenLayers/Control/DragPan.js", 
    109         "OpenLayers/Control/Navigation.js", 
    110         "OpenLayers/Control/MouseDefaults.js", 
    111         "OpenLayers/Control/MousePosition.js", 
    112         "OpenLayers/Control/OverviewMap.js", 
    113         "OpenLayers/Control/KeyboardDefaults.js", 
    114         "OpenLayers/Control/PanZoom.js", 
    115         "OpenLayers/Control/PanZoomBar.js", 
    116         "OpenLayers/Control/ArgParser.js", 
    117         "OpenLayers/Control/Permalink.js", 
    118         "OpenLayers/Control/Scale.js", 
    119         "OpenLayers/Control/LayerSwitcher.js", 
    120         "OpenLayers/Control/DrawFeature.js", 
    121         "OpenLayers/Control/Panel.js", 
    122         "OpenLayers/Control/SelectFeature.js", 
    123         "OpenLayers/Geometry.js", 
    124         "OpenLayers/Geometry/Rectangle.js", 
    125         "OpenLayers/Geometry/Collection.js", 
    126         "OpenLayers/Geometry/Point.js", 
    127         "OpenLayers/Geometry/MultiPoint.js", 
    128         "OpenLayers/Geometry/Curve.js", 
    129         "OpenLayers/Geometry/LineString.js", 
    130         "OpenLayers/Geometry/LinearRing.js",         
    131         "OpenLayers/Geometry/Polygon.js", 
    132         "OpenLayers/Geometry/MultiLineString.js", 
    133         "OpenLayers/Geometry/MultiPolygon.js", 
    134         "OpenLayers/Geometry/Surface.js", 
    135         "OpenLayers/Renderer.js", 
    136         "OpenLayers/Renderer/Elements.js", 
    137         "OpenLayers/Renderer/SVG.js", 
    138         "OpenLayers/Renderer/VML.js", 
    139         "OpenLayers/Layer/Vector.js", 
    140         "OpenLayers/Layer/GML.js", 
    141         "OpenLayers/Format.js", 
    142         "OpenLayers/Format/GML.js", 
    143         "OpenLayers/Format/KML.js", 
    144         "OpenLayers/Format/GeoRSS.js", 
    145         "OpenLayers/Format/WFS.js", 
    146         "OpenLayers/Format/WKT.js", 
    147         "OpenLayers/Layer/WFS.js", 
    148         "OpenLayers/Control/MouseToolbar.js", 
    149         "OpenLayers/Control/NavToolbar.js", 
    150         "OpenLayers/Control/EditingToolbar.js" 
    151     ); // etc. 
    152  
    153     var allScriptTags = ""; 
    154     var host = OpenLayers._getScriptLocation() + "lib/"; 
    155  
    156     for (var i = 0; i < jsfiles.length; i++) { 
    157         if (/MSIE/.test(navigator.userAgent) || /Safari/.test(navigator.userAgent)) { 
    158             var currentScriptTag = "<script src='" + host + jsfiles[i] + "'></script>";  
    159             allScriptTags += currentScriptTag; 
    160         } else { 
    161             var s = document.createElement("script"); 
    162             s.src = host + jsfiles[i]; 
    163             var h = document.getElementsByTagName("head").length ?  
    164                        document.getElementsByTagName("head")[0] :  
    165                        document.body; 
    166             h.appendChild(s); 
    167         } 
    168     } 
    169     if (allScriptTags) document.write(allScriptTags); 
    170     })(); 
    171 } 
     186})(); 
    172187OpenLayers.VERSION_NUMBER="$Revision$";