com.google.maps.android.clustering.view

Class DefaultClusterRenderer<T extends ClusterItem>

java.lang.Object

com.google.maps.android.clustering.view.DefaultClusterRenderer<T>

All Implemented Interfaces:

ClusterRenderer<T>

public class DefaultClusterRenderer<T extends ClusterItem>
extends java.lang.Object
implements ClusterRenderer<T>

The default view for a ClusterManager. Markers are animated in and out of clusters.

Constructor Summary

Constructors

Constructor and Description
DefaultClusterRenderer(android.content.Context context, GoogleMap map, ClusterManager<T> clusterManager)

Method Summary

Modifier and Type	Method and Description
protected int	getBucket(Cluster<T> cluster) Gets the "bucket" for a particular cluster.
Cluster<T>	getCluster(Marker marker) Get the Cluster from a marker
T	getClusterItem(Marker marker) Get the ClusterItem from a marker
protected java.lang.String	getClusterText(int bucket)
protected int	getColor(int clusterSize)
protected BitmapDescriptor	getDescriptorForCluster(Cluster<T> cluster) Gets a BitmapDescriptor for the given cluster that contains a rough count of the number of items.
Marker	getMarker(Cluster<T> cluster) Get the marker from a Cluster
Marker	getMarker(T clusterItem) Get the marker from a ClusterItem
int	getMinClusterSize()
void	onAdd() Called when the view is added.
protected void	onBeforeClusterItemRendered(T item, MarkerOptions markerOptions) Called before the marker for a ClusterItem is added to the map.
protected void	onBeforeClusterRendered(Cluster<T> cluster, MarkerOptions markerOptions) Called before the marker for a Cluster is added to the map.
protected void	onClusterItemRendered(T clusterItem, Marker marker) Called after the marker for a ClusterItem has been added to the map.
protected void	onClusterItemUpdated(T item, Marker marker) Called when a cached marker for a ClusterItem already exists on the map so the marker may be updated to the latest item values.
protected void	onClusterRendered(Cluster<T> cluster, Marker marker) Called after the marker for a Cluster has been added to the map.
void	onClustersChanged(java.util.Set<? extends Cluster<T>> clusters) Called when the view needs to be updated because new clusters need to be displayed.
protected void	onClusterUpdated(Cluster<T> cluster, Marker marker) Called when a cached marker for a Cluster already exists on the map so the marker may be updated to the latest cluster values.
void	onRemove() Called when the view is removed.
void	setAnimation(boolean animate) Called to set animation on or off
void	setMinClusterSize(int minClusterSize)
void	setOnClusterClickListener(ClusterManager.OnClusterClickListener<T> listener)
void	setOnClusterInfoWindowClickListener(ClusterManager.OnClusterInfoWindowClickListener<T> listener)
void	setOnClusterItemClickListener(ClusterManager.OnClusterItemClickListener<T> listener)
void	setOnClusterItemInfoWindowClickListener(ClusterManager.OnClusterItemInfoWindowClickListener<T> listener)
protected boolean	shouldRenderAsCluster(Cluster<T> cluster) Determine whether the cluster should be rendered as individual markers or a cluster.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultClusterRenderer

public DefaultClusterRenderer(android.content.Context context,
                              GoogleMap map,
                              ClusterManager<T> clusterManager)

Method Detail

onAdd

public void onAdd()

Description copied from interface: ClusterRenderer

Called when the view is added.

Specified by:

onAdd in interface ClusterRenderer<T extends ClusterItem>

onRemove

public void onRemove()

Description copied from interface: ClusterRenderer

Called when the view is removed.

Specified by:

onRemove in interface ClusterRenderer<T extends ClusterItem>

getColor

protected int getColor(int clusterSize)

getClusterText

protected java.lang.String getClusterText(int bucket)

getBucket

protected int getBucket(Cluster<T> cluster)

Gets the "bucket" for a particular cluster. By default, uses the number of points within the cluster, bucketed to some set points.

getMinClusterSize

public int getMinClusterSize()

setMinClusterSize

public void setMinClusterSize(int minClusterSize)

shouldRenderAsCluster

protected boolean shouldRenderAsCluster(Cluster<T> cluster)

Determine whether the cluster should be rendered as individual markers or a cluster.

onClustersChanged

public void onClustersChanged(java.util.Set<? extends Cluster<T>> clusters)

Description copied from interface: ClusterRenderer

Called when the view needs to be updated because new clusters need to be displayed.

Specified by:

onClustersChanged in interface ClusterRenderer<T extends ClusterItem>

Parameters:

clusters - the clusters to be displayed.

setOnClusterClickListener

public void setOnClusterClickListener(ClusterManager.OnClusterClickListener<T> listener)

Specified by:

setOnClusterClickListener in interface ClusterRenderer<T extends ClusterItem>

setOnClusterInfoWindowClickListener

public void setOnClusterInfoWindowClickListener(ClusterManager.OnClusterInfoWindowClickListener<T> listener)

Specified by:

setOnClusterInfoWindowClickListener in interface ClusterRenderer<T extends ClusterItem>

setOnClusterItemClickListener

public void setOnClusterItemClickListener(ClusterManager.OnClusterItemClickListener<T> listener)

Specified by:

setOnClusterItemClickListener in interface ClusterRenderer<T extends ClusterItem>

setOnClusterItemInfoWindowClickListener

public void setOnClusterItemInfoWindowClickListener(ClusterManager.OnClusterItemInfoWindowClickListener<T> listener)

Specified by:

setOnClusterItemInfoWindowClickListener in interface ClusterRenderer<T extends ClusterItem>

