com.lamatek.tags.google
Class GoogleMapTag

java.lang.Object
  BodyTagSupport
      com.lamatek.tags.google.GoogleMapTag

All Implemented Interfaces:

GoogleMapEventListener, java.io.Serializable

public class GoogleMapTag
extends BodyTagSupport
implements java.io.Serializable, GoogleMapEventListener

GoogleMapTag This class represents a <googlemaps;map> tag. Developers should not subclass or override this class or it's methods.

Version:

0.40

Author:

Tom Cole

Constructor Summary

GoogleMapTag()

Method Summary

void	addBox(GoogleMapBoxTag box) Adds a new GoogleMapBoxTag to this map.
void	addCircle(GoogleMapCircleTag circle) Adds a new GoogleMapCircleTag to this map.
void	addCoordinates(GoogleMapCoordinatesTag coords) Adds a GoogleMapCoordinatesTag to the map.
void	addEvent(GoogleMapEventTag event) Adds a new GoogleMapEventTag to this map.
void	addImageOverlay(GoogleMapImageOverlayTag image) Adds a new image overlay to this map.
void	addInsert(GoogleMapInsertTag insert) Adds an insert to this map.
void	addKey(GoogleMapKeyTag key) Adds a new GoogleMapKeyTag to this map.
void	addLabel(GoogleMapLabelTag label) Adds a label to this map.
void	addMapType(GoogleMapMapTypeTag mapType) Adds a map type to the map storing it by id.
void	addMarker(GoogleMapMarkerTag marker) This method adds a GoogleMapMarkerTag to the map.
void	addPoint(GoogleMapPointTag point) Adds a new GoogleMapPointTag to this map.
void	addPolygon(GoogleMapPolygonTag polygon) Adds a new GoogleMapPolygonTag to this map.
void	addPolyline(GoogleMapPolylineTag polyline) Adds a new GoogleMapPolylineTag to this map.
void	addTraffic_tag(GoogleMapTrafficTag traffic) Adds a new GoogleMapTrafficTag to this map.
void	addWMSTag(GoogleMapWMSTag tag) Adds a wms tag to this map.
void	deleteInsert(GoogleMapInsertTag insert) Removes an insert from the map.
void	deleteLabel(GoogleMapLabelTag label) Removes aa label from the map.
int	doEndTag() Overrides doEndTag from BodyTagSupport.
int	doStartTag() Overrides doStartTag from BodyTagSupport.
void	generateDivTag(GoogleMapDivTag div) Generates the <div> tag that represents the actual map.
void	generateInitializationCode() Generates the javascript code that initializes the map.
void	generateJavascript() Generates the complex javascript/AJAX code the map needs to function.
void	generateScriptTag() Generates the <script> tag that imports the Google Maps API code.
java.lang.String	getBody() Returns the map's body contents.
GoogleMapBoxTag	getBox(java.lang.String name) Retrieves a GoogleMapBoxtag by it's id.
java.util.Hashtable	getBoxes() Returns the list of GoogleMapBoxTags that have been added to this map.
double	getCenterLatitude() Returns the latitude (in decimal form) of the map's current centerpoint.
double	getCenterLongitude() Returns the longitude (in decimal form) of the map's current centerpoint.
GoogleMapCircleTag	getCircle(java.lang.String name) Retrieves a GoogleMapCircletag by it's id.
java.util.Hashtable	getCircles() Returns the list of GoogleMapCircleTags that have been added to this map.
GoogleMapClusterTag	getClusterer() Returns the current clusterer tag, or null if not defined.
java.util.Vector	getEvents() Returns the list of all GoogleMapEventTags supported by this map.
java.lang.String	getHeight() Returns the height of this map in pixels.
java.lang.String	getId() Returns the id of this map.
GoogleMapImageOverlayTag	getImageOverlay(java.lang.String name) Retrieves a GoogleMapImageOverlayTag by it's id.
java.util.Hashtable	getImageOverlays() Returns the list of GoogleMapImageOverlayTags that have been added to this map.
java.util.Vector	getInserts() Returns the list of map inserts in a Vector.
java.util.Hashtable	getKeys() Returns the list of GoogleMapKeyTags that have been added to this map.
java.util.Vector	getLabels() Returns the list of map labels in a Vector.
java.lang.String	getLanguage() Returns the currently designated default language.
double	getLargeLat() Returns the largest latitude (in decimal form) of all points stored in this map.
double	getLargeLon() Returns the largest longitude (in decimal form) of all points located within this map.
GoogleMapMapTypeTag	getMapType(java.lang.String id) Returns the GoogleMapMapTypeTag with the given id or null if it cannot be found.
java.util.Hashtable	getMapTypes() Returns a list of all the GoogleMapMapTypeTags to be rendered by this map.
GoogleMapMarkerTag	getMarker(java.lang.String name) Retrieves a GoogleMapMarkerTag by it's id.
java.util.Hashtable	getMarkers() Returns a list of all GoogleMapMarkerTags added to this map, keyed on their ids.
int	getMaxZoom() Returns the maximum allowable zoom level for this map.
GoogleMapMessageTag	getMessage() Returns the current message tag, or null if not defined.
int	getMinZoom() Returns the minimum allowable zoom level for this map.
GoogleMapOverviewTag	getOverviewControl() Returns the currently defined GoogleMapOverviewTag defined for this map.
java.util.Hashtable	getPoints() Returns a list of all the GoogleMapPointTags added to this map.
GoogleMapPolygonTag	getPolygon(java.lang.String name) Retrieves a GoogleMapPolygonTag by it's id.
java.util.Hashtable	getPolygons() Returns a list of all the GoogleMapPolygonTags to be rendered by this map.
GoogleMapPolylineTag	getPolyline(java.lang.String name) Retrieves a GoogleMapPolylineTag by it's id.
java.util.Hashtable	getPolylines() Returns a list of all the GoogleMapPolylineTags to be rendered by this map.
java.lang.String	getScope() Returns the scope of this map ("site" | "page").
double	getSmallLat() Returns the smalles latitude (in decimal form) of all points in this map.
double	getSmallLon() Returns the smalles longitude (in decimal form) of all points in this map.
java.lang.String	getType() Returns the current map type (map | satellite | hybrid).
java.lang.String	getVersion() Returns the version of the Google Maps API used by this map.
java.lang.String	getWidth() Returns the width of this map in pixels.
GoogleMapWMSTag	getWms(java.lang.String id) Returns a GoogleMapWMSTag with the given id, or null if a tag with that id is not present.
java.util.Hashtable	getWmsTypes() Returns a Hashtable of GoogleMapWMSTags, keyed by id, or null if none exist in this map.
java.lang.String	getXml() Returns the URL to the XML file or generator that is to provide map data for points, overlays and events for this map.
int	getZoom() Returns the current zoom level of this map.
int	getZoomControlSize() Returns the zoom control size for this map.
boolean	isBound() Returns whether or not this map is bound to it's contents.
boolean	isDebug() Denotes whether or not debugging is turned on for this map.
boolean	isHeadless() Denotes whether or not this map is in headless mode.
boolean	isMouseWheelSupport() Denotes whether or not this map supports mouseWheel zoom control.
boolean	isPanEnabled() Denotes whether or not pan control is enabled.
boolean	isShowDaylight() Denotes whether or not the map is set to display current day and nighttime light conditions.
boolean	isShowPanControl() Denotes whether or not this map shows pan controls.
boolean	isShowScaleControl() Denotes whether or not this map displays a scale.
boolean	isShowTypeControl() Denotes whether or not this map shows type controls.
boolean	isShowZoomControl() Denotes whether ot not this map shows zoom controls.
void	removeMapType(java.lang.String id) Removes the map type with the given id.
void	removeMarker(GoogleMapMarkerTag marker) Removes a previously added GoogleMapMarkerTag from this map.
void	setBody(java.lang.String body) Sets the body content of the map.
void	setBound(boolean bound) Sets the bound state of this map.
void	setBoxes(java.util.Hashtable boxes) Sets the GoogleMapBoxTag boxes to be rendered by this map.
void	setCenterLatitude(double latitude) Sets the latitude of the map's centerpoint.
void	setCenterLongitude(double longitude) Sets the longitude of the map's centerpoint.
void	setCircles(java.util.Hashtable circles) Sets the GoogleMapCircleTags to be rendered by this map.
void	setClusterer(GoogleMapClusterTag clusterer) Sets the cluster tag to used to cluster markers.
void	setDebug(boolean debug) Turns debugging on or off for this map.
void	setEvents(java.util.Vector events) Sets the list of GoogleMapEventTags supported by this map.
void	setHeadless(boolean headless) Sets headless mode for this map.
void	setHeight(java.lang.String height) Sets the width of this map in pixels.
void	setId(java.lang.String id) Sets the id for this map.
void	setImageOverlays(java.util.Hashtable images) Sets the GoogleMapImageOverlayTags to be rendered by this map.
void	setInserts(java.util.Vector inserts) Sets the list of inserts to display on the map.
void	setKeys(java.util.Hashtable keys) Sets the list of GoogleMapKeyTags for this map.
void	setLabels(java.util.Vector labels) Sets the list of labels to display on the map.
void	setLanguage(java.lang.String language) Sets the desired default 2-digit language code.
void	setLargeLat(double largeLat) Sets the largest latitude (in decimal form) for this map.
void	setLargeLon(double largeLon) Sets the largest longitude (in decimal form) for this map.
void	setMapTypes(java.util.Hashtable mapTypes) Sets the list of GoogleMapMapTypeTags to be rendered by this map.
void	setMarkers(java.util.Hashtable markers) Sets the list of the GoogleMapMarkerTags to be rendered by this map.
void	setMaxZoom(int maxZoom) Sets the maximum allowable zoom level for this map.
void	setMessage(GoogleMapMessageTag message) Sets the message tag to display when loading or when actions are fired.
void	setMinZoom(int minZoom) Sets the minimum allowable zoom level for this map.
void	setMouseWheelSupport(boolean mouseWheelSupport) Sets whether or not to generate the javascript needed to support mousewheel zoom control.
void	setOverviewControl(GoogleMapOverviewTag overviewControl) Sets the GoogleMapOverviewTag to use for this map.
void	setPanControl(GoogleMapPanControlTag control) Sets the singleton GoogleMapPanControlTag used by this map.
void	setPanEnabled(boolean panEnabled) Sets whether or not users should be able to pan the map.
void	setPoints(java.util.Hashtable points) Sets the list of GoogleMapPointTags to be used by overlays in this map.
void	setPolygons(java.util.Hashtable polygons) Sets the list of GoogleMapPolygonTags to be rendered by this map.
void	setPolylines(java.util.Hashtable polylines) Sets the list of GoogleMapPolylineTags to be rendered by this map.
void	setScaleControl(GoogleMapScaleControlTag control) Sets the singleton GoogleMapScaleControlTag used by this map.
void	setScope(java.lang.String scope) Sets the scope of the map.
void	setShowDaylight(boolean showDaylight) Allows the map to display where the current day/night conditions are.
void	setShowPanControl(boolean showPanControl) Sets whether or not to generate the javascript needed to show the pan control.
void	setShowScaleControl(boolean showScaleControl) Sets whether or not this map should display a scale control.
void	setShowTypeControl(boolean showTypeControl) Sets whether or not to generate the javascript needed to show the type control.
void	setShowZoomControl(boolean showZoomControl) Sets whether or not to generate the javascript needed to show the zoom control.
void	setSmallLat(double smallLat) Sets the smallest latitude (in decimal form) of all points in this map.
void	setSmallLon(double smallLon) Sets the smallest longitude (in decimal form) of all points in this map.
void	setType(java.lang.String type) Sets the map type (map | satellite | hybrid) to display.
void	setTypeControl(GoogleMapTypeControlTag control) Sets the singleton GoogleMapTypeControlTag used by this map.
void	setVersion(java.lang.String version) Sets the Google Maps API version to use.
void	setWheelControl(GoogleMapWheelControlTag control) Sets the singleton GoogleMapWheelControlTag used by this map.
void	setWidth(java.lang.String width) Sets the width of this map in pixels.
void	setXml(java.lang.String xml) Sets the URL for the XML file or generator that is to provide map data for points, overlays and events for this map.
void	setZoom(int zoom) Set the zoom level of the map.
void	setZoomControl(GoogleMapZoomControlTag control) Sets the singleton GoogleMapZoomControlTag used by this map.
void	setZoomControlSize(int zoomControlSize) Sets the zoom control size.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GoogleMapTag

