com.mapbox.mapboxsdk.plugins.annotation

Class AnnotationManager<L extends Layer,T extends Annotation,S extends Options<T>,D extends OnAnnotationDragListener<T>,U extends OnAnnotationClickListener<T>,V extends OnAnnotationLongClickListener<T>>

java.lang.Object

com.mapbox.mapboxsdk.plugins.annotation.AnnotationManager<L,T,S,D,U,V>

Type Parameters:

T - type of annotation

S - type of options for building the annotation, depends on generic T

D - type of annotation drag listener, depends on generic T

U - type of annotation click listener, depends on generic T

V - type of annotation long click listener, depends on generic T

Direct Known Subclasses:

CircleManager, FillManager, LineManager, SymbolManager

public abstract class AnnotationManager<L extends Layer,T extends Annotation,S extends Options<T>,D extends OnAnnotationDragListener<T>,U extends OnAnnotationClickListener<T>,V extends OnAnnotationLongClickListener<T>>
extends java.lang.Object

Generic AnnotationManager, can be used to create annotation specific managers.

Field Summary

Fields

Modifier and Type	Field and Description
protected <any>	annotations
protected L	layer
protected MapboxMap	mapboxMap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnnotationManager(MapView mapView, MapboxMap mapboxMap, Style style, com.mapbox.mapboxsdk.plugins.annotation.CoreElementProvider<L> coreElementProvider, com.mapbox.mapboxsdk.plugins.annotation.DraggableAnnotationController draggableAnnotationController, java.lang.String belowLayerId, GeoJsonOptions geoJsonOptions)

Method Summary

Modifier and Type	Method and Description
void	addClickListener(U u) Add a callback to be invoked when a symbol has been clicked.
void	addDragListener(D d) Add a callback to be invoked when an annotation is dragged.
void	addLongClickListener(V v) Add a callback to be invoked when a symbol has been long clicked.
java.util.List<T>	create(java.util.List<S> optionsList) Create a list of annotations on the map.
T	create(S options) Create an annotation on the map
void	delete(java.util.List<T> annotationList) Deletes annotations from the map.
void	delete(T annotation) Delete an annotation from the map.
void	deleteAll() Deletes all annotations from the map.
<any>	getAnnotations() Get a list of current annotations.
java.lang.String	getLayerId() Returns a layer ID that annotations created by this manager are laid out on.
void	onDestroy() Cleanup annotation manager, used to clear listeners
void	removeClickListener(U u) Remove a previously added callback that was to be invoked when symbol has been clicked.
void	removeDragListener(D d) Remove a previously added callback that was to be invoked when an annotation has been dragged.
void	removeLongClickListener(V v) Remove a previously added callback that was to be invoked when symbol has been long clicked.
protected abstract void	setDataDrivenPropertyIsUsed(java.lang.String property)
void	update(java.util.List<T> annotationList) Update annotations on the map.
void	update(T annotation) Update an annotation on the map.
void	updateSource() Trigger an update to the underlying source

Methods inherited from class java.lang.Object

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

Field Detail

mapboxMap

protected final MapboxMap mapboxMap

annotations

protected final <any> annotations

layer

protected L extends Layer layer

Constructor Detail

AnnotationManager

protected AnnotationManager(MapView mapView,
                            MapboxMap mapboxMap,
                            Style style,
                            com.mapbox.mapboxsdk.plugins.annotation.CoreElementProvider<L> coreElementProvider,
                            com.mapbox.mapboxsdk.plugins.annotation.DraggableAnnotationController draggableAnnotationController,
                            java.lang.String belowLayerId,
                            GeoJsonOptions geoJsonOptions)

Method Detail

getLayerId

public java.lang.String getLayerId()

Returns a layer ID that annotations created by this manager are laid out on. This reference can be used together with Style#addLayerAbove(Layer, String) or Style#addLayerBelow(Layer, String) to improve other layers positioning in relation to this manager.

Returns:

underlying layer's ID

getAnnotations

public <any> getAnnotations()

Get a list of current annotations.

Returns:

long sparse array of annotations

create

public T create(S options)

Create an annotation on the map

Parameters:

options - the annotation options defining the annotation to build

Returns:

the build annotation

create

public java.util.List<T> create(java.util.List<S> optionsList)

Create a list of annotations on the map.

Parameters:

optionsList - the list of annotation options defining the list of annotations to build

Returns:

the list of build annotations

delete

public void delete(T annotation)

Delete an annotation from the map.

Parameters:

annotation - annotation to be deleted

delete

public void delete(java.util.List<T> annotationList)

Deletes annotations from the map.

Parameters:

annotationList - the list of annotations to be deleted

deleteAll

public void deleteAll()

Deletes all annotations from the map.

update

public void update(T annotation)

Update an annotation on the map.

Parameters:

annotation - annotation to be updated

update

public void update(java.util.List<T> annotationList)

Update annotations on the map.

Parameters:

annotationList - list of annotation to be updated

updateSource

public void updateSource()

Trigger an update to the underlying source

setDataDrivenPropertyIsUsed

protected abstract void setDataDrivenPropertyIsUsed(java.lang.String property)

addDragListener

public void addDragListener(D d)

Add a callback to be invoked when an annotation is dragged.

Parameters:

d - the callback to be invoked when an annotation is dragged

removeDragListener

public void removeDragListener(D d)

Remove a previously added callback that was to be invoked when an annotation has been dragged.

Parameters:

d - the callback to be removed

addClickListener

public void addClickListener(U u)

Add a callback to be invoked when a symbol has been clicked.

Parameters:

u - the callback to be invoked when a symbol is clicked

removeClickListener

public void removeClickListener(U u)

Remove a previously added callback that was to be invoked when symbol has been clicked.

Parameters:

u - the callback to be removed

addLongClickListener

public void addLongClickListener(V v)

Add a callback to be invoked when a symbol has been long clicked.

Parameters:

v - the callback to be invoked when a symbol is clicked

removeLongClickListener

public void removeLongClickListener(V v)

Remove a previously added callback that was to be invoked when symbol has been long clicked.

Parameters:

v - the callback to be removed

onDestroy

public void onDestroy()

Cleanup annotation manager, used to clear listeners