Community Map Builder 27 Apr 2008

LegendGraphic.js

Summary

No overview generated for 'LegendGraphic.js'


Class Summary
LegendGraphic  

/*
License: LGPL as per: http://www.gnu.org/copyleft/lesser.html
$Id: LegendGraphic.js 3010 2007-07-25 14:09:06Z steven $
*/

// Ensure this object's dependancies are loaded.
mapbuilder.loadScript(baseDir+"/widget/WidgetBaseXSL.js");

/**
 * Functions to render and update a Legend from a Web Map Context.
 * 
 * WARNING: In most cases you probably want either Legend.js or LayerControl.js they
 * both display the legend graphic per layer.
 * @deprecated
 * @constructor
 * @base WidgetBaseXSL
 * @author Cameron Shorter cameronATshorter.net
 * @param widgetNode  The widget's XML object node from the configuration document.
 * @param model       The model object that this widget belongs to.
 */
function LegendGraphic(widgetNode, model) {
  WidgetBaseXSL.apply(this,new Array(widgetNode, model));

  this.model.addListener("hidden",this.refresh, this);
}

/**
 * Listener method to paint this widget
 * @param layerName  the name of the layer to highlight
 */
LegendGraphic.prototype.refresh = function(objRef, layerName) {
  objRef.paint(objRef, objRef.id);
}


Community Map Builder 27 Apr 2008

Documentation generated by JSDoc on Sun Apr 27 20:30:54 2008