public GoogleMapTag()

Method Detail

doStartTag

public int doStartTag()

Overrides doStartTag from BodyTagSupport. Developers should not override this method.

doEndTag

public int doEndTag()

Overrides doEndTag from BodyTagSupport. Developers should not override this method.

addMarker

public void addMarker(GoogleMapMarkerTag marker)

This method adds a GoogleMapMarkerTag to the map.

Parameters:

marker - An initialized GoogleMapMarkerTag.

removeMarker

public void removeMarker(GoogleMapMarkerTag marker)

Removes a previously added GoogleMapMarkerTag from this map.

Parameters:

marker - The GoogleMapMarkerTag to remove.

getMarker

public GoogleMapMarkerTag getMarker(java.lang.String name)

Retrieves a GoogleMapMarkerTag by it's id.

Parameters:

name - The id of the GoogleMapMarkerTag to retrieve.

Returns:

The GoogleMapMarkerTag with this id, or null.

addMapType

public void addMapType(GoogleMapMapTypeTag mapType)

Adds a map type to the map storing it by id.

Parameters:

mapType - An initialized GoogleMapMapTypeTag

getMapType

public GoogleMapMapTypeTag getMapType(java.lang.String id)

Returns the GoogleMapMapTypeTag with the given id or null if it cannot be found.

