Class GLOBALS

Object
   |
   +--GLOBALS

class GLOBALS

addEvent

<static> void addEvent(elementObject, eventName, functionObject)

attach an event to an element.

Parameters:
elementObject - The object.
eventName - The name of the event.
functionObject - The function to be called.

AsciiToNum

<static> Object AsciiToNum( ascii )

checkIESecurity

<static> void checkIESecurity()

copied from sarissa, a function to check browser security setting in IE, opens a help page if ActiveX objects are disabled.

cscsRequestCSDefinition

<static> void cscsRequestCSDefinition(csCode)

Attempts to retreive a Coordinate System definition, and if necessary associated projection functions, from server. Returns the Coordinate System's title on sucess, or null on failure. cscsPath must already be set and point to root of cscs library directory.

debug

<static> void debug(output)

write debugging info to a textbox onscreen.

Parameters:
output - String to be output.

degToRad

<static> Object degToRad(deg)

formatMGRS

<static> Object formatMGRS()

formatNumber

<static> Object formatNumber(aNumber, numDecimals)

get100kID

<static> Object get100kID( easting, northing, zone_number)

Get the two letter 100k designator for a given UTM easting, northing and zone number value.

get100kSetForZone

<static> Object get100kSetForZone(i)

Given a UTM zone number, figure out the MGRS 100K set it is in.

get_content

<static> Object get_content(url)

getAbsPos

<static> Object getAbsPos(elt,which)

TBD: Comment me.

Parameters:
elt - TBD
which - TBD

getAbsX

<static> Object getAbsX(elt)

getAbsY

<static> Object getAbsY(elt)

get the absolute position of HTML element NS4, IE4/5 & NS6, even if it's in a table.

Parameters:
element - The HTML element.

Returns:
Top left Y position.

getArgs

<static> Object getArgs()

parse comma-separated name=value argument pairs from the query string of the URL; the function stores name=value pairs in properties of an object and returns that object.

Returns:
args Array of arguments passed to page, in form args[argname] = value.

getGeoCoordX

<static> Object getGeoCoordX(context, xCooord)

convert screen x coordinate to geographic coordinate.

Parameters:
context - The context object.
xCoord - The screen x coordinate to be converted.

Returns:
x the converted x coordinate.

getGeoCoordY

<static> Object getGeoCoordY(yCoord)

convert screen coordinate to screen coordinate.

Parameters:
yCoord - The geographic y coordinate to be converted.
context - The context object.

Returns:
y the converted y coordinate.

getLetter100kID

<static> Object getLetter100kID( column, row, parm)

Get the two-letter MGRS 100k designator given information translated from the UTM northing, easting and zone number.

Parameters:
setColumn - the column index as it relates to the MGRS 100k set spreadsheet, created from the UTM easting. Values are 1-8.
setRow - the row index as it relates to the MGRS 100k set spreadsheet, created from the UTM northing value. Values are from 0-19.
setParm - the set block, as it relates to the MGRS 100k set spreadsheet, created from the UTM zone. Values are from 1-60.

Returns:
two letter MGRS 100k code.

getLetterDesignator

<static> Object getLetterDesignator(lat)

getNodeValue

<static> Object getNodeValue(sResult)

getNodevalue return value of node it as OpenLayers style

Parameters:
node -

Returns:
return node's value

getPageX

<static> Object getPageX(e)

get the absolute position of a user event (e.g., a mousedown).

Parameters:
e - The user event.

Returns:
Left or top position.

getPageY

<static> Object getPageY(e)

get the absolute position of a user event (e.g., a mousedown).

Parameters:
e - The user event.

Returns:
Left or top position.

getProxyPlusUrl

<static> Object getProxyPlusUrl(url)

If URL is local, then return URL unchanged, else return URL of http://proxy?url=URL , or null if proxy not defined.

Parameters:
url - Url of the file to access.

Returns:
Url of the proxy and service in the form http://host/proxy?url=service

getScreenX

<static> Object getScreenX(context, xCoord)

convert geographic x coordinate to screen coordinate.

