Fusion

initialize: function( options )

Initialize the Fusion application.  This method must be called from the template’s onload method once all script files have been loaded.  Applications can register for the event Fusion.Event.FUSION_INITIALIZED to carry out further application initialization when all the Fusion objects have been created and are available.

@param {Object} options

Optional paramters that can be passed to initialize are

initializeLocale: function( locale )

Initialize the Strings hash with the requested locale.  This method simply extends the OpenLayers strings hash with strings specific to Fusion.  Add strings to the files in fusion/text/[locale].json.  This method can be called before Fusion.initialize() if localized strings are required in the template initialization.

setLoadState: function( state )

set the current initialization state of the application.  Depending on the state, this will cause various scripts to be loaded.

Parameter {Integer} state

the new loading state

loadQueuedScripts: function()

load any scripts that have been queued for loading.  As the scripts load, they are removed.  When all queued scripts have been loaded, the load state is advanced.  If any of the loaded scripts require other scripts (for inheritance), they will be queued and loaded before the load state is advanced.

queueScript: function( url )

Insert a new script into the loading queue.  The URL should be relative to the Fusion base url.  The script will not actually be loaded until loadQueuedScripts is called.

Parameter: {String} url

The url of the script.

scriptFailed: function( url )

Called when a script fails to load for some reason.

Parameter: url

{String} the url that failed to load

TODO: the application probably won’t work if a script fails to load so we need to decide how to inform the user and fail gracefully.

scriptLoaded: function( url )

a script has loaded.  It is removed from the various tracking arrays.  When all requested scripts have been loaded, we check to see if any scripts where required by the ones just loaded.  If yes, then we loadQueuedScripts again, otherwise we advance the load state.

Parameter: url

{String} the url of the script that was loaded.

checkLoadingScripts: function()

check if scripts have loaded.  In IE, scripts don’t seem to fire the onload event.  Safari also seems to have some problems.

loadConfig: function()

asynchronously load the application definition.  For MapGuide, also set up the broker object.  Once the AppDef is loaded/created advance the laod state.

getConfigCB: function( r )

the server has returned the application configuration file that contains enough information to bootstrap the application.

Parameter {Object} r an XMLHttpRequest object

serverSet: function()

the server has returned the application configuration file that contains enough information to bootstrap the application.

Parameter {Object} r an XMLHttpRequest object

serverFailed: function( r )

the application failed to load the application configuration file.  Not much point in continuing, but we can inform the user why this happened.

Parameter: {Object} r

the XMLHttpRequest object

TODO: do something more useful in here?

ajaxRequest: function( scriptURL, options )

convenience function to issue an XmlHttpRequest to the server relative to the Fusion installation.

Parameter: {String} scriptURL

the URL (relative to Fusion) to request

Parameter: {Object} options

optional parameters to send with the request, passed directly to the OpenLayers Ajax.Request function

ajaxException: function( r, e )

trap exceptions produced in handling an ajax response.

Parameter: {XmlHttpRequest} r

Parameter: {Exception} e

getXmlAsJson: function( url, callback )

Convert XML to JSON using a server-side script for requests that aren’t available in JSON.

boolean indicator if the content is JSON or not.

xml2json: function( callback, r, json )

Callback method to convert the XNR response into an actual json object and triggers the call to the callback method

Parameter: callback

callback method to be executed on success and will be passed a parsed json object

Parameter: {XmlHttpRequest} r

the XmlHttpRequest object

Parameter: json

boolean indicator if the content is JSON or not (set by OpenLayers)

getMapByName: function( name )

return a map widget with the given name

Parameter: {String} name

The map name to return

Returns: {Object} a map object or null if not found.

getMapById: function( id )

return a map widget that is associated with the given DOM element by id.

Parameter: {String} id

The map id to return

Returns: {Object} a map object or null if not found.

getMapByIndice: function( indice )

return the map widget at the given index if there are more than one map elements specified in the AppDef

Parameter: {String} indice

The map indice to return

Returns: {Object} a map object or null if not found.

getWidgetById: function( id )

return a reference to a widget by the id of the DOM Element that it was created in.

Parameter: {String} id

the DOM id to get the widget for

Returns: {Fusion.Widget} the widget or null

getApplicationURL: function()

returns the applicaiton’s absolute URL minus the filename.html part

Returns: {String} a URL

getFusionURL: function()

returns the application’s absolute URL minus the filename.html part

Returns: {String} a URL

getConfigurationItem: function( arch, key )

returns individual elements out of the Fusion config.json file

Returns: {String} a the value for the key of null if not found

getScriptLanguage: function()

Accessor to return the server-side script language

Returns: {String} the script language e.g.  ‘php’

getRedirectScript: function()

Accessor to return the URL of the redirect script

Returns: {String} a URL

getBroker: function()

Accessor to return the broker object (for MapGuide only).  The broker is used to prepare various queries to the MapGuide server.

Returns: {Object} the broker object

require: function( url )

Marks a JavaScript file as required which puts it into the queue for loading during Fusion initialization.  Widget code is included through this mecahnism

Returns: none

reportError: function( o )

Triggers the Fusion.Event.FUSION_ERROR and passes along the error object to the callback functions registered for this event.  Widgets call Fusion.reportError(o) to inform the system of errors.  Applications will typically register an event listener for the error event and do something to report the error to the user.  By default, errors are not reported since there is no listener

Returns: none

unitFromName: function( unit )

returns index into the units array for the given unit name or abbreviation

Returns: {Integer} index into the units array

Given a unit, this method returns if the units system is one of

imperial, metric, degrees or device units

Returns: {String} the units system

unitName: function( unit )

Given a unit, this method returns the units name

Returns: {String} the units name

unitAbbr: function( unit )

Given a unit, this method returns the units abbreviation

Returns: {String} the units abbreviation

toMeter: function( unit, value )

Converts a length value from native units into meters.  This is the identity transform if the input units are meters

Returns: {Float} the value in meters

fromMeter: function( unit, value )

Converts a length value from meters into native units.  This is the identity transform if the native units are meters

Returns: {Float} the value in native units

convert: function( unitsIn, unitsOut, value )

Converts a length value from one unit system into another.

Returns: {Float} the value in output units

initUnits: function( metersPerUnit )

initializes the meters per unit values when a new map is loaded.  Some systems make different assumptions for the conversion of degrees to meters so this makes sure both Fusion and OpenLayers are using the same value.

getClosestUnits: function( metersPerUnit )

find the OpenLayers units identifier given the Fusion metersPerUnit value

@param metersPerUnit the value returned by LoadMap.php for meters per unit

addWidgetStyleSheet: function( url )

Dynamically load a CSS stylesheet.  The url will be prepended with the Fusion URL.

Returns: none

parseQueryString: function()

An initialization time function to parse the application URL parameters and stores them in an array.  They can be retrieved using Fusion.getQueryParam(key).

Returns: {Array} an array of the query params from when the page was loaded

getQueryParam: function( p )

Returns the query parameter value for a given parameter name

Returns: parameter value or the empty string ‘’ if not found

_getScriptLocation: function ()

Return the path to this script for bootstrapping Fusion.

Returns

{String} Path to this script

var createSessionId = function()

Pre-create a session to avoid the 401 Unauthorized dialog