Returns:

A GoogleMapMapTypeTag with the given id or null.

removeMapType

public void removeMapType(java.lang.String id)

Removes the map type with the given id.

Parameters:

id - The id of the map type to remove.

getBox

public GoogleMapBoxTag getBox(java.lang.String name)

Retrieves a GoogleMapBoxtag by it's id.

Parameters:

name - The id of the GoogleMapBoxTag to retrieve.

Returns:

A GoogleMapBoxTag with the given id or null.

getCircle

public GoogleMapCircleTag getCircle(java.lang.String name)

Retrieves a GoogleMapCircletag by it's id.

Parameters:

name - The id of the GoogleMapCircleTag to retrieve.

Returns:

A GoogleMapCircleTag with the given id or null.

getImageOverlay

public GoogleMapImageOverlayTag getImageOverlay(java.lang.String name)

Retrieves a GoogleMapImageOverlayTag by it's id.

Parameters:

name - the id of the GoogleMapImageOvelay to retrieve.

Returns:

A GoogleMapImageOverlayTag with the given id, or null.

getPolygon

public GoogleMapPolygonTag getPolygon(java.lang.String name)

Retrieves a GoogleMapPolygonTag by it's id.

Parameters:

name - The id of the GoogleMapPolygonTag to retrieve.

Returns:

