com.lamatek.tags.google
Class GoogleMapMapTypeTag

java.lang.Object
  extended by TagSupport
      extended by com.lamatek.tags.google.GoogleMapMapTypeTag

public class GoogleMapMapTypeTag
extends TagSupport

GoogleMapMapTypeTag This class represents a <googlemaps:maptype> tag. Developers should not extend this class or override it's methods.

Version:
0.85
Author:
Tom Cole

Constructor Summary
GoogleMapMapTypeTag()
           
 
Method Summary
 int doStartTag()
          Overrides doStartTag() from TagSupport.
 java.lang.String getBaseType()
          Returns the base map type from which this map type derives.
 java.lang.String getCopyright()
          Returns copyright information for this map type.
 java.lang.String getId()
          Returns the id for this custom map type.
 java.lang.String getLowerRightBound()
          Returns the id of the point that represents the lower right hand bounds of the viewable area of this map.
 java.lang.String getLowResUrl()
          Returns the url of the server side process that returns tile images for zoom levels less than 50%.
 int getMaxZoom()
          Returns the maximum zoom level supported by this map type.
 int getMinZoom()
          Returns the minimum zoom level supported by this map type.
 java.lang.String getName()
          Returns the user viewable name for this map type.
 java.lang.String getOverlayUrl()
          Returns the url of the server side process that returns overlay tiles.
 java.lang.String getUpperLeftBound()
          Returns the id of the point that represents the upper left hand bounds of the viewable area of this map.
 java.lang.String getUrl()
          Returns the url for the server side process that supplies the tiles for this map type.
 boolean isPng()
          Denotes whether or not the tiles supplied by this tile server are .png files.
 boolean isShowOnStartup()
          Denotes whether or not this map type should be initially displayed when the Google Map is rendered.
 void setBaseType(java.lang.String baseType)
          Sets the base map type from which this map type is derived.
 void setCopyright(java.lang.String copyright)
          Sets the copyright information for this map type.
 void setId(java.lang.String id)
          Sets the id for this map type.
 void setLowerRightBound(java.lang.String point)
          Sets the id of the point that represents the low right hand bounds of the viewable area of this map.
 void setLowResUrl(java.lang.String lowResUrl)
          Set the url of the server side process that generates tiles for this map type when the zoom leve is less than half way.
 void setMaxZoom(int maxZoom)
          Sets the maximum zoom level this map type supports.
 void setMinZoom(int minZoom)
          Sets the minimum zoom level this map type supports.
 void setName(java.lang.String name)
          Sets the user viewable name for this map type.
 void setOverlayUrl(java.lang.String overlayUrl)
          Sets the url of the server side process that provides over tiles for this custom map type.
 void setPng(boolean png)
          Sets whether or not the tiles for this map type are .png format.
 void setShowOnStartup(boolean showOnStartup)
          Sets whether or not this map type should be initially selected when the map is rendered.
 void setUpperLeftBound(java.lang.String upperLeftBound)
          Sets the id of the point that represents the upper left hand bounds of the viewable area of this map.
 void setUrl(java.lang.String url)
          Sets the url for the server side process that supplied the tiles for this map type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GoogleMapMapTypeTag

public GoogleMapMapTypeTag()
Method Detail

doStartTag

public int doStartTag()
Overrides doStartTag() from TagSupport. Developers should not override this method.


getLowerRightBound

public java.lang.String getLowerRightBound()
Returns the id of the point that represents the lower right hand bounds of the viewable area of this map.

Returns:
A string that represents a point id.

setLowerRightBound

public void setLowerRightBound(java.lang.String point)
Sets the id of the point that represents the low right hand bounds of the viewable area of this map.

Parameters:
point - The id of a point in this map.

getUpperLeftBound

public java.lang.String getUpperLeftBound()
Returns the id of the point that represents the upper left hand bounds of the viewable area of this map.

Returns:
A string that represents a point id.

setUpperLeftBound

public void setUpperLeftBound(java.lang.String upperLeftBound)
Sets the id of the point that represents the upper left hand bounds of the viewable area of this map.