setAnimation

public void setAnimation(boolean animate)

Description copied from interface: ClusterRenderer

Called to set animation on or off

Specified by:

setAnimation in interface ClusterRenderer<T extends ClusterItem>

onBeforeClusterItemRendered

protected void onBeforeClusterItemRendered(T item,
                                           MarkerOptions markerOptions)

Called before the marker for a ClusterItem is added to the map. The default implementation sets the marker and snippet text based on the respective item text if they are both available, otherwise it will set the title if available, and if not it will set the marker title to the item snippet text if that is available. The first time ClusterManager.cluster() is invoked on a set of items onBeforeClusterItemRendered(ClusterItem, MarkerOptions) will be called and onClusterItemUpdated(ClusterItem, Marker) will not be called. If an item is removed and re-added (or updated) and ClusterManager.cluster() is invoked again, then onClusterItemUpdated(ClusterItem, Marker) will be called and onBeforeClusterItemRendered(ClusterItem, MarkerOptions) will not be called.

Parameters:

item - item to be rendered

markerOptions - the markerOptions representing the provided item

onClusterItemUpdated

protected void onClusterItemUpdated(T item,
                                    Marker marker)

Called when a cached marker for a ClusterItem already exists on the map so the marker may be updated to the latest item values. Default implementation updates the title and snippet of the marker if they have changed and refreshes the info window of the marker if it is open. Note that the contents of the item may not have changed since the cached marker was created - implementations of this method are responsible for checking if something changed (if that matters to the implementation). The first time ClusterManager.cluster() is invoked on a set of items onBeforeClusterItemRendered(ClusterItem, MarkerOptions) will be called and onClusterItemUpdated(ClusterItem, Marker) will not be called. If an item is removed and re-added (or updated) and ClusterManager.cluster() is invoked again, then onClusterItemUpdated(ClusterItem, Marker) will be called and onBeforeClusterItemRendered(ClusterItem, MarkerOptions) will not be called.

Parameters:

item - item being updated

marker - cached marker that contains a potentially previous state of the item.

onBeforeClusterRendered

protected void onBeforeClusterRendered(Cluster<T> cluster,
                                       MarkerOptions markerOptions)

Called before the marker for a Cluster is added to the map. The default implementation draws a circle with a rough count of the number of items. The first time ClusterManager.cluster() is invoked on a set of items onBeforeClusterRendered(Cluster, MarkerOptions) will be called and onClusterUpdated(Cluster, Marker) will not be called. If an item is removed and re-added (or updated) and ClusterManager.cluster() is invoked again, then onClusterUpdated(Cluster, Marker) will be called and onBeforeClusterRendered(Cluster, MarkerOptions) will not be called.

Parameters:

cluster - cluster to be rendered

markerOptions - markerOptions representing the provided cluster

getDescriptorForCluster

protected BitmapDescriptor getDescriptorForCluster(Cluster<T> cluster)

Gets a BitmapDescriptor for the given cluster that contains a rough count of the number of items. Used to set the cluster marker icon in the default implementations of onBeforeClusterRendered(Cluster, MarkerOptions) and onClusterUpdated(Cluster, Marker).

Parameters:

cluster - cluster to get BitmapDescriptor for

Returns:

a BitmapDescriptor for the marker icon for the given cluster that contains a rough count of the number of items.

onClusterRendered

protected void onClusterRendered(Cluster<T> cluster,
                                 Marker marker)

Called after the marker for a Cluster has been added to the map.

Parameters:

cluster - the cluster that was just added to the map

marker - the marker representing the cluster that was just added to the map

onClusterUpdated

protected void onClusterUpdated(Cluster<T> cluster,
                                Marker marker)

Called when a cached marker for a Cluster already exists on the map so the marker may be updated to the latest cluster values. Default implementation updated the icon with a circle with a rough count of the number of items. Note that the contents of the cluster may not have changed since the cached marker was created - implementations of this method are responsible for checking if something changed (if that matters to the implementation). The first time ClusterManager.cluster() is invoked on a set of items onBeforeClusterRendered(Cluster, MarkerOptions) will be called and onClusterUpdated(Cluster, Marker) will not be called. If an item is removed and re-added (or updated) and ClusterManager.cluster() is invoked again, then onClusterUpdated(Cluster, Marker) will be called and onBeforeClusterRendered(Cluster, MarkerOptions) will not be called.

Parameters:

cluster - cluster being updated

marker - cached marker that contains a potentially previous state of the cluster

onClusterItemRendered

protected void onClusterItemRendered(T clusterItem,
                                     Marker marker)

Called after the marker for a ClusterItem has been added to the map.

Parameters:

clusterItem - the item that was just added to the map

marker - the marker representing the item that was just added to the map

getMarker

public Marker getMarker(T clusterItem)

Get the marker from a ClusterItem

Parameters:

clusterItem - ClusterItem which you will obtain its marker

Returns:

a marker from a ClusterItem or null if it does not exists

getClusterItem

public T getClusterItem(Marker marker)

Get the ClusterItem from a marker

Parameters:

marker - which you will obtain its ClusterItem

Returns:

a ClusterItem from a marker or null if it does not exists

getMarker

public Marker getMarker(Cluster<T> cluster)

Get the marker from a Cluster

Parameters:

cluster - which you will obtain its marker

Returns:

a marker from a cluster or null if it does not exists

getCluster

public Cluster<T> getCluster(Marker marker)

Get the Cluster from a marker

Parameters:

marker - which you will obtain its Cluster

Returns:

a Cluster from a marker or null if it does not exists