A GoogleMapPolygonTag with the given id or null.

getPolyline

public GoogleMapPolylineTag getPolyline(java.lang.String name)

Retrieves a GoogleMapPolylineTag by it's id.

Parameters:

name - The id of the GoogleMapPolylineTag to retrieve.

Returns:

A GoogleMapPolylineTag with the given id or null.

addPoint

public void addPoint(GoogleMapPointTag point)

Adds a new GoogleMapPointTag to this map. GoogleMapPointTags are used as location references for all overlays (markers, circles, boxes, polygons and polylines) in a map.

Parameters:

point - The initialized GoogleMapPointTag to add.

addCircle

public void addCircle(GoogleMapCircleTag circle)

Adds a new GoogleMapCircleTag to this map.

Parameters:

circle - The initialized GoogleMapCircleTag to add.

addImageOverlay

public void addImageOverlay(GoogleMapImageOverlayTag image)

Adds a new image overlay to this map.

Parameters:

image - The initialized GoogleMapImageOverlayTag to add.

addTraffic_tag

public void addTraffic_tag(GoogleMapTrafficTag traffic)

Adds a new GoogleMapTrafficTag to this map.

Parameters:

traffic_tag - The initialized GoogleMapTrafficTag to add.

addPolygon

public void addPolygon(GoogleMapPolygonTag polygon)

Adds a new GoogleMapPolygonTag to this map.

Parameters:

polygon - The initialized GoogleMapPolygonTag to add.

addPolyline

public void addPolyline(GoogleMapPolylineTag polyline)

Adds a new GoogleMapPolylineTag to this map.

Parameters:

polyline - The initialized GoogleMapPolylineTag to add.

addBox

public void addBox(GoogleMapBoxTag box)

Adds a new GoogleMapBoxTag to this map.

Parameters:

box - The initialized GoogleMapBoxTag to add.

addEvent

public void addEvent(GoogleMapEventTag event)

Adds a new GoogleMapEventTag to this map.

Specified by:

addEvent in interface GoogleMapEventListener

Parameters:

event - The initialized GoogleMapEventTag to add.

addKey

public void addKey(GoogleMapKeyTag key)

Adds a new GoogleMapKeyTag to this map.

Parameters:

key - The initialized GoogleMapKeyTag to add.

setPanControl

public void setPanControl(GoogleMapPanControlTag control)

Sets the singleton GoogleMapPanControlTag used by this map.

Parameters:

control - The initialized GoogleMapPanControlTag to add.

setWheelControl

public void setWheelControl(GoogleMapWheelControlTag control)

Sets the singleton GoogleMapWheelControlTag used by this map.

Parameters:

control - The initialized GoogleMapWheelControlTag to add.

setTypeControl

public void setTypeControl(GoogleMapTypeControlTag control)

Sets the singleton GoogleMapTypeControlTag used by this map.

Parameters:

control - The initialized GoogleMapTypeControlTag to add.

setScaleControl

public void setScaleControl(GoogleMapScaleControlTag control)

Sets the singleton GoogleMapScaleControlTag used by this map.

Parameters:

control - The initialized GoogleMapScaleControlTag to add.

setZoomControl

public void setZoomControl(GoogleMapZoomControlTag control)

Sets the singleton GoogleMapZoomControlTag used by this map.

Parameters:

control - The initialized GoogleMapZoomControlTag to add.

setHeight

public void setHeight(java.lang.String height)

Sets the width of this map in pixels.

Parameters:

height - The heigt of this map in pixels.

setId

public void setId(java.lang.String id)

