com.telenav.mapkit

Class Annotation

java.lang.Object

com.telenav.mapkit.Annotation

public class Annotation
extends Object

Created by xizhens on 2/28/14. Copyright reserved by Telenav.Inc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Annotation.AnnotationLayer This Enum is currently not used for the application layer.
static class	Annotation.AnnotationStyle The Enum define the annotation styles.
static class	Annotation.AnnotationType The map engine supports several annotation types.
static class	Annotation.TouchType The Enum for the touch type.

Constructor Summary

Constructors

Constructor and Description
Annotation(android.content.Context activity, int resourceId, android.location.Location latLon) This is the Default constructor for the Annotation class.

Method Summary

Methods

Modifier and Type	Method and Description
long	getAnnotationId() This method is used to get the annotation Id for this annotation.
int	getBitmapHeight()
int	getBitmapWidth()
long	getGraphicId() This method is used to get the graphicId.
int	getHeight()
int	getHorizontalAlignment() This method returns the alignment parameter used to anchor the annotation horizontally
Annotation.AnnotationLayer	getLayer() This method is used to retrieve the current annotation layer information.
android.location.Location	getLocation() This method is used to get the anchor point of the current location.
String	getPopupText() This method returns the text associated with the current annotation.
Annotation.AnnotationStyle	getStyle() This method is used to get the annotation style.
Annotation.AnnotationType	getType() This method is used to get the annotation type.
int	getVerticalAlignment() This method returns the alignment parameter used to anchor the annotation vertically
int	getWidth()
int	getX()
int	getY()
boolean	isHighlight()
boolean	needRefresh()
boolean	onTouch(int insideX, int insideY, Annotation.TouchType type) The UIEvent handler; this method is triggered when the user takes action on the mapView.
void	setAnnotationId(long annotationId) This method updates the annotation Id; it should be called only within the MapKit, and should not be used by a client app.
void	setGraphicId(long graphicId) This method is used to set the graphicId.
void	setHeight(int height)
void	setHorizontalAlignment(int horizontalAlignment) This method sets the alignment parameter to be used to anchor the annotation vertically
void	setIsHighlight(boolean isHighlight)
void	setLayer(Annotation.AnnotationLayer layer) This method is used to update the current annotation layer information.
void	setLocation(android.location.Location latLon) This method is used to change the anchor point of the current annotation.
void	setPopupText(String popupText) This method associates to the current annotation a text that could be displayed when selected.
void	setStyle(Annotation.AnnotationStyle style) This method is used to set the annotation style.
void	setType(Annotation.AnnotationType type) This method is used to change the annotation type.
void	setVerticalAlignment(int verticalAlignment) This method sets the alignment parameter to be used to anchor the annotation vertically
void	setWidth(int width)
byte[]	toAnnotationData() This method is used to get the annotation image bitmap.

Methods inherited from class java.lang.Object

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

Constructor Detail

Annotation

public Annotation(android.content.Context activity,
          int resourceId,
          android.location.Location latLon)

This is the Default constructor for the Annotation class.

Parameters:

activity - the owner activity; used to retrieve resource and information if needed for the annotation

resourceId - the image Resource Id; used for showing on the map

latLon - the anchor point of the annotation

Method Detail

toAnnotationData

public final byte[] toAnnotationData()

This method is used to get the annotation image bitmap.

Returns:

the bitmap binary data

getType

public Annotation.AnnotationType getType()

This method is used to get the annotation type.

Returns:

the annotation type, a value of the AnnotationType Enum

setType

public void setType(Annotation.AnnotationType type)

This method is used to change the annotation type.

Parameters:

type - a value of the AnnotationType Enum

getStyle

public Annotation.AnnotationStyle getStyle()

This method is used to get the annotation style.

Returns:

the annotation style, a value of the AnnotationStyle Enum

setStyle

public void setStyle(Annotation.AnnotationStyle style)

This method is used to set the annotation style.

Parameters:

style - a value of the AnnotationStyle Enum

getLayer

public Annotation.AnnotationLayer getLayer()

This method is used to retrieve the current annotation layer information.

Returns:

the annotation layer attached. If not attached, returns null.

setLayer

public void setLayer(Annotation.AnnotationLayer layer)

This method is used to update the current annotation layer information.

Parameters:

layer - the annotation layer attached. if not attached, returns null.

getLocation

public android.location.Location getLocation()

This method is used to get the anchor point of the current location.

Returns:

the location for the current annotation in Location format

setLocation

public void setLocation(android.location.Location latLon)

This method is used to change the anchor point of the current annotation.

Note: You cannot change this configuration after adding the annotation to mapView.

Parameters:

latLon - the new location for the annotation in latLon format

onTouch

public boolean onTouch(int insideX,
              int insideY,
              Annotation.TouchType type)

The UIEvent handler; this method is triggered when the user takes action on the mapView.

Parameters:

insideX - the x location of the touch point

insideY - the y location of the touch point

type - an Enum value of the touch type

Returns:

needRefresh

public boolean needRefresh()

Returns:

isHighlight

public boolean isHighlight()

Returns:

setIsHighlight

public void setIsHighlight(boolean isHighlight)

Parameters:

isHighlight -

getGraphicId

public long getGraphicId()

This method is used to get the graphicId. (This method should not be used outside the current annotation.)

Returns:

the OpenGL graphicId for the current annotation

setGraphicId

public void setGraphicId(long graphicId)

This method is used to set the graphicId. (This method should not be used outside the current annotation.)

Parameters:

graphicId - the OpenGL graphic Id for the current annotation.

getAnnotationId

public long getAnnotationId()

This method is used to get the annotation Id for this annotation. This Id value is assigned by the engine, and should never be set by a user app.

Returns:

the current annotation Id

setAnnotationId

public void setAnnotationId(long annotationId)

This method updates the annotation Id; it should be called only within the MapKit, and should not be used by a client app.

Parameters:

annotationId - the annotation Id to be set

getPopupText

public String getPopupText()

This method returns the text associated with the current annotation.

Returns:

the text associated with the current annotation

setPopupText

public void setPopupText(String popupText)

This method associates to the current annotation a text that could be displayed when selected.

Parameters:

popupText - text to associate with the current annotation

getWidth

public int getWidth()

Returns:

setWidth

public void setWidth(int width)

Parameters:

width -

getHeight

public int getHeight()

Returns:

setHeight

public void setHeight(int height)

Parameters:

height -

getX

public int getX()

Returns:

getY

public int getY()

Returns:

getBitmapWidth

public int getBitmapWidth()

Returns:

getBitmapHeight

public int getBitmapHeight()

Returns:

getVerticalAlignment

public int getVerticalAlignment()

This method returns the alignment parameter used to anchor the annotation vertically

Returns:

an enum value from android.view.Gravity

setVerticalAlignment

public void setVerticalAlignment(int verticalAlignment)

This method sets the alignment parameter to be used to anchor the annotation vertically

Parameters:

verticalAlignment -

getHorizontalAlignment

public int getHorizontalAlignment()

This method returns the alignment parameter used to anchor the annotation horizontally

Returns:

an enum value from android.view.Gravity

setHorizontalAlignment

public void setHorizontalAlignment(int horizontalAlignment)

This method sets the alignment parameter to be used to anchor the annotation vertically

Parameters:

horizontalAlignment -