Community Map Builder 21 Aug 2007

ContextCollection.js

Summary

No overview generated for 'ContextCollection.js'


Class Summary
ContextCollection  

/*
License: LGPL as per: http://www.gnu.org/copyleft/lesser.html
$Id: ContextCollection.js 3091 2007-08-09 12:21:54Z gjvoosten $
*/

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

/**
 * Stores a Web Map Context (WMC) Collection document as defined by the Open 
 * GIS Consortium http://opengis.org and extensions the the WMC.  
 * @constructor
 * @base ModelBase
 * @author Mike Adair
 * @param modelNode Pointer to the xml node for this model from the config file.
 * @param parent    The parent model for the object.
 */
function ContextCollection(modelNode, parent) {
  // Inherit the ModelBase functions and parameters
  ModelBase.apply(this, new Array(modelNode, parent));

  /** Insert a new context.
    * @param context An XML node which describes the context.
    * @param zindex The position to insert this context in the contextList, if set
    * to null this context will be inserted at the end.
    * @return The identifier string used to reference this context.
    */
  this.insertContext=function(context,zindex){
    //TBD Fill this in.
  }

  /** Delete this context.
   * @param id The context identifier.
   */
  this.deleteContext=function(id){
    //TBD Fill this in.
  }

  /** Move this context to a new position in the contextList.
    * @param context The context id to move.
    * @param zindex The position to move this context to in the contextList, if set
    * to null this context will be inserted at the end.
    */
  this.reorderContext=function(context,zindex){
    //TBD Fill this in.
  }

  /** Select this context for further operations 
    * @param context The context id to select.
    * @param selected Set to true/false.
    */
  this.selectContext=function(context,selected){
    for(var i=0;i<this.listeners["select"].length;i++) {
      this.listeners["select"][i][0](context,this.listeners["select"][i][1]);
    }
  }

}

Community Map Builder 21 Aug 2007

Documentation generated by JSDoc on Tue Aug 21 08:12:28 2007