Sets the id for this map. The id is used by the output tags (script, javascript, div and initialize tags) to locate this map.

Parameters:

id - The id for this map.

setType

public void setType(java.lang.String type)

Sets the map type (map | satellite | hybrid) to display.

Parameters:

type - The map type to display (map | satellite | hybrid).

setVersion

public void setVersion(java.lang.String version)

Sets the Google Maps API version to use. If set to a whole number (1 or 2) the currently available stable version is used. If set to a specific version (like 2.39) then that version will be attempted to load.

Parameters:

version - The API version to load.

setWidth

public void setWidth(java.lang.String width)

Sets the width of this map in pixels.

Parameters:

width - The width of the map in pixels.

setMouseWheelSupport

public void setMouseWheelSupport(boolean mouseWheelSupport)

Sets whether or not to generate the javascript needed to support mousewheel zoom control. This option currently only works when using version 1.x APIs. This is set automatically when the setWheelControl method is called.

Parameters:

mouseWheelSupport - Set to true (to enable) or false (to disable) mousewheel zoom support.

setShowPanControl

public void setShowPanControl(boolean showPanControl)

Sets whether or not to generate the javascript needed to show the pan control. This is set automcatically when the setPanControl method is called.

Parameters:

showPanControl - Set to true (to enable) or false (to disable) pan controls.

setShowTypeControl

public void setShowTypeControl(boolean showTypeControl)

Sets whether or not to generate the javascript needed to show the type control. This is set automcatically when the setTypeControl method is called.

Parameters:

showTypeControl - Set to true (to enable) or false (to disable) type controls.

setShowZoomControl

public void setShowZoomControl(boolean showZoomControl)

Sets whether or not to generate the javascript needed to show the zoom control. This is set automcatically when the setZoomControl method is called.

Parameters:

showZoomControl - Set to true (to enable) or false (to disable) zoom controls.

setZoom

public void setZoom(int zoom)

Set the zoom level of the map.

Parameters:

zoom - The zoom level of the map.

setScope

public void setScope(java.lang.String scope)

Sets the scope of the map. If set to "site" then the map is stored in the session. If set to "page" then the map is stored in the pageContext.

Parameters:

scope - The scope where to store the map data.

setBody

public void setBody(java.lang.String body)

Sets the body content of the map. This can be used by advanced developers to add javascript controls to the map. Nearly all implementations will not have a body. This should only be used by advanced javascript developers.

Parameters:

body - The body content for this map.

setCenterLatitude

public void setCenterLatitude(double latitude)

Sets the latitude of the map's centerpoint. This is typically calculated automatically through the points added to the map.

Parameters:

latitude - The latitude (in decimal form) to use as the centerpoint for the map.

setCenterLongitude

public void setCenterLongitude(double longitude)

Sets the longitude of the map's centerpoint. This is typically calculated automatically through the points added to the map.

Parameters:

longitude - The longitude (in decimal form) to use as the centerpoint for the map.

generateDivTag

public void generateDivTag(GoogleMapDivTag div)

Generates the <div> tag that represents the actual map. This method is called by GoogleMapDivTag (<googlemaps:div>).

Parameters:

div - The GoogleMapDivTag that renders the output.

generateScriptTag

public void generateScriptTag()

Generates the <script> tag that imports the Google Maps API code. Developers should not override this method.

generateInitializationCode

public void generateInitializationCode()

Generates the javascript code that initializes the map. Developers should not override this method.

generateJavascript

public void generateJavascript()

Generates the complex javascript/AJAX code the map needs to function. Developers should not override this method.

getBoxes

public java.util.Hashtable getBoxes()

Returns the list of GoogleMapBoxTags that have been added to this map.

Returns:

A Hashtable that contains all the GoogleMapBoxTags in this map keyed by id.

setBoxes

public void setBoxes(java.util.Hashtable boxes)

Sets the GoogleMapBoxTag boxes to be rendered by this map.

Parameters:

boxes - A Hashtable of GoogleMapBoxTags.

getCircles

public java.util.Hashtable getCircles()

Returns the list of GoogleMapCircleTags that have been added to this map.

Returns:

A Hashtable that contains all the GoogleMapCircleTags in this map keyed by id.

getImageOverlays

public java.util.Hashtable getImageOverlays()

Returns the list of GoogleMapImageOverlayTags that have been added to this map.

Returns:

A Hahtable that contains all the GoogleMapImageOverlayTags in this map, keyed by id.

setCircles

public void setCircles(java.util.Hashtable circles)

Sets the GoogleMapCircleTags to be rendered by this map.

Parameters:

circles - A Hashtable of GoogleMapCircleTags keyed by id.

setImageOverlays

public void setImageOverlays(java.util.Hashtable images)

