diff --git a/apidoc_config/Menu.txt b/apidoc_config/Menu.txt index 425c7ebdcd..baf9502c65 100644 --- a/apidoc_config/Menu.txt +++ b/apidoc_config/Menu.txt @@ -379,7 +379,6 @@ Group: OpenLayers { File: Popup (no auto-title, OpenLayers/Popup.js) File: Anchored (no auto-title, OpenLayers/Popup/Anchored.js) - File: AnchoredBubble (no auto-title, OpenLayers/Popup/AnchoredBubble.js) File: Framed (no auto-title, OpenLayers/Popup/Framed.js) File: FramedCloud (no auto-title, OpenLayers/Popup/FramedCloud.js) } # Group: Popup diff --git a/doc_config/Menu.txt b/doc_config/Menu.txt index 14845eac23..f389877761 100644 --- a/doc_config/Menu.txt +++ b/doc_config/Menu.txt @@ -379,7 +379,6 @@ Group: OpenLayers { File: Popup (no auto-title, OpenLayers/Popup.js) File: Anchored (no auto-title, OpenLayers/Popup/Anchored.js) - File: AnchoredBubble (no auto-title, OpenLayers/Popup/AnchoredBubble.js) File: Framed (no auto-title, OpenLayers/Popup/Framed.js) File: FramedCloud (no auto-title, OpenLayers/Popup/FramedCloud.js) } # Group: Popup diff --git a/lib/OpenLayers.js b/lib/OpenLayers.js index e35dcfd1a3..31135c1c68 100644 --- a/lib/OpenLayers.js +++ b/lib/OpenLayers.js @@ -191,7 +191,6 @@ "OpenLayers/Layer/Zoomify.js", "OpenLayers/Layer/ArcGISCache.js", "OpenLayers/Popup/Anchored.js", - "OpenLayers/Popup/AnchoredBubble.js", "OpenLayers/Popup/Framed.js", "OpenLayers/Popup/FramedCloud.js", "OpenLayers/Feature.js", diff --git a/lib/OpenLayers/Popup/AnchoredBubble.js b/lib/OpenLayers/Popup/AnchoredBubble.js deleted file mode 100644 index c1c428b786..0000000000 --- a/lib/OpenLayers/Popup/AnchoredBubble.js +++ /dev/null @@ -1,196 +0,0 @@ -/* Copyright (c) 2006-2013 by OpenLayers Contributors (see authors.txt for - * full list of contributors). Published under the 2-clause BSD license. - * See license.txt in the OpenLayers distribution or repository for the - * full text of the license. */ - - -/** - * @requires OpenLayers/Popup/Anchored.js - * @requires OpenLayers/Console.js - * @requires Rico/Corner.js - */ - -/** - * Class: OpenLayers.Popup.AnchoredBubble - * This class is *deprecated*. Use {} and - * round corners using CSS3's border-radius property. - * - * Inherits from: - * - - */ -OpenLayers.Popup.AnchoredBubble = - OpenLayers.Class(OpenLayers.Popup.Anchored, { - - /** - * Property: rounded - * {Boolean} Has the popup been rounded yet? - */ - rounded: false, - - /** - * Constructor: OpenLayers.Popup.AnchoredBubble - * - * Parameters: - * id - {String} - * lonlat - {} - * contentSize - {} - * contentHTML - {String} - * anchor - {Object} Object to which we'll anchor the popup. Must expose - * a 'size' () and 'offset' () - * (Note that this is generally an ). - * closeBox - {Boolean} - * closeBoxCallback - {Function} Function to be called on closeBox click. - */ - initialize:function(id, lonlat, contentSize, contentHTML, anchor, closeBox, - closeBoxCallback) { - - OpenLayers.Console.warn('AnchoredBubble is deprecated'); - - this.padding = new OpenLayers.Bounds( - 0, OpenLayers.Popup.AnchoredBubble.CORNER_SIZE, - 0, OpenLayers.Popup.AnchoredBubble.CORNER_SIZE - ); - OpenLayers.Popup.Anchored.prototype.initialize.apply(this, arguments); - }, - - /** - * Method: draw - * - * Parameters: - * px - {} - * - * Returns: - * {DOMElement} Reference to a div that contains the drawn popup. - */ - draw: function(px) { - - OpenLayers.Popup.Anchored.prototype.draw.apply(this, arguments); - - this.setContentHTML(); - - //set the popup color and opacity - this.setBackgroundColor(); - this.setOpacity(); - - return this.div; - }, - - /** - * Method: updateRelativePosition - * The popup has been moved to a new relative location, in which case - * we will want to re-do the rico corners. - */ - updateRelativePosition: function() { - this.setRicoCorners(); - }, - - /** - * APIMethod: setSize - * - * Parameters: - * contentSize - {} the new size for the popup's - * contents div (in pixels). - */ - setSize:function(contentSize) { - OpenLayers.Popup.Anchored.prototype.setSize.apply(this, arguments); - - this.setRicoCorners(); - }, - - /** - * APIMethod: setBackgroundColor - * - * Parameters: - * color - {String} - */ - setBackgroundColor:function(color) { - if (color != undefined) { - this.backgroundColor = color; - } - - if (this.div != null) { - if (this.contentDiv != null) { - this.div.style.background = "transparent"; - OpenLayers.Rico.Corner.changeColor(this.groupDiv, - this.backgroundColor); - } - } - }, - - /** - * APIMethod: setOpacity - * - * Parameters: - * opacity - {float} - */ - setOpacity:function(opacity) { - OpenLayers.Popup.Anchored.prototype.setOpacity.call(this, opacity); - - if (this.div != null) { - if (this.groupDiv != null) { - OpenLayers.Rico.Corner.changeOpacity(this.groupDiv, - this.opacity); - } - } - }, - - /** - * Method: setBorder - * Always sets border to 0. Bubble Popups can not have a border. - * - * Parameters: - * border - {Integer} - */ - setBorder:function(border) { - this.border = 0; - }, - - /** - * Method: setRicoCorners - * Update RICO corners according to the popup's current relative postion. - */ - setRicoCorners:function() { - - var corners = this.getCornersToRound(this.relativePosition); - var options = {corners: corners, - color: this.backgroundColor, - bgColor: "transparent", - blend: false}; - - if (!this.rounded) { - OpenLayers.Rico.Corner.round(this.div, options); - this.rounded = true; - } else { - OpenLayers.Rico.Corner.reRound(this.groupDiv, options); - //set the popup color and opacity - this.setBackgroundColor(); - this.setOpacity(); - } - }, - - /** - * Method: getCornersToRound - * - * Returns: - * {String} The proper corners string ("tr tl bl br") for rico to round. - */ - getCornersToRound:function() { - - var corners = ['tl', 'tr', 'bl', 'br']; - - //we want to round all the corners _except_ the opposite one. - var corner = OpenLayers.Bounds.oppositeQuadrant(this.relativePosition); - OpenLayers.Util.removeItem(corners, corner); - - return corners.join(" "); - }, - - CLASS_NAME: "OpenLayers.Popup.AnchoredBubble" -}); - -/** - * Constant: CORNER_SIZE - * {Integer} 5. Border space for the RICO corners. - */ -OpenLayers.Popup.AnchoredBubble.CORNER_SIZE = 5; - diff --git a/lib/deprecated.js b/lib/deprecated.js index a389dc7b62..a492faa581 100644 --- a/lib/deprecated.js +++ b/lib/deprecated.js @@ -22,6 +22,8 @@ * @requires OpenLayers/Format/XML.js * @requires OpenLayers/Geometry.js * @requires OpenLayers/Renderer/Elements.js + * @requires OpenLayers/Popup/Anchored.js + * @requires Rico/Corner.js */ /** @@ -5656,4 +5658,185 @@ OpenLayers.Renderer.SVG2.LABEL_VFACTOR = { */ OpenLayers.Renderer.SVG2.preventDefault = function(e) { e.preventDefault && e.preventDefault(); -}; \ No newline at end of file +}; + +/** + * Class: OpenLayers.Popup.AnchoredBubble + * This class is *deprecated*. Use {} and + * round corners using CSS3's border-radius property. + * + * Inherits from: + * - + */ +OpenLayers.Popup.AnchoredBubble = OpenLayers.Class(OpenLayers.Popup.Anchored, { + + /** + * Property: rounded + * {Boolean} Has the popup been rounded yet? + */ + rounded: false, + + /** + * Constructor: OpenLayers.Popup.AnchoredBubble + * + * Parameters: + * id - {String} + * lonlat - {} + * contentSize - {} + * contentHTML - {String} + * anchor - {Object} Object to which we'll anchor the popup. Must expose + * a 'size' () and 'offset' () + * (Note that this is generally an ). + * closeBox - {Boolean} + * closeBoxCallback - {Function} Function to be called on closeBox click. + */ + initialize:function(id, lonlat, contentSize, contentHTML, anchor, closeBox, + closeBoxCallback) { + + this.padding = new OpenLayers.Bounds( + 0, OpenLayers.Popup.AnchoredBubble.CORNER_SIZE, + 0, OpenLayers.Popup.AnchoredBubble.CORNER_SIZE + ); + OpenLayers.Popup.Anchored.prototype.initialize.apply(this, arguments); + }, + + /** + * Method: draw + * + * Parameters: + * px - {} + * + * Returns: + * {DOMElement} Reference to a div that contains the drawn popup. + */ + draw: function(px) { + + OpenLayers.Popup.Anchored.prototype.draw.apply(this, arguments); + + this.setContentHTML(); + + //set the popup color and opacity + this.setBackgroundColor(); + this.setOpacity(); + + return this.div; + }, + + /** + * Method: updateRelativePosition + * The popup has been moved to a new relative location, in which case + * we will want to re-do the rico corners. + */ + updateRelativePosition: function() { + this.setRicoCorners(); + }, + + /** + * APIMethod: setSize + * + * Parameters: + * contentSize - {} the new size for the popup's + * contents div (in pixels). + */ + setSize:function(contentSize) { + OpenLayers.Popup.Anchored.prototype.setSize.apply(this, arguments); + + this.setRicoCorners(); + }, + + /** + * APIMethod: setBackgroundColor + * + * Parameters: + * color - {String} + */ + setBackgroundColor:function(color) { + if (color != undefined) { + this.backgroundColor = color; + } + + if (this.div != null) { + if (this.contentDiv != null) { + this.div.style.background = "transparent"; + OpenLayers.Rico.Corner.changeColor(this.groupDiv, + this.backgroundColor); + } + } + }, + + /** + * APIMethod: setOpacity + * + * Parameters: + * opacity - {float} + */ + setOpacity:function(opacity) { + OpenLayers.Popup.Anchored.prototype.setOpacity.call(this, opacity); + + if (this.div != null) { + if (this.groupDiv != null) { + OpenLayers.Rico.Corner.changeOpacity(this.groupDiv, + this.opacity); + } + } + }, + + /** + * Method: setBorder + * Always sets border to 0. Bubble Popups can not have a border. + * + * Parameters: + * border - {Integer} + */ + setBorder:function(border) { + this.border = 0; + }, + + /** + * Method: setRicoCorners + * Update RICO corners according to the popup's current relative postion. + */ + setRicoCorners:function() { + + var corners = this.getCornersToRound(this.relativePosition); + var options = {corners: corners, + color: this.backgroundColor, + bgColor: "transparent", + blend: false}; + + if (!this.rounded) { + OpenLayers.Rico.Corner.round(this.div, options); + this.rounded = true; + } else { + OpenLayers.Rico.Corner.reRound(this.groupDiv, options); + //set the popup color and opacity + this.setBackgroundColor(); + this.setOpacity(); + } + }, + + /** + * Method: getCornersToRound + * + * Returns: + * {String} The proper corners string ("tr tl bl br") for rico to round. + */ + getCornersToRound:function() { + + var corners = ['tl', 'tr', 'bl', 'br']; + + //we want to round all the corners _except_ the opposite one. + var corner = OpenLayers.Bounds.oppositeQuadrant(this.relativePosition); + OpenLayers.Util.removeItem(corners, corner); + + return corners.join(" "); + }, + + CLASS_NAME: "OpenLayers.Popup.AnchoredBubble" +}); + +/** + * Constant: CORNER_SIZE + * {Integer} 5. Border space for the RICO corners. + */ +OpenLayers.Popup.AnchoredBubble.CORNER_SIZE = 5; diff --git a/notes/2.13.md b/notes/2.13.md index d6eb93ef5e..6f5ee7ac86 100644 --- a/notes/2.13.md +++ b/notes/2.13.md @@ -132,4 +132,15 @@ run 'build.py -h' for more details Corresponding issue/pull requests: -* https://github.com/openlayers/openlayers/pull/528 \ No newline at end of file +* https://github.com/openlayers/openlayers/pull/528 + +## Deprecated Components +A number of properties, methods, and constructors have been marked as +deprecated for multiple releases in the 2.x series. +For the 2.13 release this deprecated functionality has been moved to a +separate deprecated.js file. If you use any of the constructors or +methods below, you will have to explicitly include the deprecated.js +file in your build (or add it in a separate ` + + diff --git a/tests/list-tests.html b/tests/list-tests.html index 3236c507d6..b8910c3626 100644 --- a/tests/list-tests.html +++ b/tests/list-tests.html @@ -193,7 +193,6 @@
  • SingleFile3.html
  • Popup.html
  • Popup/Anchored.html
    • -
  • Popup/AnchoredBubble.html
  • Popup/FramedCloud.html
  • Projection.html
  • Protocol.html
    • @@ -250,6 +249,7 @@
  • deprecated/Layer/WFS.html
  • deprecated/Layer/WMS.html
  • deprecated/Layer/WMS/Post.html
    • +
  • deprecated/Popup/AnchoredBubble.html
  • deprecated/Protocol/SQL.html
  • deprecated/Protocol/SQL/Gears.html
  • deprecated/Renderer/SVG2.html