Changeset 6394

Timestamp:

02/28/08 11:40:08 (11 months ago)

Author:

sbenthall

Message:

partial merge to euzoro's pop sandbox popup code, in anticipation of eventual OL trunk merge.

Main functionality is the switch from shiftMap to panTo based map panning code.

Files:

• sandbox/topp/vespucci/lib/OpenLayers/Popup.js (modified) (13 diffs)

sandbox/topp/vespucci/lib/OpenLayers/Popup.js

@@ -1 +1 @@
-/* Copyright (c) 2006-2008 MetaCarta, Inc., published under the Clear BSD
- * license.  See http://svn.openlayers.org/trunk/openlayers/license.txt for the
-
+
+
-
-/**
@@ -83 +84 @@
-    
-    /** 
+     * Property: backgroundColor 
+     * {String} the background color used by the popup.
+     */
+    backgroundColor: "",
+    
+    /** 
-     * Property: opacity 
-     * {float} the opacity of this popup (between 0.0 and 1.0)
@@ -89 +96 @@
-
-    /** 
+     * Property: border 
+     * {String} the border size of the popup.  (eg 2px)
+     */
+    border: "",
+    
+    /** 
+     * Property: contentDiv 
+     * {DOMElement} a reference to the element that holds the content of
+     *              the div.
+     */
+    contentDiv: null,
+    
+    /** 
+     * Property: groupDiv 
+     * {DOMElement} First and only child of 'div'. The group Div contains the
+     *     'contentDiv' and the 'closeDiv'.
+     */
+    groupDiv: null,
+
+    /** 
+     * Property: closeDiv
+     * {DOMElement} the optional closer image
+     */
+    closeDiv: null,
+
+    /** 
+     * APIProperty: autoSize
+     * {Boolean} Resize the popup to auto-fit the contents.
+     *     Default is false.
+     */
+    autoSize: false,
+
+    /**
+     * APIProperty: minSize
+     * {<OpenLayers.Size>} Minimum size allowed for the popup's contents.
+     */
+    minSize: null,
+
+    /**
+     * APIProperty: maxSize
+     * {<OpenLayers.Size>} Maximum size allowed for the popup's contents.
+     */
+    maxSize: null,
+
+    /**
+     * APIProperty: margin
+     * {<OpenLayers.Bounds>} Outside margin of the popup. Used to prevent 
+     *     the popup from getting too close to the map border.
+     */
+    margin: null,
+
+    /**
+     * APIProperty: panMapIfOutOfView
+     * {Boolean} When drawn, pan map such that the entire popup is visible in
+     *     the current viewport (if necessary).
+     *     Default is false.
+     */
+    panMapIfOutOfView: false,
+
+    /** 
-     * Property: map 
-Reference to the map.
+this gets set in Map.js when the popup is added to the map
-     */
-    map: null,
@@ -143 +210 @@
-        this.id = id;
-        this.lonlat = lonlat;
+
+        //set default margin -- REDUNDAN WITH OLD MARGIN STUFF
+        this.margin = new OpenLayers.Bounds(5, 5, 5, 5);
+
-        
-        if (closeButton != null) {
@@ -389 +460 @@
-    *
-    * Parameters:
-
-
+
-    * 
-    * Returns:
@@ -396 +466 @@
-    */
-    draw: function(px) {
+        if (px == null) {
+            if ((this.lonlat != null) && (this.map != null)) {
+                px = this.map.getLayerPxFromLonLat(this.lonlat);
+            }
+        }
+
-        if (this.size == null) {
-            this.setSize(this.getPackedSize());
@@ -409 +485 @@
-        this.onLoad();
-        
-shiftMapIfNotViewable(
-
+moveTo(px
+
-        return this.div;
-    },
-
+
-    /** 
-     * Method: updatePosition
@@ -419 +495 @@
-     * then have it move itself to its proper position
-     */
-
-
-
-
-
-
+
+
+
+
+
+
+
-    },
-    
@@ -457 +534 @@
-        return px; 
-    },
-
+
-    /**
-     * Method: moveTo
@@ -465 +542 @@
-     */
-    moveTo: function(px) {
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-    },
-
@@ -508 +591 @@
-    
-    /**
+    * Method: setBackgroundColor
+    * Sets the background color of the popup.
+    * Parameters:
+    * color - {String} the background color.  eg "#FFBBBB"
+    */
+    setBackgroundColor:function(color) { 
+        if (color != undefined) {
+            this.backgroundColor = color; 
+        }
+        
+        if (this.div != null) {
+            this.div.style.backgroundColor = this.backgroundColor;
+        }
+    },  
+    
+    /**
-     * Method: setOpacity
-     * Sets the opacity of the popup.
@@ -527 +626 @@
-        }
-    },  
+    /**
+     * Method: addCloseBox
+     * 
+     * Parameters:
+     * callback - {Function} The callback to be called when the close button
+     *     is clicked.
+     */
+    addCloseBox: function(callback) {
+
+       // close icon
+        var closeSize = new OpenLayers.Size(17,17);
+        var img = OpenLayers.Util.getImagesLocation() + "close.gif";
+        this.closeDiv = OpenLayers.Util.createAlphaImageDiv(
+            this.id + "_close", null, closeSize, img
+        );
+        
+        //this is a workaround since API respect won't let us mandate 
+        // padding be a Bounds object. This needs to be removed in 3.0
+        //
+        this.fixPadding();
+        
+        this.closeDiv.style.right = this.padding.right + "px";
+        this.closeDiv.style.top = this.padding.top + "px";
+        this.groupDiv.appendChild(this.closeDiv);
+
+        var closePopup = callback || function(e) {
+            this.hide();
+            OpenLayers.Event.stop(e);
+        };
+        OpenLayers.Event.observe(this.closeDiv, "click", 
+                OpenLayers.Function.bindAsEventListener(closePopup, this));
+    },
+
+    /**
+     * Method: panIntoView
+     * Pans the map such that the popup is totaly viewable (if necessary)
+     */
+    panIntoView: function() {
+        
+        var mapSize = this.map.getSize();
+    
+        //start with the top left corner of the popup, in px, 
+        // relative to the viewport
+        var origTL = this.map.getViewPortPxFromLayerPx( new OpenLayers.Pixel(
+            parseInt(this.div.style.left),
+            parseInt(this.div.style.top)
+        ));
+        var newTL = origTL.clone();
+    
+        //new left (compare to margins, using this.size to calculate right)
+        if (origTL.x < this.margin.left) {
+            newTL.x = this.margin.left;
+        } else 
+        if ( (origTL.x + this.size.w) > (mapSize.w - this.margin.right)) {
+            newTL.x = mapSize.w - this.margin.right - this.size.w;
+        }
+        
+        //new top (compare to margins, using this.size to calculate bottom)
+        if (origTL.y < this.margin.top) {
+            newTL.y = this.margin.top;
+        } else 
+        if ( (origTL.y + this.size.h) > (mapSize.h - this.margin.bottom)) {
+            newTL.y = mapSize.h - this.margin.bottom - this.size.h;
+        }
+        
+        var dx = origTL.x - newTL.x;
+        var dy = origTL.y - newTL.y;
+        
+        this.map.pan(dx, dy);
+    },
-
-    /** 
@@ -549 +718 @@
-     *    hyperlinks or drag-selecting text.
-     */
-
+ 
-        this.events = new OpenLayers.Events(this, this.div, null, true);
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-    /**