Fusion.Widget

This is the base class for all widgets.  It provides some basic functionality that all widgets should need.

Summary
Fusion.WidgetThis is the base class for all widgets.
Functions
activateActivates this widget
deactivateDeactivates this widget
shouldActivateWith
setMapset the map object that this widget is associated with
getMapaccessor to get the Map object that this widget is associated with
getMapLayeraccessor to get the implementation-specific Layer object that this widget is associated with
addControlutility method to add an {OpenLayers.Control} control to the internal {OpenLayers.Map} object
setMutExsets whether this widget is mutually exclusive on its map
isMutExaccessor to determine if the widget should be activated mutually exclusively from other widgets on the map.
getNameaccessor to return the name of the widget.
getLocationreturns the location of this widget relative to the installation of fusion.
isEnabledGets whether this widget is enabled
enabledEnables this widget.
disableDisables this widget.

Functions

activate

activate: function()

Activates this widget

deactivate

deactivate: function()

Deactivates this widget

shouldActivateWith

shouldActivateWith: function(widget)

setMap

setMap: function(oMap)

set the map object that this widget is associated with

Parameters

oMap{Fusion.Widget.Map} the map

getMap

getMap: function()

accessor to get the Map object that this widget is associated with

Return

{Fusion.Widget.Map} the map

getMapLayer

getMapLayer: function()

accessor to get the implementation-specific Layer object that this widget is associated with

Return

{<Fusion.Layers>} the implementation-specific layer

addControl

addControl: function(control)

utility method to add an {OpenLayers.Control} control to the internal {OpenLayers.Map} object

Parameters

control{OpenLayers.Control} the control to add

setMutEx

setMutEx: function(bIsMutEx)

sets whether this widget is mutually exclusive on its map

Parameters

bIsMutEx{boolean} is the widget mutually exclusive?

isMutEx

isMutEx: function()

accessor to determine if the widget should be activated mutually exclusively from other widgets on the map.

Return

{boolean} true if the widget is mutually exclusive

getName

getName: function()

accessor to return the name of the widget.  Mostly for debugging

Return

{string} the name of the widget

getLocation

getLocation: function()

returns the location of this widget relative to the installation of fusion.  Can be used to construct URLs to resources that the widget needs.

Return

{String} the location of this widget

isEnabled

isEnabled: function()

Gets whether this widget is enabled

enabled

Enables this widget.  Triggers the {<Fusion.Event.WIDGET_STATE_CHANGED>} event

disable

disable: function()

Disables this widget.  Triggers the {<Fusion.Event.WIDGET_STATE_CHANGED>} event

activate: function()
Activates this widget
deactivate: function()
Deactivates this widget
shouldActivateWith: function(widget)
setMap: function(oMap)
set the map object that this widget is associated with
getMap: function()
accessor to get the Map object that this widget is associated with
getMapLayer: function()
accessor to get the implementation-specific Layer object that this widget is associated with
addControl: function(control)
utility method to add an {OpenLayers.Control} control to the internal {OpenLayers.Map} object
Controls affect the display or behavior of the map.
Instances of OpenLayers.Map are interactive maps embedded in a web page.
setMutEx: function(bIsMutEx)
sets whether this widget is mutually exclusive on its map
isMutEx: function()
accessor to determine if the widget should be activated mutually exclusively from other widgets on the map.
getName: function()
accessor to return the name of the widget.
getLocation: function()
returns the location of this widget relative to the installation of fusion.
isEnabled: function()
Gets whether this widget is enabled
disable: function()
Disables this widget.
generic class for map widgets.
Close