Files
openlayers/lib/OpenLayers/Marker/Box.js
tschaub b844a3b11b Happy New Year!
Updating copyright to 2012.
2012-01-03 09:01:10 -07: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-2012 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);
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"
});