Class MapPaneOL

Object
   |
   +--WidgetBase
         |
         +--MapPaneOL

class MapPaneOL

extends WidgetBase

Defined in MapPaneOL.js

Field Detail

containerNodeId

Object containerNodeId

node

Object node

MapPaneOL

MapPaneOL(widgetNode, model)

Widget to render a map from an OGC context document. The layers are rendered using http://openlayers.org .

Parameters:
widgetNode - The widget's XML object node from the configuration document.
model - The model object that this widget belongs to.

addLayer

void addLayer(objRef, layerNode)

Adds a layer into the output

Parameters:
layerName - the WMS name for the layer to be added

clearWidget2

void clearWidget2(objRef)

This function is called when a new Context is about to be loaded - it deletes all the old layers so new ones can be loaded. TBD: This should be renamed to clearWidget, except inheritence is not working if we do that and it doesn't get called.

Parameters:
objRef - Pointer to this object.

deleteAllLayers

void deleteAllLayers(objRef)

Removes all layers from the output

Parameters:
objRef - Pointer to this object.
layerName - the WMS anme for the layer to be removed

deleteLayer

void deleteLayer(objRef, layerName)

Removes a layer from the output

Parameters:
objRef - Pointer to this object.
layerName - the WMS anme for the layer to be removed

getLayer

Object getLayer(objRef,layerName)

returns layer node from LayerMgr

Parameters:
layerName - The layer Id.

getWebSafeStyle

Object getWebSafeStyle(objRef, colorNumber)

gets an OpenLayers vector style with web safe colors.

Parameters:
objRef - reference to this object
colorNumber - number of a color from which to generate websafe color

Returns:
{OpenLayers.Style} style for OpenLayers vector rendering

hidden

void hidden(objRef, layerName)

Hide/unhide a layer. Called by Context when the hidden attribute changes.

Parameters:
objRef - Pointer to widget object.
layerName - Name of the layer to hide/unhide.

moveLayerDown

void moveLayerDown(objRef, layerName)

Moves a layer up in the stack of map layers

Parameters:
objRef - Pointer to this object.
layerName - the WMS name for the layer to be removed

moveLayerUp

void moveLayerUp(objRef, layerName)

Moves a layer up in the stack of map layers

Parameters:
objRef - Pointer to this object.
layerName - the WMS anme for the layer to be removed

paint

void paint(objRef, refresh)

Render the widget.

Parameters:
objRef - Pointer to widget object.

refreshLayer

void refreshLayer(objRef, layerName , newParams)

Called for refreshing one layer.

Parameters:
objRef - This object.
layerName - The name of the layer that was toggled.

refreshWmsLayers

void refreshWmsLayers(objRef)

Called after a feature has been added to a WFS. This function triggers the WMS basemaps to be redrawn. A timestamp param is added to the URL to ensure the basemap image is not cached.

setOpacity

void setOpacity(objRef, layerName)

Called when the context's opacity attribute changes.

Parameters:
objRef - This object.
layerName - The name of the layer that was toggled.

timestampListener

void timestampListener(objRef, timestampIndex)

Called when the map timestamp is changed so set the layer visiblity.

Parameters:
objRef - This object.
timestampIndex - The array index for the layer to be displayed.

updateContext

void updateContext(e)

Event handler to keep the Mapbuilder context updated. It also sets the map cursor to the previously stored value. This is called by OpenLayers.

Parameters:
e - OpenLayers event

updateMouse

void updateMouse(e)

Restore the map cursor stored by buttons. This has to be done in an OpenLayers mouseup event, because the mouseup event in OpenLayers resets the cursor to default.

Parameters:
e - OpenLayers event