com.lamatek.tags.google
Class GoogleMapClusterTag

java.lang.Object
  extended by BodyTagSupport
      extended by com.lamatek.tags.google.GoogleMapClusterTag

public class GoogleMapClusterTag
extends BodyTagSupport

GoogleMapClusterTag This tag represents a <googlemaps:cluster> tag and allows developers to groups icons together into clusters, that expand as the user zooms in on them. Developers should not extend this class or override it's methods.


Constructor Summary
GoogleMapClusterTag()
           
 
Method Summary
 int doStartTag()
          Overrides doStartTag() from TagSupport.
 int getGridSize()
           
 GoogleMapIconTag getIcon()
          Gets the GoogleMapIconTag that will render the icons for clustered markers.
 int getMarkersPerCluster()
          Returns the minimum number of markers that can be joined to create a cluster.
 int getMaxVisibleMarkers()
          Returns the maximum number of visible markers (both clustered and non-clustered) that should appear on the map.
 java.lang.String getPathToScript()
          Returns the path (URL) to the Clusterer.js file.
 void setGridSize(int gridSize)
           
 void setIcon(GoogleMapIconTag icon)
          Sets the GoogleMapIconTag that will render the icons for clustered markers.
 void setMarkersPerCluster(int markersPerCluster)
          Sets the minimum number of markers that can be joined to create a cluster.
 void setMaxVisibleMarkers(int maxVisibleMarkers)
          Sets the maximum number of visible markers (both clustered and non-clustered) that should appear on the map.
 void setPathToScript(java.lang.String pathToScript)
          Sets the URL path to the Clusterer.js file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GoogleMapClusterTag

public GoogleMapClusterTag()
Method Detail

doStartTag

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


getGridSize

public int getGridSize()

setGridSize

public void setGridSize(int gridSize)

getIcon

public GoogleMapIconTag getIcon()
Gets the GoogleMapIconTag that will render the icons for clustered markers.

Returns:
A GoogleMapIconTag or null if not defined.

setIcon

public void setIcon(GoogleMapIconTag icon)
Sets the GoogleMapIconTag that will render the icons for clustered markers.

Parameters:
icon - A GoogleMapIconTag.

getMarkersPerCluster

public int getMarkersPerCluster()
Returns the minimum number of markers that can be joined to create a cluster.

Returns:
Minimum markers per cluster.

setMarkersPerCluster

public void setMarkersPerCluster(int markersPerCluster)
Sets the minimum number of markers that can be joined to create a cluster.

Parameters:
markersPerCluster - Minimum markers per cluster.

getMaxVisibleMarkers

public int getMaxVisibleMarkers()
Returns the maximum number of visible markers (both clustered and non-clustered) that should appear on the map.

Returns:
The maximum number of displayed markers.

setMaxVisibleMarkers

public void setMaxVisibleMarkers(int maxVisibleMarkers)
Sets the maximum number of visible markers (both clustered and non-clustered) that should appear on the map.

Parameters:
maxVisibleMarkers - The maximum number of displayed markers.

getPathToScript

public java.lang.String getPathToScript()
Returns the path (URL) to the Clusterer.js file.

Returns:
URL to javascript file.

setPathToScript

public void setPathToScript(java.lang.String pathToScript)
Sets the URL path to the Clusterer.js file. This must be a complete relative or absolute URL, including filename.

Parameters:
pathToScript - A valid URL that points to the Clusterer.js file.