Sets the GoogleMapImageOverlayTags to be rendered by this map.

Parameters:

images - A Hahtable of GoogleMapImageOverlayTags keyed by id.

getKeys

public java.util.Hashtable getKeys()

Returns the list of GoogleMapKeyTags that have been added to this map.

Returns:

A Hashtable that contains all the GoogleMapKeysTags in this map keyed by domain name.

setKeys

public void setKeys(java.util.Hashtable keys)

Sets the list of GoogleMapKeyTags for this map.

Parameters:

keys - A Hashtable of GoogleMapKeyTags keyed by domain name.

getLargeLat

public double getLargeLat()

Returns the largest latitude (in decimal form) of all points stored in this map.

Returns:

The largest latitude of all points.

setLargeLat

public void setLargeLat(double largeLat)

Sets the largest latitude (in decimal form) for this map. This is typically set automatically when points are added. Developers should not override this method.

getLargeLon

public double getLargeLon()

Returns the largest longitude (in decimal form) of all points located within this map.

Returns:

The largest longitude in this map.

setLargeLon

public void setLargeLon(double largeLon)

Sets the largest longitude (in decimal form) for this map. This is typically set automatically when points are added. Developers should not override this method.

getMarkers

public java.util.Hashtable getMarkers()

Returns a list of all GoogleMapMarkerTags added to this map, keyed on their ids.

Returns:

A Hashtable of GoogleMapMarkerTags.

setMarkers

public void setMarkers(java.util.Hashtable markers)

Sets the list of the GoogleMapMarkerTags to be rendered by this map.

Parameters:

markers - A Hashtable of GoogleMapMarkerTags keyed on their ids.

isPanEnabled

public boolean isPanEnabled()

Denotes whether or not pan control is enabled. If true then users can pan the map, if false, they cannot.

Returns:

True if pan enabled, false if not.

setPanEnabled

public void setPanEnabled(boolean panEnabled)

Sets whether or not users should be able to pan the map.

Parameters:

panEnabled - True or false.

getPoints

public java.util.Hashtable getPoints()

Returns a list of all the GoogleMapPointTags added to this map.

Returns:

A Hashtable of GoogleMapPointTags keyed on their ids.

setPoints

public void setPoints(java.util.Hashtable points)

Sets the list of GoogleMapPointTags to be used by overlays in this map.

Parameters:

points - A Hashtable of GoogleMapPointTags keyed on their ids.

getPolygons

public java.util.Hashtable getPolygons()

Returns a list of all the GoogleMapPolygonTags to be rendered by this map.

Returns:

A Hashtable of GoogleMapPolygonTags keyed by id.

setPolygons

public void setPolygons(java.util.Hashtable polygons)

Sets the list of GoogleMapPolygonTags to be rendered by this map.

Parameters:

polygons - A Hashtable of GoogleMapPolygonTags keyed by id.

getMapTypes

public java.util.Hashtable getMapTypes()

Returns a list of all the GoogleMapMapTypeTags to be rendered by this map.

Returns:

A Hashtable of GoogleMapMapTypeTags keyed by id.

setMapTypes

public void setMapTypes(java.util.Hashtable mapTypes)

Sets the list of GoogleMapMapTypeTags to be rendered by this map.

Parameters:

mapTypes - A Hashtable of GoogleMapMapTypeTags keyed by id.

getPolylines

public java.util.Hashtable getPolylines()

Returns a list of all the GoogleMapPolylineTags to be rendered by this map.

Returns:

A Hashtable of GoogleMapPolylineTags keyed by id.

setPolylines

public void setPolylines(java.util.Hashtable polylines)

Sets the list of GoogleMapPolylineTags to be rendered by this map.

Parameters:

polylines - A Hashtable of GoogleMapPolylineTags keyed by id.

isShowScaleControl

public boolean isShowScaleControl()

Denotes whether or not this map displays a scale.

Returns:

True if the scale is visible, false if not.

setShowScaleControl

public void setShowScaleControl(boolean showScaleControl)

Sets whether or not this map should display a scale control.

Parameters:

showScaleControl - True to show scale, false if not.

getSmallLat

public double getSmallLat()

Returns the smalles latitude (in decimal form) of all points in this map.

Returns:

The small latitude in this map.

setSmallLat

public void setSmallLat(double smallLat)

Sets the smallest latitude (in decimal form) of all points in this map. This is set automatically as points are added to the map. Developers should not override this method.

Parameters:

smallLat - The smallest latitude in this map.

getSmallLon

public double getSmallLon()

Returns the smalles longitude (in decimal form) of all points in this map.

Returns:

The small longitude in this map.

setSmallLon

public void setSmallLon(double smallLon)

