Summary

No overview generated for 'Loading2.js'

/*
License: LGPL as per: http://www.gnu.org/copyleft/lesser.html
$Id: Loading2.js 3879 2008-02-27 14:20:29Z gjvoosten $
*/

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

/**
 * This widget is used to display ModelStatus messages.  This widget is used
 * like any other except that it is clreaed on the loadModel event and painted
 * on the "newModel" and "modelStatus" events.
 * Optional config parameters are an image source (usually an animated GIF) in 
 * the imageSource property, an optional static text message to be displayed as 
 * the textMessage property and if the widget is to be displayed over top of a 
 * map you can also specify the mapContainerId property.
 * Dynamic message can be displayed by listening on the "modelStatus" event which
 * sends a message as the parameter.  Send a null message param to clear the widget.
 * @constructor
 * @base WidgetBase
 * @author Mike Adair
 * @param widgetNode The widget's XML object node from the configuration document.
 * @param model The model object that this widget belongs to.
 */
function Loading2(widgetNode, model) {
  WidgetBase.apply(this,new Array(widgetNode, model));

  //loading img to be displayed  while models load
  this.imageSrc = config.skinDir + this.getProperty("mb:imageSrc", "/images/Loading.gif");

  //a text message to be displayed while models load
  this.textMessage = this.getProperty("mb:textMessage", mbGetMessage("docLoading"));
  this.updateMessage = this.textMessage;

  //check to see if this is to be put over a map if there isa mapContainerID supplied
  this.mapContainerNode = widgetNode.selectSingleNode("mb:mapContainerId");
  if (!this.mapContainerNode) {
    this.mapContainerNode = widgetNode.selectSingleNode("mb:targetModel");
  }
  if (this.mapContainerNode) {
    this.containerNodeId = getNodeValue(this.mapContainerNode);
    this.htmlTagId = this.containerNodeId;
  }

  //paint it on the "newModel" event, clear it on "loadModel" event
  this.model.addListener("newModel",this.paint, this);
  this.model.addListener("loadModel",this.clear, this);
  this.model.addListener("refresh",this.paint, this);
  this.model.addListener("modelStatus",this.update, this);
}

/**
 * Render the widget.
 * @param objRef Pointer to widget object.
 */
Loading2.prototype.paint = function(objRef) {
  var node = objRef.getNode();
  if (node) {
    //if it is a template model, no loader should be shown in the output div
    if (objRef.model.template) return;
    //if there's no url, there will never be an update on the ModelStatus, so the image stays while nothing is happening.
    if (!objRef.model.url && !objRef.mapContainerNode) return;
    //create the output node the first time this is called
    var outputNode = document.getElementById( objRef.outputNodeId+"_loading" );
    if (!outputNode) {
      outputNode = document.createElement("div");
      outputNode.setAttribute("id",objRef.outputNodeId+"_loading");
      node.appendChild(outputNode);
    }
    outputNode.className = "loadingIndicator";
    outputNode.style.zIndex = 10001;
    //In a mapcontainer you want the loader in the left top, in other widgets embedded in the output area
    if (objRef.mapContainerNode){
      outputNode.style.position="absolute";
      outputNode.style.left='0px';
      outputNode.style.top='0px';
    }
    if (objRef.imageSrc) {
      var imageNode = document.getElementById( objRef.outputNodeId+"_imageNode" );
      if (!imageNode) {
        imageNode = document.createElement("img");
        imageNode.setAttribute("id",objRef.outputNodeId+"_imageNode");
        outputNode.appendChild(imageNode);
        imageNode.style.zIndex = 10001;
      }
      imageNode.src = objRef.imageSrc;
    }
    if (objRef.updateMessage) {
      var messageNode = document.getElementById( objRef.outputNodeId+"_messageNode" );
      if (!messageNode) {
        messageNode = document.createElement("p");
        messageNode.setAttribute("id",objRef.outputNodeId+"_messageNode");
        outputNode.appendChild(messageNode);
      }
      messageNode.innerHTML = objRef.updateMessage;
    }
  }
}

/**
 * Remove the contents of the HTML tag for this widget.
 * @param objRef Reference to this object.
 */
Loading2.prototype.clear= function(objRef, message) {
  var outputNode = document.getElementById( objRef.outputNodeId+"_loading" );
  var node = objRef.getNode();
  if (node && outputNode) node.removeChild(outputNode);
}

/**
 * Updates the loading indicator with a new message as a "updateStatus" listener.
 * Send an null message to clear the loading indicator.
 * @param objRef Reference to this object.
 */
Loading2.prototype.update= function(objRef, message) {
  objRef.updateMessage = message || null;
  if (message) {
    objRef.paint(objRef);
  } else {
    objRef.clear(objRef);
  }
}