Parameters:
context - The context object.
xCoord - The geographic x coordinate to be converted.

Returns:
x the converted x coordinate.

getScreenY

<static> Object getScreenY(context, yCoord)

convert geographic y coordinate to screen coordinate.

Parameters:
context - The context object.
yCoord - The geographic x coordinate to be converted.

Returns:
y the converted x coordinate.

handleEventWithObject

<static> void handleEventWithObject(evt)

handle event attached to an object.

Parameters:
evt - The event.

imageLoaded

<static> Object imageLoaded()

LLtoUTM

<static> Object LLtoUTM()

Converts a set of Longitude and Latitude co-ordinates to UTM given an ellipsoid

Parameters:
ellip - an ellipsoid definition.
llpoint - the coordinate to be converted
utmpoint - A UTMPoint instance to put the results in. If null, a new UTMPoint will be allocated.

Returns:
A UTM class instance containing the value of null if conversion failed. If you pass in a UTMPoint, it will be returned as well if successful.

loadCss

<static> void loadCss(cssFileName)

Dynamically loads a stylesheet into the html page.

Parameters:
cssFileName - name of the file to load, relative to config.skinDir

makeElt

<static> Object makeElt(type)

create an element and append it to the document body element.

Parameters:
type - The type of element to be created.

Returns:
node The node created and appended.

mapbuilderInit

<static> void mapbuilderInit()

Initialise Mapbuilder if script has been loaded, else wait to be called again.

mbDebugMessage

<static> void mbDebugMessage(object, message)

Show a message if the debug property of the object has been set.

Parameters:
object - the object that possibly has the debug property set
message - the message to show

mbDoLoad

<static> void mbDoLoad(initFunction)

Mapbuilder's main initialisation script. This should be called from the main html file using:

Parameters:
initFunction - Optional - A function reference that will be called after config.init() has been called. This is to give application code a chance to do initialization and be guaranteed that all objects exist (inlcuding config).

mbFormatMessage

<static> Object mbFormatMessage(messageFormat)

Format a message with the extra arguments.
E.g. if called as: mbFormatMessage("{1} is {0} {2}, {1}", "a good", "this", "test")
the formatted message returned is: "this is a good test, this"

Parameters:
messageFormat - the message format string
varArgs - optional extra parameters for formatting the message

Returns:
the formatted message

mbGetMessage

<static> Object mbGetMessage(messageKey)

Get a message from the widgetText file and format it if extra arguments are passed.

Parameters:
messageKey - the message key within the message node
varArgs - optional extra parameters for formatting the message

Returns:
"NoMsgsFound" if the widgetText file is not found,
the messageKey if the message key was not found within the message node,
the (formatted) message if it was found

MGRS

<static> Object MGRS()

NumToAscii

<static> Object NumToAscii( num )

openPopup

<static> Object openPopup(url, width, height)

open a popup window, adapted from http://www.quirksmode.org/js/croswin.html

Parameters:
url - The url of the page to be opened.
width - Width of the popup window, in pixels.
height - Height of the popup window, in pixels.

postGetLoad

<static> Object postGetLoad(sUri, docToSend, contentType , dir, fileName)

A more flexible interface for loading docs that allows POST et GET param for save model

postLoad

<static> Object postLoad(sUri, docToSend, contentType )

A more flexible interface for loading docs that allows POST and async loading

Proj

<static> Object Proj(srs)

returnTarget

<static> Object returnTarget(evt)

determine and return the target element of an event.

Parameters:
evt - The event.

Returns:
elt The element.

sld2OlStyle

<static> Object sld2OlStyle(node)

extract a style from a SLD node of an XML doc and return it as OpenLayers style

Parameters:
node - XML node containing the styled layer descriptor
objRef - reference to the map widget that will use the style

Returns:
OpenLayers style object

sld2UrlParam

<static> Object sld2UrlParam(node)

extract a style from a SLD node of an XML doc and return it as url parameter for a WMS request

Parameters:
node - XML node containing the styled layer descriptor

Returns:
WMS-compliant SLD URL parameters as array

styleValue

<static> Object styleValue(aSelector, styleKey)