Class Mapbuilder

Object
   |
   +--Mapbuilder

class Mapbuilder

Defined in Mapbuilder.js

Requires:

- Config
- Listener
- ModelBase
- Sarissa
- Util

Field Detail

loadingScripts

Object loadingScripts

Array of objects that are loading. Don't continue initialisation until all objects have loaded.

loadOrdered

Object loadOrdered

loadState

Object loadState

Determines which Mapbuilder scripts are loading. TBD: Is it possible to use enumerated types in JS?

orderedScripts

Object orderedScripts

Array of scripts that have to be loaded ordered

scriptLoader

Object scriptLoader

Timer to load ordered scripts

scriptsTimer

Object scriptsTimer

Timer to periodically check if scripts have loaded.

Popup

<static> Object Popup

Derived from OpenLayers.Popup (svn r6430) and OpenLayers.Popup.Anchored (svn r5614), this class preserves the functionality of OpenLayers.Popup.Anchored before the new style popups of http://trac.openlayers.org/ticket/926 were introduced.

Mapbuilder

Mapbuilder()

This Object bootstraps the Mapbuilder libraries by loading the core script files. When Config.js is loaded, the script files for objects described in the Mapbuilder config file are loaded. Objects which have dependencies will trigger the dependancies to load when they are loaded.

Requires:
- Config
- Listener
- ModelBase
- Sarissa
- Util
Author: Cameron Shorter

checkScriptsLoaded

void checkScriptsLoaded()

Called periodically and moves onto the next loadState when this round of scripts have loaded. For IE clients, object.readyState is used to check if scripts are loaded. Mozilla works fine without this function - I think it is single threaded.

checkScriptState

void checkScriptState(script)

readyState handler for scripts - IE only. This will remove the script from the array of scripts that have still to be loaded.

doLoadScript

void doLoadScript(script)

starts script loading by adding the script node to the dom tree - IE only. This function adds a readyState handler to the script node.

loadNextScript

void loadNextScript()

loads one script after another - only for IE. This function is run in a 50ms interval and clears its interval if there are no more scripts to load. It actually loads the first script from the orderedScripts array.

loadScript

void loadScript(url)

Dynamically load a script file if it has not already been loaded.

Parameters:
url - The url of the script. that loadScript was called

loadScriptsFromXpath

void loadScriptsFromXpath(nodes,dir)

Internal function to load scripts for components that don't have specified in the config file.

Parameters:
dir - The directory the script is located in.
xPath - Xpath match of components from the Config file.

setLoadState

void setLoadState(newState)

Move onto loading the next set of scripts.

Parameters:
newState - The new loading state.

getProperty

<static> Object getProperty(domNode, propertyName, defaultValue)

Convenience method that is used to parse dom nodes.

Parameters:
domNode - node to find the property in
propertyName - string of the property name (including namespace prefix)
defaultValue - value to return if property is not found (null by default)

Returns:
the property value

parseBoolean

<static> Object parseBoolean(value)

Convenience method to parse a string or number as a boolean value

Parameters:
value - string (true/false) or number (1/0)

Returns:
boolean value, default false