Sets the smallest longitude (in decimal form) of all points in this map. This is set automatically as points are added to the map. Developers should not override this method.

Parameters:

smallLon - The smallest longitude in this map.

getZoomControlSize

public int getZoomControlSize()

Returns the zoom control size for this map. Equals either SMALL_ZOOM_CONTROL or LARGE_ZOOM_CONTROL.

Returns:

The zoom control size for this map.

setZoomControlSize

public void setZoomControlSize(int zoomControlSize)

Sets the zoom control size. This should equal either SMALL_ZOOM_CONTROL or LARGE_ZOOM_CONTROL. If set to SMALL_ZOOM_CONTROL, then only zoom in (+) and zoom out (-) buttons are shown. If set to LARGE_ZOOM_CONTROL then a slider is presented as well.

Parameters:

zoomControlSize - The desired zoom control size.

getBody

public java.lang.String getBody()

Returns the map's body contents.

Returns:

The current body contents.

getCenterLatitude

public double getCenterLatitude()

Returns the latitude (in decimal form) of the map's current centerpoint.

Returns:

The current centerpoint latitude.

getCenterLongitude

public double getCenterLongitude()

Returns the longitude (in decimal form) of the map's current centerpoint.

Returns:

The current centerpoint longitude.

getHeight

public java.lang.String getHeight()

Returns the height of this map in pixels.

Returns:

The map height in pixels.

isMouseWheelSupport

public boolean isMouseWheelSupport()

Denotes whether or not this map supports mouseWheel zoom control.

Returns:

True if this map supports mousewheel control, false if not.

getScope

public java.lang.String getScope()

Returns the scope of this map ("site" | "page").

Returns:

The map scope.

isShowPanControl

public boolean isShowPanControl()

Denotes whether or not this map shows pan controls.

Returns:

True if pan controls are shown, false if not.

isShowTypeControl

public boolean isShowTypeControl()

Denotes whether or not this map shows type controls.

Returns:

True if type controls are shown, false if not.

isShowZoomControl

public boolean isShowZoomControl()

Denotes whether ot not this map shows zoom controls.

Returns:

True if zoom controls are shown, false if not.

getType

public java.lang.String getType()

Returns the current map type (map | satellite | hybrid).

Returns:

The current map type.

getVersion

public java.lang.String getVersion()

Returns the version of the Google Maps API used by this map.

Returns:

Google Maps API version.

getWidth

public java.lang.String getWidth()

Returns the width of this map in pixels.

Returns:

The width of the map in pixels.

getZoom

public int getZoom()

Returns the current zoom level of this map.

Returns:

The current zoom level.

getEvents

public java.util.Vector getEvents()

Returns the list of all GoogleMapEventTags supported by this map.

Specified by:

getEvents in interface GoogleMapEventListener

Returns:

A Vector of GoogleMapEventTags.

setEvents

public void setEvents(java.util.Vector events)

Sets the list of GoogleMapEventTags supported by this map.

Parameters:

events - A Vector of GoogleMapEventTags.

getId

public java.lang.String getId()

Returns the id of this map.

Returns:

The id of this map.

getMessage

public GoogleMapMessageTag getMessage()

Returns the current message tag, or null if not defined.

Returns:

A valid GoogleMapMessageTag

setMessage

public void setMessage(GoogleMapMessageTag message)

Sets the message tag to display when loading or when actions are fired.

Parameters:

message - A valid GoogleMapMessageTag

getXml

public java.lang.String getXml()

Returns the URL to the XML file or generator that is to provide map data for points, overlays and events for this map.

Returns:

URL to an XML file or generator.

setXml

public void setXml(java.lang.String xml)

Sets the URL for the XML file or generator that is to provide map data for points, overlays and events for this map.

Parameters:

xml - A valid URL to an XML file or generator that validates against the public DTD http://www.lamatek.com/GoogleMaps/dtds/googlemaps.dtd

getOverviewControl

public GoogleMapOverviewTag getOverviewControl()

Returns the currently defined GoogleMapOverviewTag defined for this map.

Returns:

A GoogleMapOverviewTag or null if none defined.

setOverviewControl

public void setOverviewControl(GoogleMapOverviewTag overviewControl)

Sets the GoogleMapOverviewTag to use for this map.

Parameters:

overviewControl - an initialized GoogleMapOverviewTag

getClusterer

public GoogleMapClusterTag getClusterer()

Returns the current clusterer tag, or null if not defined.

Returns:

A valid GoogleMapClusterTag

setClusterer

public void setClusterer(GoogleMapClusterTag clusterer)

Sets the cluster tag to used to cluster markers.

Parameters:

clusterer - A valid GoogleMapClusterTag

addWMSTag

public void addWMSTag(GoogleMapWMSTag tag)

Adds a wms tag to this map.