Parameters:
point - The id of a point in this map.

getBaseType

public java.lang.String getBaseType()
Returns the base map type from which this map type derives.

Returns:
The base map type.

setBaseType

public void setBaseType(java.lang.String baseType)
Sets the base map type from which this map type is derived. Valid values are map, satellite and hybrid.

Parameters:
baseType - The base map type for this map type.

getId

public java.lang.String getId()
Returns the id for this custom map type.

Returns:
The id for this map type.

setId

public void setId(java.lang.String id)
Sets the id for this map type. This should be unique within the map.

Parameters:
id - A unique id for this map type.

getName

public java.lang.String getName()
Returns the user viewable name for this map type. This text is placed on the control button for this map type.

Returns:
The name for this map type.

setName

public void setName(java.lang.String name)
Sets the user viewable name for this map type.

Parameters:
name - A name for this map type.

getUrl

public java.lang.String getUrl()
Returns the url for the server side process that supplies the tiles for this map type.

Returns:
A url to the tile generator.

setUrl

public void setUrl(java.lang.String url)
Sets the url for the server side process that supplied the tiles for this map type.

Parameters:
url - A url to a resource that provides map tiles for this map type.

isShowOnStartup

public boolean isShowOnStartup()
Denotes whether or not this map type should be initially displayed when the Google Map is rendered.

Returns:
True or false.

setShowOnStartup

public void setShowOnStartup(boolean showOnStartup)
Sets whether or not this map type should be initially selected when the map is rendered.

Parameters:
showOnStartup - True if this map type should be initially selected, false if not.

getOverlayUrl

public java.lang.String getOverlayUrl()
Returns the url of the server side process that returns overlay tiles. This only applied if this custom map is based on a hybrid map type.

Returns:
A valid url to a tile generator.

setOverlayUrl

public void setOverlayUrl(java.lang.String overlayUrl)
Sets the url of the server side process that provides over tiles for this custom map type. This will only apply if the base map type is set to hybrid.

Parameters:
overlayUrl - Url to the process that provides overlay tiles for this map type.

getLowResUrl

public java.lang.String getLowResUrl()
Returns the url of the server side process that returns tile images for zoom levels less than 50%.

Returns:
Url to a tile generator.

setLowResUrl

public void setLowResUrl(java.lang.String lowResUrl)
Set the url of the server side process that generates tiles for this map type when the zoom leve is less than half way.

Parameters:
lowResUrl - Url to a tile generator.

getCopyright

public java.lang.String getCopyright()
Returns copyright information for this map type.

Returns:
Copyright string.

setCopyright

public void setCopyright(java.lang.String copyright)
Sets the copyright information for this map type.

Parameters:
copyright - The copyright string to display when this map type is selected.

getMaxZoom

public int getMaxZoom()
Returns the maximum zoom level supported by this map type.

Returns:
A valid zoom level as an int.

setMaxZoom

public void setMaxZoom(int maxZoom)
Sets the maximum zoom level this map type supports. When the zoom level goes past this level, the default map tiles will be presented. NOTE: Remember that if you map is version 1, zoom levels range from 0 (all the way in) to 17 (all the way out). In version 2 maps, they are reversed...

Parameters:
maxZoom - The maximum zoom level for this map type.

getMinZoom

public int getMinZoom()
Returns the minimum zoom level supported by this map type.

Returns:
A valid zoom level as an int.

setMinZoom

public void setMinZoom(int minZoom)
Sets the minimum zoom level this map type supports. When the zoom level goes past this level, the default map tiles will be presented. NOTE: Remember that if you map is version 1, zoom levels range from 0 (all the way in) to 17 (all the way out). In version 2 maps, they are reversed...

Parameters:
minZoom - The minimum zoom level for this map type.

isPng

public boolean isPng()
Denotes whether or not the tiles supplied by this tile server are .png files.

Returns:
True if tiles are .png format, false otherwise

setPng

public void setPng(boolean png)
Sets whether or not the tiles for this map type are .png format.

Parameters:
png - True if tiles for this map type are .png format, false otherwise.