Adding support for new generation 'framed' popups. This patch includes numerous improvements to the main popups, including the addition of autoSizing, panIntoView, and full support for overflow:auto of the contents div. Thanks go out to the CloudAmber folks, to Pierre in la belle France, to the guys at TOPP and of course, to senior cr5 for his patience and help in the last and final stretch. this is a huge improvement in the popup arena and couldn't have been done without the broad help of everyone out there in the community. Thank you everyone for making this possible. Big step for OpenLayers. (Closes #926)
git-svn-id: http://svn.openlayers.org/trunk/openlayers@6718 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
euzuro
@@ -86,7 +86,8 @@ OpenLayers.Popup = OpenLayers.Class({
|
||||
|
||||
/**
|
||||
* Property: groupDiv
|
||||
* {DOMElement} the parent of <OpenLayers.Popup.contentDiv>
|
||||
* {DOMElement} First and only child of 'div'. The group Div contains the
|
||||
* 'contentDiv' and the 'closeDiv'.
|
||||
*/
|
||||
groupDiv: null,
|
||||
|
||||
@@ -97,12 +98,64 @@ OpenLayers.Popup = OpenLayers.Class({
|
||||
closeDiv: null,
|
||||
|
||||
/**
|
||||
* Property: padding
|
||||
* {int} the internal padding of the content div.
|
||||
* APIProperty: autoSize
|
||||
* {Boolean} Resize the popup to auto-fit the contents.
|
||||
* Default is false.
|
||||
*/
|
||||
padding: 5,
|
||||
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,
|
||||
|
||||
/**
|
||||
* Property: padding
|
||||
* {int or <OpenLayers.Bounds>} An extra opportunity to specify internal
|
||||
* padding of the content div inside the popup. This was originally
|
||||
* confused with the css padding as specified in style.css's
|
||||
* 'olPopupContent' class. We would like to get rid of this altogether,
|
||||
* except that it does come in handy for the framed and anchoredbubble
|
||||
* popups, who need to maintain yet another barrier between their
|
||||
* content and the outer border of the popup itself.
|
||||
*
|
||||
* Note that in order to not break API, we must continue to support
|
||||
* this property being set as an integer. Really, though, we'd like to
|
||||
* have this specified as a Bounds object so that user can specify
|
||||
* distinct left, top, right, bottom paddings. With the 3.0 release
|
||||
* we can make this only a bounds.
|
||||
*/
|
||||
padding: 0,
|
||||
|
||||
/**
|
||||
* Method: fixPadding
|
||||
* To be removed in 3.0, this function merely helps us to deal with the
|
||||
* case where the user may have set an integer value for padding,
|
||||
* instead of an <OpenLayers.Bounds> object.
|
||||
*/
|
||||
fixPadding: function() {
|
||||
if (typeof this.padding == "number") {
|
||||
this.padding = new OpenLayers.Bounds(
|
||||
this.padding, this.padding, this.padding, this.padding
|
||||
);
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* 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
|
||||
* {<OpenLayers.Map>} this gets set in Map.js when the popup is added to the map
|
||||
@@ -147,37 +200,21 @@ OpenLayers.Popup = OpenLayers.Class({
|
||||
null, null, null, "hidden");
|
||||
this.div.className = 'olPopup';
|
||||
|
||||
this.groupDiv = OpenLayers.Util.createDiv(null, null, null,
|
||||
var groupDivId = this.id + "_GroupDiv";
|
||||
this.groupDiv = OpenLayers.Util.createDiv(groupDivId, null, null,
|
||||
null, "relative", null,
|
||||
"hidden");
|
||||
|
||||
var id = this.div.id + "_contentDiv";
|
||||
this.contentDiv = OpenLayers.Util.createDiv(id, null, this.size.clone(),
|
||||
null, "relative", null,
|
||||
"hidden");
|
||||
null, "relative");
|
||||
this.contentDiv.className = 'olPopupContent';
|
||||
this.groupDiv.appendChild(this.contentDiv);
|
||||
this.div.appendChild(this.groupDiv);
|
||||
|
||||
if (closeBox) {
|
||||
// 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.closeDiv.style.right = this.padding + "px";
|
||||
this.closeDiv.style.top = this.padding + "px";
|
||||
this.groupDiv.appendChild(this.closeDiv);
|
||||
|
||||
var closePopup = closeBoxCallback || function(e) {
|
||||
this.hide();
|
||||
OpenLayers.Event.stop(e);
|
||||
};
|
||||
OpenLayers.Event.observe(this.closeDiv, "click",
|
||||
OpenLayers.Function.bindAsEventListener(closePopup, this));
|
||||
|
||||
}
|
||||
this.addCloseBox(closeBoxCallback);
|
||||
}
|
||||
|
||||
this.registerEvents();
|
||||
},
|
||||
@@ -187,13 +224,39 @@ OpenLayers.Popup = OpenLayers.Class({
|
||||
* nullify references to prevent circular references and memory leaks
|
||||
*/
|
||||
destroy: function() {
|
||||
if (this.map != null) {
|
||||
this.map.removePopup(this);
|
||||
this.map = null;
|
||||
}
|
||||
|
||||
this.id = null;
|
||||
this.lonlat = null;
|
||||
this.size = null;
|
||||
this.contentHTML = null;
|
||||
|
||||
this.backgroundColor = null;
|
||||
this.opacity = null;
|
||||
this.border = null;
|
||||
|
||||
this.events.destroy();
|
||||
this.events = null;
|
||||
|
||||
if (this.closeDiv) {
|
||||
OpenLayers.Event.stopObservingElement(this.closeDiv);
|
||||
this.groupDiv.removeChild(this.closeDiv);
|
||||
}
|
||||
this.closeDiv = null;
|
||||
|
||||
this.div.removeChild(this.groupDiv);
|
||||
this.groupDiv = null;
|
||||
|
||||
if (this.map != null) {
|
||||
this.map.removePopup(this);
|
||||
}
|
||||
this.map = null;
|
||||
this.div = null;
|
||||
|
||||
this.autoSize = null;
|
||||
this.minSize = null;
|
||||
this.maxSize = null;
|
||||
this.padding = null;
|
||||
this.panMapIfOutOfView = null;
|
||||
},
|
||||
|
||||
/**
|
||||
@@ -213,12 +276,39 @@ OpenLayers.Popup = OpenLayers.Class({
|
||||
}
|
||||
}
|
||||
|
||||
this.setSize();
|
||||
//listen to movestart, moveend to disable overflow (FF bug)
|
||||
if (OpenLayers.Util.getBrowserName() == 'firefox') {
|
||||
this.map.events.register("movestart", this, function() {
|
||||
var style = document.defaultView.getComputedStyle(
|
||||
this.contentDiv, null
|
||||
);
|
||||
var currentOverflow = style.getPropertyValue("overflow");
|
||||
if (currentOverflow != "hidden") {
|
||||
this.contentDiv._oldOverflow = currentOverflow;
|
||||
this.contentDiv.style.overflow = "hidden";
|
||||
}
|
||||
});
|
||||
this.map.events.register("moveend", this, function() {
|
||||
var oldOverflow = this.contentDiv._oldOverflow;
|
||||
if (oldOverflow) {
|
||||
this.contentDiv.style.overflow = oldOverflow;
|
||||
this.contentDiv._oldOverflow = null;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
this.moveTo(px);
|
||||
if (!this.autoSize) {
|
||||
this.setSize(this.size);
|
||||
}
|
||||
this.setBackgroundColor();
|
||||
this.setOpacity();
|
||||
this.setBorder();
|
||||
this.setContentHTML();
|
||||
this.moveTo(px);
|
||||
|
||||
if (this.panMapIfOutOfView) {
|
||||
this.panIntoView();
|
||||
}
|
||||
|
||||
return this.div;
|
||||
},
|
||||
@@ -265,7 +355,11 @@ OpenLayers.Popup = OpenLayers.Class({
|
||||
* Toggles visibility of the popup.
|
||||
*/
|
||||
toggle: function() {
|
||||
OpenLayers.Element.toggle(this.div);
|
||||
if (this.visible()) {
|
||||
this.hide();
|
||||
} else {
|
||||
this.show();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
@@ -274,6 +368,10 @@ OpenLayers.Popup = OpenLayers.Class({
|
||||
*/
|
||||
show: function() {
|
||||
OpenLayers.Element.show(this.div);
|
||||
|
||||
if (this.panMapIfOutOfView) {
|
||||
this.panIntoView();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
@@ -289,30 +387,61 @@ OpenLayers.Popup = OpenLayers.Class({
|
||||
* Used to adjust the size of the popup.
|
||||
*
|
||||
* Parameters:
|
||||
* size - {<OpenLayers.Size>} the new size of the popup in pixels.
|
||||
* size - {<OpenLayers.Size>} the new size of the popup's contents div
|
||||
* (in pixels).
|
||||
*/
|
||||
setSize:function(size) {
|
||||
if (size != undefined) {
|
||||
this.size = size;
|
||||
}
|
||||
this.size = size;
|
||||
|
||||
var contentSize = this.size.clone();
|
||||
|
||||
// if our contentDiv has a css 'padding' set on it by a stylesheet, we
|
||||
// must add that to the desired "size".
|
||||
var contentDivPadding = this.getContentDivPadding();
|
||||
var wPadding = contentDivPadding.left + contentDivPadding.right;
|
||||
var hPadding = contentDivPadding.top + contentDivPadding.bottom;
|
||||
|
||||
// take into account the popup's 'padding' property
|
||||
this.fixPadding();
|
||||
wPadding += this.padding.left + this.padding.right;
|
||||
hPadding += this.padding.top + this.padding.bottom;
|
||||
|
||||
// make extra space for the close div
|
||||
if (this.closeDiv) {
|
||||
var closeDivWidth = parseInt(this.closeDiv.style.width);
|
||||
wPadding += closeDivWidth + contentDivPadding.right;
|
||||
}
|
||||
|
||||
//increase size of the main popup div to take into account the
|
||||
// users's desired padding and close div.
|
||||
this.size.w += wPadding;
|
||||
this.size.h += hPadding;
|
||||
|
||||
//now if our browser is IE, we need to actually make the contents
|
||||
// div itself bigger to take its own padding into effect. this makes
|
||||
// me want to shoot someone, but so it goes.
|
||||
if (OpenLayers.Util.getBrowserName() == "msie") {
|
||||
contentSize.w += contentDivPadding.left + contentDivPadding.right;
|
||||
contentSize.h += contentDivPadding.bottom + contentDivPadding.top;
|
||||
}
|
||||
|
||||
if (this.div != null) {
|
||||
this.div.style.width = this.size.w + "px";
|
||||
this.div.style.height = this.size.h + "px";
|
||||
}
|
||||
if (this.contentDiv != null){
|
||||
this.contentDiv.style.width = this.size.w + "px";
|
||||
this.contentDiv.style.height = this.size.h + "px";
|
||||
this.contentDiv.style.width = contentSize.w + "px";
|
||||
this.contentDiv.style.height = contentSize.h + "px";
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Method: setBackgroundColor
|
||||
* Sets the background color of the popup.
|
||||
*
|
||||
* Parameters:
|
||||
* color - {String} the background color. eg "#FFBBBB"
|
||||
*/
|
||||
* 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;
|
||||
@@ -373,13 +502,256 @@ OpenLayers.Popup = OpenLayers.Class({
|
||||
this.contentHTML = contentHTML;
|
||||
}
|
||||
|
||||
if (this.autoSize) {
|
||||
|
||||
// determine actual render dimensions of the contents
|
||||
var realSize =
|
||||
OpenLayers.Util.getRenderedDimensions(this.contentHTML);
|
||||
|
||||
// is the "real" size of the div is safe to display in our map?
|
||||
var safeSize = this.getSafeContentSize(realSize);
|
||||
|
||||
var newSize = null;
|
||||
|
||||
if (safeSize.equals(realSize)) {
|
||||
//real size of content is small enough to fit on the map,
|
||||
// so we use real size.
|
||||
newSize = realSize;
|
||||
|
||||
} else {
|
||||
|
||||
//make a new OL.Size object with the clipped dimensions
|
||||
// set or null if not clipped.
|
||||
var fixedSize = new OpenLayers.Size();
|
||||
fixedSize.w = (safeSize.w < realSize.w) ? safeSize.w : null;
|
||||
fixedSize.h = (safeSize.h < realSize.h) ? safeSize.h : null;
|
||||
|
||||
if (fixedSize.w && fixedSize.h) {
|
||||
//content is too big in both directions, so we will use
|
||||
// max popup size (safeSize), knowing well that it will
|
||||
// overflow both ways.
|
||||
newSize = safeSize;
|
||||
} else {
|
||||
//content is clipped in only one direction, so we need to
|
||||
// run getRenderedDimensions() again with a fixed dimension
|
||||
var clippedSize = OpenLayers.Util.getRenderedDimensions(
|
||||
this.contentHTML, fixedSize
|
||||
);
|
||||
|
||||
//if the clipped size is still the same as the safeSize,
|
||||
// that means that our content must be fixed in the
|
||||
// offending direction. If overflow is 'auto', this means
|
||||
// we are going to have a scrollbar for sure, so we must
|
||||
// adjust for that.
|
||||
//
|
||||
var currentOverflow = OpenLayers.Element.getStyle(
|
||||
this.contentDiv, "overflow"
|
||||
);
|
||||
if ( (currentOverflow != "hidden") &&
|
||||
(clippedSize.equals(safeSize)) ) {
|
||||
var scrollBar = OpenLayers.Util.getScrollbarWidth();
|
||||
if (fixedSize.w) {
|
||||
clippedSize.h += scrollBar;
|
||||
} else {
|
||||
clippedSize.w += scrollBar;
|
||||
}
|
||||
}
|
||||
|
||||
newSize = this.getSafeContentSize(clippedSize);
|
||||
}
|
||||
}
|
||||
this.setSize(newSize);
|
||||
}
|
||||
|
||||
if (this.contentDiv != null) {
|
||||
this.contentDiv.innerHTML = this.contentHTML;
|
||||
}
|
||||
},
|
||||
|
||||
|
||||
/**
|
||||
* APIMethod: getSafeContentSize
|
||||
*
|
||||
* Parameters:
|
||||
* size - {<OpenLayers.Size>} Desired size to make the popup.
|
||||
*
|
||||
* Returns:
|
||||
* {<OpenLayers.Size>} A size to make the popup which is neither smaller
|
||||
* than the specified minimum size, nor bigger than the maximum
|
||||
* size (which is calculated relative to the size of the viewport).
|
||||
*/
|
||||
getSafeContentSize: function(size) {
|
||||
|
||||
var safeContentSize = size.clone();
|
||||
|
||||
// if our contentDiv has a css 'padding' set on it by a stylesheet, we
|
||||
// must add that to the desired "size".
|
||||
var contentDivPadding = this.getContentDivPadding();
|
||||
var wPadding = contentDivPadding.left + contentDivPadding.right;
|
||||
var hPadding = contentDivPadding.top + contentDivPadding.bottom;
|
||||
|
||||
// take into account the popup's 'padding' property
|
||||
this.fixPadding();
|
||||
wPadding += this.padding.left + this.padding.right;
|
||||
hPadding += this.padding.top + this.padding.bottom;
|
||||
|
||||
if (this.closeDiv) {
|
||||
var closeDivWidth = parseInt(this.closeDiv.style.width);
|
||||
wPadding += closeDivWidth + contentDivPadding.right;
|
||||
}
|
||||
|
||||
// prevent the popup from being smaller than a specified minimal size
|
||||
if (this.minSize) {
|
||||
safeContentSize.w = Math.max(safeContentSize.w,
|
||||
(this.minSize.w - wPadding));
|
||||
safeContentSize.h = Math.max(safeContentSize.h,
|
||||
(this.minSize.h - hPadding));
|
||||
}
|
||||
|
||||
// prevent the popup from being bigger than a specified maximum size
|
||||
if (this.maxSize) {
|
||||
safeContentSize.w = Math.min(safeContentSize.w,
|
||||
(this.maxSize.w - wPadding));
|
||||
safeContentSize.h = Math.min(safeContentSize.h,
|
||||
(this.maxSize.h - hPadding));
|
||||
}
|
||||
|
||||
//make sure the desired size to set doesn't result in a popup that
|
||||
// is bigger than the map's viewport.
|
||||
//
|
||||
if (this.map && this.map.size) {
|
||||
|
||||
// Note that there *was* a reference to a
|
||||
// 'OpenLayers.Popup.SCROLL_BAR_WIDTH' constant here, with special
|
||||
// tolerance for it and everything... but it was never defined in
|
||||
// the first place, so I don't know what to think.
|
||||
|
||||
var maxY = this.map.size.h -
|
||||
this.map.paddingForPopups.top -
|
||||
this.map.paddingForPopups.bottom -
|
||||
hPadding;
|
||||
|
||||
var maxX = this.map.size.w -
|
||||
this.map.paddingForPopups.left -
|
||||
this.map.paddingForPopups.right -
|
||||
wPadding;
|
||||
|
||||
safeContentSize.w = Math.min(safeContentSize.w, maxX);
|
||||
safeContentSize.h = Math.min(safeContentSize.h, maxY);
|
||||
}
|
||||
|
||||
return safeContentSize;
|
||||
},
|
||||
|
||||
/**
|
||||
* Method: getContentDivPadding
|
||||
* Glorious, oh glorious hack in order to determine the css 'padding' of
|
||||
* the contentDiv. IE/Opera return null here unless we actually add the
|
||||
* popup's main 'div' element (which contains contentDiv) to the DOM.
|
||||
* So we make it invisible and then add it to the document temporarily.
|
||||
*
|
||||
* Once we've taken the padding readings we need, we then remove it
|
||||
* from the DOM (it will actually get added to the DOM in
|
||||
* Map.js's addPopup)
|
||||
*
|
||||
* Returns:
|
||||
* {<OpenLayers.Bounds>}
|
||||
*/
|
||||
getContentDivPadding: function() {
|
||||
|
||||
//use cached value if we have it
|
||||
var contentDivPadding = this._contentDivPadding;
|
||||
if (!contentDivPadding) {
|
||||
//make the div invisible and add it to the page
|
||||
this.div.style.display = "none";
|
||||
document.body.appendChild(this.div);
|
||||
|
||||
//read the padding settings from css, put them in an OL.Bounds
|
||||
contentDivPadding = new OpenLayers.Bounds(
|
||||
OpenLayers.Element.getStyle(this.contentDiv, "padding-left"),
|
||||
OpenLayers.Element.getStyle(this.contentDiv, "padding-bottom"),
|
||||
OpenLayers.Element.getStyle(this.contentDiv, "padding-right"),
|
||||
OpenLayers.Element.getStyle(this.contentDiv, "padding-top")
|
||||
);
|
||||
|
||||
//cache the value
|
||||
this._contentDivPadding = contentDivPadding;
|
||||
|
||||
//remove the div from the page and make it visible again
|
||||
document.body.removeChild(this.div);
|
||||
this.div.style.display = "";
|
||||
}
|
||||
return contentDivPadding;
|
||||
},
|
||||
|
||||
/**
|
||||
* Method: addCloseBox
|
||||
*
|
||||
* Parameters:
|
||||
* callback - {Function} The callback to be called when the close button
|
||||
* is clicked.
|
||||
*/
|
||||
addCloseBox: function(callback) {
|
||||
|
||||
this.closeDiv = OpenLayers.Util.createDiv(
|
||||
this.id + "_close", null, new OpenLayers.Size(17, 17)
|
||||
);
|
||||
this.closeDiv.className = "olPopupCloseBox";
|
||||
|
||||
// use the content div's css padding to determine if we should
|
||||
// padd the close div
|
||||
var contentDivPadding = this.getContentDivPadding();
|
||||
|
||||
this.closeDiv.style.right = contentDivPadding.right + "px";
|
||||
this.closeDiv.style.top = contentDivPadding.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.map.paddingForPopups.left) {
|
||||
newTL.x = this.map.paddingForPopups.left;
|
||||
} else
|
||||
if ( (origTL.x + this.size.w) > (mapSize.w - this.map.paddingForPopups.right)) {
|
||||
newTL.x = mapSize.w - this.map.paddingForPopups.right - this.size.w;
|
||||
}
|
||||
|
||||
//new top (compare to margins, using this.size to calculate bottom)
|
||||
if (origTL.y < this.map.paddingForPopups.top) {
|
||||
newTL.y = this.map.paddingForPopups.top;
|
||||
} else
|
||||
if ( (origTL.y + this.size.h) > (mapSize.h - this.map.paddingForPopups.bottom)) {
|
||||
newTL.y = mapSize.h - this.map.paddingForPopups.bottom - this.size.h;
|
||||
}
|
||||
|
||||
var dx = origTL.x - newTL.x;
|
||||
var dy = origTL.y - newTL.y;
|
||||
|
||||
this.map.pan(dx, dy);
|
||||
},
|
||||
|
||||
/**
|
||||
* Method: registerEvents
|
||||
* Registers events on the popup.
|
||||
|
||||
Reference in New Issue
Block a user