Parameters:

tag - An initialized GoogleMapWMSTag

getWms

public GoogleMapWMSTag getWms(java.lang.String id)

Returns a GoogleMapWMSTag with the given id, or null if a tag with that id is not present.

Returns:

A GoogleMapWMSTag or null.

getWmsTypes

public java.util.Hashtable getWmsTypes()

Returns a Hashtable of GoogleMapWMSTags, keyed by id, or null if none exist in this map.

Returns:

A Hashtable of GoogleMapWMSTags, keyed by id.

isDebug

public boolean isDebug()

Denotes whether or not debugging is turned on for this map. Only valid on version 2 maps. Version 1 maps return false.

Returns:

The debugging status of this map.

setDebug

public void setDebug(boolean debug)

Turns debugging on or off for this map. If turned on, version 2 maps will display a small pop-up window with debugging information in it.

Parameters:

debug - True to turn on debugging, false to turn it off.

addLabel

public void addLabel(GoogleMapLabelTag label)

Adds a label to this map.

Parameters:

label - An initialized GoogleMapLabelTag

deleteLabel

public void deleteLabel(GoogleMapLabelTag label)

Removes aa label from the map.

Parameters:

label - A label to remove from the map.

setLabels

public void setLabels(java.util.Vector labels)

Sets the list of labels to display on the map.

Parameters:

labels - A Vector containing GoogleMapLabelTag objects.

getLabels

public java.util.Vector getLabels()

Returns the list of map labels in a Vector.

Returns:

A Vector of GoogleMapLabelTag objects.

isHeadless

public boolean isHeadless()

Denotes whether or not this map is in headless mode. Headless mode hides user controls unless the cursor is inside the map.

Returns:

True or false.

setHeadless

public void setHeadless(boolean headless)

Sets headless mode for this map. Headless mode will only display user controls when the cursor is inside the map. Default is false (headless mode off).

Parameters:

headless - True or false.

getMaxZoom

public int getMaxZoom()

Returns the maximum allowable zoom level for this map. Users will not be able to zoom in higher than this number. Default is 17 (all the way in).

Returns:

Maximum zoom level as an int.

setMaxZoom

public void setMaxZoom(int maxZoom)

Sets the maximum allowable zoom level for this map. Users will not be able to zoom in higher than this number. Default is 17 (all the way in).

Parameters:

maxZoom - zoom level as an int.

getMinZoom

public int getMinZoom()

Returns the minimum allowable zoom level for this map. Users will not be able to zoom out further than this number. Default is 0 (all the way out).

Returns:

Minimum zoom level as an int.

setMinZoom

public void setMinZoom(int minZoom)

Sets the minimum allowable zoom level for this map. Users will not be able to zoom out further than this number. Default is 0 (all the way out).

Parameters:

minZoom - zoom level as an int.

isBound

public boolean isBound()

Returns whether or not this map is bound to it's contents. If bound, the map cannot be panned outside the defined points. Default is false.

Returns:

True or false denoting if this map is bound.

setBound

public void setBound(boolean bound)

Sets the bound state of this map. If bound, it cannot be panned outside the points that have been defined in it (with a little fudge factor for smoother scrolling. Default is false.

Parameters:

bound - Sets the bound state of this map.

deleteInsert

public void deleteInsert(GoogleMapInsertTag insert)

Removes an insert from the map.

Parameters:

insert - An insert to remove from the map.

addInsert

public void addInsert(GoogleMapInsertTag insert)

Adds an insert to this map.

Parameters:

insert - An initialized GoogleMapInsertTag

setInserts

public void setInserts(java.util.Vector inserts)

Sets the list of inserts to display on the map.

Parameters:

inserts - A Vector containing GoogleMapInsertTag objects.

getInserts

public java.util.Vector getInserts()

Returns the list of map inserts in a Vector.

Returns:

A Vector of GoogleMapInsertTag objects.

addCoordinates

public void addCoordinates(GoogleMapCoordinatesTag coords)

Adds a GoogleMapCoordinatesTag to the map.

Parameters:

coords - An initialized GoogleMapCoordinates Tag.

getLanguage

public java.lang.String getLanguage()

Returns the currently designated default language.

Returns:

The 2 -digit language code.

setLanguage

public void setLanguage(java.lang.String language)

Sets the desired default 2-digit language code.

Parameters:

language - The 2-figit language code to use.

isShowDaylight

public boolean isShowDaylight()

Denotes whether or not the map is set to display current day and nighttime light conditions.

Returns:

True or false.

setShowDaylight

public void setShowDaylight(boolean showDaylight)

Allows the map to display where the current day/night conditions are. Set to true to see light/dark, false if not. Default is false.

Parameters:

showDaylight - true to show, false if not.