Files
openlayers/lib/OpenLayers/Marker/Box.js
crschmidt f0d474e50b Change license text to point to "OpenLayers contributors", referencing
authors.txt file. In reality, MetaCarta does not own copyright to these files,
they merely have a right to distribute them under the license terms agreed to
by the contributors. At this point, there is no longer any reference to
MetaCarta as a copyright holder in the OpenLayers project, only to its
individual contributors via the authors.txt file.


git-svn-id: http://svn.openlayers.org/trunk/openlayers@10706 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2010-09-01 03:06:31 +00:00

121 lines
2.7 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/* Copyright (c) 2006-2010 by OpenLayers Contributors (see authors.txt for
* full list of contributors). Published under the Clear BSD license.
* See http://svn.openlayers.org/trunk/openlayers/license.txt for the
* full text of the license. */
/**
* @requires OpenLayers/Marker.js
*/
/**
* Class: OpenLayers.Marker.Box
*
* Inherits from:
* - <OpenLayers.Marker>
*/
OpenLayers.Marker.Box = OpenLayers.Class(OpenLayers.Marker, {
/**
* Property: bounds
* {<OpenLayers.Bounds>}
*/
bounds: null,
/**
* Property: div
* {DOMElement}
*/
div: null,
/**
* Constructor: OpenLayers.Marker.Box
*
* Parameters:
* bounds - {<OpenLayers.Bounds>}
* borderColor - {String}
* borderWidth - {int}
*/
initialize: function(bounds, borderColor, borderWidth) {
this.bounds = bounds;
this.div = OpenLayers.Util.createDiv();
this.div.style.overflow = 'hidden';
this.events = new OpenLayers.Events(this, this.div, null);
this.setBorder(borderColor, borderWidth);
},
/**
* Method: destroy
*/
destroy: function() {
this.bounds = null;
this.div = null;
OpenLayers.Marker.prototype.destroy.apply(this, arguments);
},
/**
* Method: setBorder
* Allow the user to change the box's color and border width
*
* Parameters:
* color - {String} Default is "red"
* width - {int} Default is 2
*/
setBorder: function (color, width) {
if (!color) {
color = "red";
}
if (!width) {
width = 2;
}
this.div.style.border = width + "px solid " + color;
},
/**
* Method: draw
*
* Parameters:
* px - {<OpenLayers.Pixel>}
* sz - {<OpenLayers.Size>}
*
* Returns:
* {DOMElement} A new DOM Image with this marker´s icon set at the
* location passed-in
*/
draw: function(px, sz) {
OpenLayers.Util.modifyDOMElement(this.div, null, px, sz);
return this.div;
},
/**
* Method: onScreen
*
* Rreturn:
* {Boolean} Whether or not the marker is currently visible on screen.
*/
onScreen:function() {
var onScreen = false;
if (this.map) {
var screenBounds = this.map.getExtent();
onScreen = screenBounds.containsBounds(this.bounds, true, true);
}
return onScreen;
},
/**
* Method: display
* Hide or show the icon
*
* Parameters:
* display - {Boolean}
*/
display: function(display) {
this.div.style.display = (display) ? "" : "none";
},
CLASS_NAME: "OpenLayers.Marker.Box"
});