Class MMWidget

Object
   |
   +--MMWidget

Direct Known Subclasses:

MMMenuWidget, MMCustomWidget, MMPanZoomWidget, MMOverviewWidget, MMLocationWidget, MMMapTypeWidget, MMMessageWidget

class MMWidget

Defined in MultimapOpenAPI

Constructor Detail

MMWidget

MMWidget( <MMBox> position )

The base class for all widgets. The only thing that the base class defines is that a position will be passed in. The position is defined as a box. You can specify a left, a right, a top and/or bottom.

Parameters:
position - The position within the mapviewer to place the widget at

_getElementsByTagNameClass

Object _getElementsByTagNameClass(o, n, c)

_hasCssClass

Object _hasCssClass(o, css_class)

addEventHandlers

void addEventHandlers()

draw

void draw( <MMViewer> viewer )

Sets the mapviewer that this widget is linked to.

Parameters:
viewer - The mapviewer to link the widget to.

getCalculatedDrawContainer

HTMLElement getCalculatedDrawContainer()

Retrieves the container to draw the widget in. Either uses the container property or retrieves the container from the mapviewer that the widget is linked to.

Returns:
A container to draw the widget in.

getContainer

HTMLElement getContainer( )

Retrieves the current container setting for the widget.

Returns:
The current container for the widget.

processHTML

void processHTML()

remove

void remove()

Abstract function, called when the widget needs to be removed from the viewer.

setContainer

void setContainer( <HTMLElement> container )

Sets the HTML element that you want to contain the widget.

Parameters:
container - Element that you want to contain the widget.

setPosition

void setPosition( <HTMLElement> html, <MMBox> position )

Sets the position of the widget. If no position is passed, or the position passed has no set properties the widget will not be modified at all.

Parameters:
html - The widget's HTML DOM node.
position - The position to give the widget.