com.qozix.mapview

Class MapView

java.lang.Object

ViewGroup

com.qozix.layouts.ZoomPanLayout

com.qozix.mapview.MapView

public class MapView
extends ZoomPanLayout

The MapView widget is a subclass of ViewGroup that provides a mechanism to asynchronously display tile-based images, with additional functionality for 2D dragging, flinging, pinch or double-tap to zoom, adding overlaying Views (markers), multiple levels of detail, and support for faux-geolocation (by specifying top-left and bottom-right coordinates).

It might be best described as a hybrid of com.google.android.maps.MapView and iOS's CATiledLayer, and is appropriate for a variety of uses but was intended for map-type applications, especially high-detail or custom implementations (e.g., inside a building).

A minimal implementation might look like this:

MapView mapView = new MapView(this);
 mapView.addZoomLevel(3090, 2536, "path/to/tiles/%col%-%row%.jpg");
 

A more advanced implementation might look like this:

MapView mapView = new MapView(this);
 mapView.addMapEventListener(someMapEventListener);
 mapView.registerGeolocator(42.379676, -71.094919, 42.346550, -71.040280);
 mapView.addZoomLevel(6180, 5072, "tiles/boston-1000-%col%_%row%.jpg", 256, 256);
 mapView.addZoomLevel(3090, 2536, "tiles/boston-500-%col%_%row%.jpg", 256, 256);
 mapView.addZoomLevel(1540, 1268, "tiles/boston-250-%col%_%row%.jpg", 256, 256);
 mapView.addZoomLevel(770, 634, "tiles/boston-125-%col%_%row%.jpg", 128, 128);
 mapView.addMarker(someView, 42.35848, -71.063736);
 mapView.addMarker(anotherView, 42.3665, -71.05224);
 

Licensed under Creative Commons

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MapView.MapEventListener Interface for implementations to recieve MapView events.
static class	MapView.MapEventListenerImplementation Convenience class that implements

Nested classes/interfaces inherited from class com.qozix.layouts.ZoomPanLayout

ZoomPanLayout.GestureListener, ZoomPanLayout.ZoomPanListener

Constructor Summary

Constructors

Constructor and Description
MapView(Context context) Constructor to use when creating a MapView from code.

Method Summary

Methods

Modifier and Type	Method and Description
View	addCallout(View view, double x, double y) Add a callout to the the MapView.
View	addCallout(View view, double x, double y, boolean absolute) Add a callout to the the MapView.
View	addCallout(View view, double x, double y, float aX, float aY) Add a callout to the the MapView.
View	addCallout(View view, double x, double y, float aX, float aY, boolean absolute) Add a callout to the the MapView.
void	addChild(View view) Adds a View to the intermediary ViewGroup that manages layout for the ZoomPanLayout.
void	addHotSpot(Rect rectangle, View.OnClickListener listener) Register a rectangle that should fire an OnClickListener when a touch event occurs that intersects that rectangle.
void	addMapEventListener(MapView.MapEventListener listener) Register a map event listener callback object for this MapView.
View	addMarker(View view, double x, double y) Add a marker to the the MapView.
View	addMarker(View view, double x, double y, boolean absolute) Add a marker to the the MapView.
View	addMarker(View view, double x, double y, float aX, float aY) Add a marker to the the MapView.
View	addMarker(View view, double x, double y, float aX, float aY, boolean absolute) Add a marker to the the MapView.
View	addMarkerAtZoom(View view, double x, double y, float aX, float aY, int zoom) Add a marker to the the MapView.
View	addMarkerAtZoom(View view, double x, double y, float aX, float aY, int zoom, boolean absolute) Add a marker to the the MapView.
View	addMarkerAtZoom(View view, double x, double y, int zoom) Add a marker to the the MapView.
View	addMarkerAtZoom(View view, double x, double y, int zoom, boolean absolute) Add a marker to the the MapView.
void	addZoomLevel(int wide, int tall, java.lang.String pattern) Register a tile set to be used for a particular zoom level.
void	addZoomLevel(int wide, int tall, java.lang.String pattern, int tileWidth, int tileHeight) Register a tile set to be used for a particular zoom level.
void	addZoomLevel(int wide, int tall, java.lang.String pattern, java.lang.String downsample) Register a tile set to be used for a particular zoom level.
void	addZoomLevel(int wide, int tall, java.lang.String pattern, java.lang.String downsample, int tileWidth, int tileHeight) Register a tile set to be used for a particular zoom level.
void	cancelRender() Notify the map view that it may stop rendering tiles.
void	clear() Clear bitmap tiles, appropriate for onPause.
void	destroy() Clear bitmap tiles and remove all views, appropriate for onDestroy References to MapView should be set to null following invocations of this method.
View	drawPath(double[]... positions) Draw a path (line) on the MapView that will be rendered beneath any Marker or Callout views.
View	drawPath(java.util.List<double[]> positions) Draw a path (line) on the MapView that will be rendered beneath any Marker or Callout views.
View	drawPathAtZoom(int zoom, double[]... positions) Draw a path (line) on the MapView that will be rendered beneath any Marker or Callout views.
View	drawPathAtZoom(int zoom, java.util.List<double[]> positions) Draw a path (line) on the MapView that will be rendered beneath any Marker or Callout views.
int	getZoom() Get the current zoom level (index) used by the MapView
double[]	latLngToPixels(double[] coordinates) Converts coordinates values to pixels using the geolocation rectangle provided by @link #registerGeolocator(double, double, double, double)
double[]	latLngToPixels(double lat, double lng) Converts coordinates values to pixels using the geolocation rectangle provided by @link #registerGeolocator(double, double, double, double)
void	lockZoom() While zoom is locked (after this method is invoked, and before unlockZoom is invoked), the ZoomLevel will not change, and the current ZoomLevel will be scaled beyond the normal bounds.
void	moveTo(double x, double y) Scroll the MapView to the x and y positions provided.
void	moveTo(double x, double y, boolean absolute) Scroll the MapView to the x and y positions provided.
void	moveToAndCenter(double x, double y) Scroll the MapView to the x and y positions provided and center to the screen.
void	moveToAndCenter(double x, double y, boolean absolute) Scroll the MapView to the x and y positions provided and center to the screen.
double[]	pixelsToLatLng(double[] points) Converts pixels values to coordinates using the geolocation rectangle provided by @link #registerGeolocator(double, double, double, double)
double[]	pixelsToLatLng(double x, double y) Converts pixels values to coordinates using the geolocation rectangle provided by @link #registerGeolocator(double, double, double, double)
void	registerGeolocator(double left, double top, double right, double bottom) Register a set of offset points to use when calculating position within the MapView.
boolean	removeCallout(View view) Removes a callout View from the MapView's view tree.
void	removeHotSpot(Rect rectangle, View.OnClickListener listener) Remove a hotspot registered with addHotSpot
void	removeMapEventListener(MapView.MapEventListener listener) Removes a MapEventListener object from those listening to this MapView.
boolean	removeMarker(View view) Removes a marker View from the MapView's view tree.
boolean	removePath(View view) Removes a path View from the MapView's view tree.
void	requestRender() Request that the current tile set is re-examined and re-drawn.
void	resetZoomLevels() Clear all previously registered zoom levels.
void	setCacheEnabled(boolean shouldCache) Enables or disables map-tile image caching (in-memory and on-disk)
void	setMarkerAnchorPoints(float anchorX, float anchorY) Markers added to this MapView will have anchor logic applied on the values provided here.
void	setTileDecoder(MapTileDecoder decoder) Sets a custom class to perform the decode operation when tile bitmaps are requested.
void	setZoom(int zoom) Changes the zoom level used by the MapView.
void	slideTo(double x, double y) Scroll the MapView to the x and y positions provided, using scrolling animation.
void	slideTo(double x, double y, boolean absolute) Scroll the MapView to the x and y positions provided, using scrolling animation.
void	slideToAndCenter(double x, double y) Scroll the MapView to the x and y positions provide and center to the screen, using scrolling animation.
void	slideToAndCenter(double x, double y, boolean absolute) Scroll the MapView to the x and y positions provide and center to the screen, using scrolling animation.
void	unlockZoom() Unlocks a ZoomLevel locked with lockZoom
void	unregisterGeolocator() Removes the geolocation rectangle from this MapView's registry.

Methods inherited from class com.qozix.layouts.ZoomPanLayout

addGestureListener, addView, addZoomPanListener, computeScroll, getBaseHeight, getBaseWidth, getScale, getScaledHeight, getScaledWidth, isFlinging, onInterceptTouchEvent, onTouchEvent, removeChild, removeGestureListener, removeView, removeZoomPanListener, scrollToAndCenter, scrollToPoint, setScale, setScaleLimits, setScaleToFit, setShouldIntercept, setSize, slideToAndCenter, slideToPoint, smoothScaleTo

Methods inherited from class java.lang.Object

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

Constructor Detail

MapView

public MapView(Context context)

Constructor to use when creating a MapView from code. Inflating from XML is not currently supported.

Parameters:

context - (Context) The Context the MapView is running in, through which it can access the current theme, resources, etc.

Method Detail

getZoom

public int getZoom()

Get the current zoom level (index) used by the MapView

Returns:

(int) current zoom level used by the MapView

setZoom

public void setZoom(int zoom)

Changes the zoom level used by the MapView. The value is an index and represent the range 0 to n, where n = the total number of zoom levels added

Parameters:

zoom - (int) zoom index to use

addMapEventListener

public void addMapEventListener(MapView.MapEventListener listener)

Register a map event listener callback object for this MapView.

Parameters:

listener - (MapEventListener) an implementation of the MapEventListener interface

removeMapEventListener

public void removeMapEventListener(MapView.MapEventListener listener)

Removes a MapEventListener object from those listening to this MapView.

Parameters:

listener - (MapEventListener) an implementation of the MapEventListener interface

requestRender

public void requestRender()

Request that the current tile set is re-examined and re-drawn. The request is added to a queue and is not guaranteed to be processed at any particular time, and will never be handled immediately.

cancelRender

public void cancelRender()

Notify the map view that it may stop rendering tiles. The rendering thread will be attempt to be interrupted, but no guarantee is provided when.

setCacheEnabled

public void setCacheEnabled(boolean shouldCache)

Enables or disables map-tile image caching (in-memory and on-disk)

Parameters:

shouldCache - (boolean) true to enable caching, false to disable it (default)

setTileDecoder

public void setTileDecoder(MapTileDecoder decoder)

Sets a custom class to perform the decode operation when tile bitmaps are requested. By default, a MapTileDecoder implementation is provided that renders bitmaps from the context's Assets, but alternative implementations could be used that fetch images via HTTP, or from the SD card, or resources, SVG, etc. MapTileDecoderHttp is an example of such an implementation.

Parameters:

decoder - (MapTileDecoder) A class instance that implements MapTileDecoder, and must define a decode method, which accepts a String file name and a Context object, and returns a Bitmap

addZoomLevel

public void addZoomLevel(int wide,
                int tall,
                java.lang.String pattern)

Register a tile set to be used for a particular zoom level. Each tile set to be used must be registered using this method, and at least one zoom level must be registered for the MapView to render any tiles. Zoom levels will be ordered from smallest to largest, based on the area (width * height)

Parameters:

wide - (int) total width of the tile set

tall - (int) total height of the tile set

pattern - (String) string path to the location of the map tiles (in the assets directory), with %col% and %row% to be replaced by their respective integer positions. E.g., "folder/tile-%col%-%row%.jpg"

addZoomLevel

public void addZoomLevel(int wide,
                int tall,
                java.lang.String pattern,
                java.lang.String downsample)

Register a tile set to be used for a particular zoom level. Each tile set to be used must be registered using this method, and at least one zoom level must be registered for the MapView to render any tiles. Zoom levels will be ordered from smallest to largest, based on the area (width * height)

Parameters:

wide - (int) total width of the tile set

tall - (int) total height of the tile set

pattern - (String) string path to the location of the map tiles (in the assets directory), with %col% and %row% to be replaced by their respective integer positions. E.g., "folder/tile-%col%-%row%.jpg"

downsample - (String) string path to the location of an optional non-tiled image to serve as the background for a ZoomLevel. It's recommended that this image is low-res and small in size.

addZoomLevel

public void addZoomLevel(int wide,
                int tall,
                java.lang.String pattern,
                int tileWidth,
                int tileHeight)

Register a tile set to be used for a particular zoom level. Each tile set to be used must be registered using this method, and at least one zoom level must be registered for the MapView to render any tiles. Zoom levels will be ordered from smallest to largest, based on the area (width * height)

Parameters:

wide - (int) total width of the tile set

tall - (int) total height of the tile set

pattern - (String) string path to the location of the map tiles (in the assets directory), with %col% and %row% to be replaced by their respective integer positions. E.g., "folder/tile-%col%-%row%.jpg"

tileWidth - (int) size of each tiled column

tileHeight - (int) size of each tiled row

addZoomLevel

public void addZoomLevel(int wide,
                int tall,
                java.lang.String pattern,
                java.lang.String downsample,
                int tileWidth,
                int tileHeight)

Register a tile set to be used for a particular zoom level. Each tile set to be used must be registered using this method, and at least one zoom level must be registered for the MapView to render any tiles. Zoom levels will be ordered from smallest to largest, based on the area (width * height)

Parameters:

wide - (int) total width of the tile set

tall - (int) total height of the tile set

pattern - (String) string path to the location of the map tiles (in the assets directory), with %col% and %row% to be replaced by their respective integer positions. E.g., "folder/tile-%col%-%row%.jpg"

downsample - (String) string path to the location of an optional non-tiled image to serve as the background for a ZoomLevel. It's recommended that this image is low-res and small in size.

tileWidth - (int) size of each tiled column

tileHeight - (int) size of each tiled row

resetZoomLevels

public void resetZoomLevels()

Clear all previously registered zoom levels. This method is experimental.

lockZoom

public void lockZoom()

While zoom is locked (after this method is invoked, and before unlockZoom is invoked), the ZoomLevel will not change, and the current ZoomLevel will be scaled beyond the normal bounds. Normally, once a ZoomLevel reach 0.5 or lower scale, the manager searches for the next smallest ZoomLevel and activates it, changing the tiles set et al. While zoom is locked, this does not occur

unlockZoom

public void unlockZoom()

Unlocks a ZoomLevel locked with lockZoom

registerGeolocator

public void registerGeolocator(double left,
                      double top,
                      double right,
                      double bottom)

Register a set of offset points to use when calculating position within the MapView. This can be used for lat/lng coordinates instead of pixel-based positioning. If a geolocation rectangle is specified, many positioning methods will be able to translate coordinates into relative pixel values. To remove this process, use unregisterGeolocator

Parameters:

left - (double) the left edge of the rectangle used when calculating position (longitude of the bottom-right coordinate)

top - (double) the top edge of the rectangle used when calculating position (latitude of the top-left coordinate)

right - (double) the right edge of the rectangle used when calculating position (longitude of the top-left coordinate)

bottom - (double) the bottom edge of the rectangle used when calculating position (latitude of the bottom-right coordinate)

unregisterGeolocator

public void unregisterGeolocator()

Removes the geolocation rectangle from this MapView's registry. Positioning methods will use pixels values.

pixelsToLatLng

public double[] pixelsToLatLng(double x,
                      double y)

Converts pixels values to coordinates using the geolocation rectangle provided by @link #registerGeolocator(double, double, double, double)

Parameters:

x - (double) pixel value of the x-axis to be translated

y - (double) pixel value of the y-axis to be translated

Returns:

(double[]) a 2-element array of coordinates, with latitude at position 0 and longitude at position 1

Throws:

java.lang.UnsupportedOperationException - if no geolocation rectangle has been previously registered.

pixelsToLatLng

public double[] pixelsToLatLng(double[] points)

Converts pixels values to coordinates using the geolocation rectangle provided by @link #registerGeolocator(double, double, double, double)

Parameters:

points - (double[]) 2-element array of pixel values. The x-value should be at position 0, and the y-value at position 1

Returns:

(double[]) a 2-element array of coordinates, with latitude at position 0 and longitude at position 1

Throws:

java.lang.UnsupportedOperationException - if no geolocation rectangle has been previously registered.

latLngToPixels

public double[] latLngToPixels(double lat,
                      double lng)

Converts coordinates values to pixels using the geolocation rectangle provided by @link #registerGeolocator(double, double, double, double)

Parameters:

lat - (double) latitude of the value to be translated to y-axis pixel

lng - (double) longitude of the value to be translated to x-axis pixel

Returns:

(double[]) a 2-element array of pixel positions, with x at position 0 and y at position 1

Throws:

java.lang.UnsupportedOperationException - if no geolocation rectangle has been previously registered.

latLngToPixels

public double[] latLngToPixels(double[] coordinates)

Converts coordinates values to pixels using the geolocation rectangle provided by @link #registerGeolocator(double, double, double, double)

Parameters:

points - (double[]) 2-element array of pixel values. Latitude should be at position 0, and longitude at position 1

Returns:

(double[]) a 2-element array of pixel positions, with x at position 0 and y at position 1

Throws:

java.lang.UnsupportedOperationException - if no geolocation rectangle has been previously registered.

moveTo

public void moveTo(double x,
          double y)

Scroll the MapView to the x and y positions provided. This signature will use pixel values if no geolocator is registered, otherwise it will compute the coordinates based on the rectangle provided to the geolocation registration. Equivalent to moveTo( x, y, false)

Parameters:

x - (double) x position the MapView should focus to

y - (double) y position the MapView should focus to

moveTo

public void moveTo(double x,
          double y,
          boolean absolute)

Scroll the MapView to the x and y positions provided. This signature will use pixel values if no geolocator is registered or if @param absolute is false, otherwise it will compute the coordinates based on the rectangle provided to the geolocation registration.

Parameters:

x - (double) x position the MapView should focus to

y - (double) y position the MapView should focus to

absolute - (boolean) true to always use pixel values and omit geolocation translation

moveToAndCenter

public void moveToAndCenter(double x,
                   double y)

Scroll the MapView to the x and y positions provided and center to the screen. This signature will use pixel values if no geolocator is registered, otherwise it will compute the coordinates based on the rectangle provided to the geolocation registration. Equivalent to moveToAndCenter( x, y, false)

Parameters:

x - (double) x position the MapView should focus to

y - (double) y position the MapView should focus to

moveToAndCenter

public void moveToAndCenter(double x,
                   double y,
                   boolean absolute)

Scroll the MapView to the x and y positions provided and center to the screen. This signature will use pixel values if no geolocator is registered or if @param absolute is false, otherwise it will compute the coordinates based on the rectangle provided to the geolocation registration.

Parameters:

x - (double) x position the MapView should focus to

y - (double) y position the MapView should focus to

absolute - (boolean) true to always use pixel values and omit geolocation translation

slideTo

public void slideTo(double x,
           double y)

Scroll the MapView to the x and y positions provided, using scrolling animation. This signature will use pixel values if no geolocator is registered, otherwise it will compute the coordinates based on the rectangle provided to the geolocation registration. Equivalent to slideTo( x, y, false)

Parameters:

x - (double) x position the MapView should focus to

y - (double) y position the MapView should focus to

slideTo

public void slideTo(double x,
           double y,
           boolean absolute)

Scroll the MapView to the x and y positions provided, using scrolling animation. This signature will use pixel values if no geolocator is registered or if @param absolute is false, otherwise it will compute the coordinates based on the rectangle provided to the geolocation registration.

Parameters:

x - (double) x position the MapView should focus to

y - (double) y position the MapView should focus to

absolute - (boolean) true to always use pixel values and omit geolocation translation

slideToAndCenter

public void slideToAndCenter(double x,
                    double y)

Scroll the MapView to the x and y positions provide and center to the screen, using scrolling animation. This signature will use pixel values if no geolocator is registered otherwise it will compute the coordinates based on the rectangle provided to the geolocation registration.

Parameters:

x - (double) x position the MapView should focus to

y - (double) y position the MapView should focus to

slideToAndCenter

public void slideToAndCenter(double x,
                    double y,
                    boolean absolute)

Scroll the MapView to the x and y positions provide and center to the screen, using scrolling animation. This signature will use pixel values if no geolocator is registered or if @param absolute is false, otherwise it will compute the coordinates based on the rectangle provided to the geolocation registration.

Parameters:

x - (double) x position the MapView should focus to

y - (double) y position the MapView should focus to

absolute - (boolean) true to always use pixel values and omit geolocation translation

setMarkerAnchorPoints

public void setMarkerAnchorPoints(float anchorX,
                         float anchorY)

Markers added to this MapView will have anchor logic applied on the values provided here. E.g., setMarkerAnchorPoints(0.5f, 1.0f) will have markers centered horizontally, positioned vertically to a value equal to 0 - height. Note that individual markers can be assigned specific anchors - this method applies a default value to all markers added without specifying anchor values.

Parameters:

anchorX - (float) the x-axis position of a marker will be offset by a number equal to the negative width of the marker multiplied by this value

anchorY - (float) the y-axis position of a marker will be offset by a number equal to the negative height of the marker multiplied by this value

addMarker

public View addMarker(View view,
             double x,
             double y)

Add a marker to the the MapView. The marker can be any View. No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters

Parameters:

view - (View) View instance to be added to the MapView

x - (double) x position the View instance should be positioned at

y - (double) y position the View instance should be positioned at

Returns:

(View) the View instance added to the MapView

addMarker

public View addMarker(View view,
             double x,
             double y,
             boolean absolute)

Add a marker to the the MapView. The marker can be any View. No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters

Parameters:

view - (View) View instance to be added to the MapView

x - (double) x position the View instance should be positioned at

y - (double) y position the View instance should be positioned at

absolute - (boolean) true to always use pixel values and omit geolocation translation

Returns:

(View) the View instance added to the MapView

addMarker

public View addMarker(View view,
             double x,
             double y,
             float aX,
             float aY)

Add a marker to the the MapView. The marker can be any View. No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters

Parameters:

view - (View) View instance to be added to the MapView

x - (double) x position the View instance should be positioned at

y - (double) y position the View instance should be positioned at

aX - (float) the x-axis position of a marker will be offset by a number equal to the negative width of the marker multiplied by this value

aY - (float) the y-axis position of a marker will be offset by a number equal to the negative height of the marker multiplied by this value

Returns:

(View) the View instance added to the MapView

addMarker

public View addMarker(View view,
             double x,
             double y,
             float aX,
             float aY,
             boolean absolute)

Add a marker to the the MapView. The marker can be any View. No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters

Parameters:

view - (View) View instance to be added to the MapView

x - (double) x position the View instance should be positioned at

y - (double) y position the View instance should be positioned at

aX - (float) the x-axis position of a marker will be offset by a number equal to the negative width of the marker multiplied by this value

aY - (float) the y-axis position of a marker will be offset by a number equal to the negative height of the marker multiplied by this value

absolute - (boolean) true to always use pixel values and omit geolocation translation

Returns:

(View) the View instance added to the MapView

addMarkerAtZoom

public View addMarkerAtZoom(View view,
                   double x,
                   double y,
                   int zoom)

Add a marker to the the MapView. The marker can be any View. No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters This signature requires an additional parameter that represents the zoom level (int) that this marker should be shown at. At any other zoom level, the marker View will have it's visibility set to View.NONE

Parameters:

view - (View) View instance to be added to the MapView

x - (double) x position the View instance should be positioned at

y - (double) y position the View instance should be positioned at

zoom - (int) the zoom level (index) that this view should be shown at

Returns:

(View) the View instance added to the MapView

addMarkerAtZoom

public View addMarkerAtZoom(View view,
                   double x,
                   double y,
                   int zoom,
                   boolean absolute)

Add a marker to the the MapView. The marker can be any View. No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters This signature requires an additional parameter that represents the zoom level (int) that this marker should be shown at. At any other zoom level, the marker View will have it's visibility set to View.NONE

Parameters:

view - (View) View instance to be added to the MapView

x - (double) x position the View instance should be positioned at

y - (double) y position the View instance should be positioned at

zoom - (int) the zoom level (index) that this view should be shown at

absolute - (boolean) true to always use pixel values and omit geolocation translation

Returns:

(View) the View instance added to the MapView

addMarkerAtZoom

public View addMarkerAtZoom(View view,
                   double x,
                   double y,
                   float aX,
                   float aY,
                   int zoom)

Add a marker to the the MapView. The marker can be any View. No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters This signature requires an additional parameter that represents the zoom level (int) that this marker should be shown at. At any other zoom level, the marker View will have it's visibility set to View.NONE

Parameters:

view - (View) View instance to be added to the MapView

x - (double) x position the View instance should be positioned at

y - (double) y position the View instance should be positioned at

aX - (float) the x-axis position of a marker will be offset by a number equal to the negative width of the marker multiplied by this value

aY - (float) the y-axis position of a marker will be offset by a number equal to the negative height of the marker multiplied by this value

zoom - (int) the zoom level (index) that this view should be shown at

Returns:

(View) the View instance added to the MapView

addMarkerAtZoom

public View addMarkerAtZoom(View view,
                   double x,
                   double y,
                   float aX,
                   float aY,
                   int zoom,
                   boolean absolute)

Add a marker to the the MapView. The marker can be any View. No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters This signature requires an additional parameter that represents the zoom level (int) that this marker should be shown at. At any other zoom level, the marker View will have it's visibility set to View.NONE

Parameters:

view - (View) View instance to be added to the MapView

x - (double) x position the View instance should be positioned at

y - (double) y position the View instance should be positioned at

aX - (float) the x-axis position of a marker will be offset by a number equal to the negative width of the marker multiplied by this value

aY - (float) the y-axis position of a marker will be offset by a number equal to the negative height of the marker multiplied by this value

zoom - (int) the zoom level (index) that this view should be shown at

absolute - (boolean) true to always use pixel values and omit geolocation translation

Returns:

(View) the View instance added to the MapView

removeMarker

public boolean removeMarker(View view)

Removes a marker View from the MapView's view tree.

Parameters:

view - The marker View to be removed.

Returns:

(boolean) true if the view was in the view tree and was removed, false if it was not in the view tree

addCallout

public View addCallout(View view,
              double x,
              double y)

Add a callout to the the MapView. The callout can be any View. No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters Callout views will always be positioned at the top of the view tree (at the highest z-index), and will always be removed during any touch event that is not consumed by the callout View.

Parameters:

view - (View) View instance to be added to the MapView

x - (double) x position the View instance should be positioned at

y - (double) y position the View instance should be positioned at

Returns:

(View) the View instance added to the MapView

addCallout

public View addCallout(View view,
              double x,
              double y,
              boolean absolute)

Add a callout to the the MapView. The callout can be any View. No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters Callout views will always be positioned at the top of the view tree (at the highest z-index), and will always be removed during any touch event that is not consumed by the callout View.

Parameters:

view - (View) View instance to be added to the MapView

x - (double) x position the View instance should be positioned at

y - (double) y position the View instance should be positioned at

absolute - (boolean) true to always use pixel values and omit geolocation translation

Returns:

(View) the View instance added to the MapView

addCallout

public View addCallout(View view,
              double x,
              double y,
              float aX,
              float aY)

Add a callout to the the MapView. The callout can be any View. No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters Callout views will always be positioned at the top of the view tree (at the highest z-index), and will always be removed during any touch event that is not consumed by the callout View.

Parameters:

view - (View) View instance to be added to the MapView

x - (double) x position the View instance should be positioned at

y - (double) y position the View instance should be positioned at

aX - (float) the x-axis position of a callout view will be offset by a number equal to the negative width of the callout view multiplied by this value

aY - (float) the y-axis position of a callout view will be offset by a number equal to the negative height of the callout view multiplied by this value

Returns:

(View) the View instance added to the MapView

addCallout

public View addCallout(View view,
              double x,
              double y,
              float aX,
              float aY,
              boolean absolute)

Add a callout to the the MapView. The callout can be any View. No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters Callout views will always be positioned at the top of the view tree (at the highest z-index), and will always be removed during any touch event that is not consumed by the callout View.

Parameters:

view - (View) View instance to be added to the MapView

x - (double) x position the View instance should be positioned at

y - (double) y position the View instance should be positioned at

aX - (float) the x-axis position of a callout view will be offset by a number equal to the negative width of the callout view multiplied by this value

aY - (float) the y-axis position of a callout view will be offset by a number equal to the negative height of the callout view multiplied by this value

absolute - (boolean) true to always use pixel values and omit geolocation translation

Returns:

(View) the View instance added to the MapView

removeCallout

public boolean removeCallout(View view)

Removes a callout View from the MapView's view tree.

Parameters:

view - The callout View to be removed.

Returns:

(boolean) true if the view was in the view tree and was removed, false if it was not in the view tree

addHotSpot

public void addHotSpot(Rect rectangle,
              View.OnClickListener listener)

Register a rectangle that should fire an OnClickListener when a touch event occurs that intersects that rectangle. The rectangle moves and scales with the map view. Note that while the second parameter takes a View.OnClickListener instance, the View instance passed to the OnClick method will be null, since the HotSpot is not an actual View but an abstract representation of one.

Parameters:

rectangle - (Rect) the rectangle that is tested against touch events that occur on the MapView

listener - (View.OnClickListener) the OnClickListener instance that is fired if the rectangle intersects a touch event

removeHotSpot

public void removeHotSpot(Rect rectangle,
                 View.OnClickListener listener)

Remove a hotspot registered with addHotSpot

Parameters:

rectangle - (Rect) the rectangle to test for

listener - (View.OnClickListener) the listener that was registered to this hotspot

drawPath

public View drawPath(java.util.List<double[]> positions)

Draw a path (line) on the MapView that will be rendered beneath any Marker or Callout views.

Parameters:

positions - (List) List of 2-element double arrays. Each element represents a position; each position represents a point.

Returns:

(View) the PathView instance that represents the line drawn. The PathView instance has methods that allow manipulation of the path width, color, shadow, and corner effect, but is not documented at this time.

drawPath

public View drawPath(double[]... positions)

Draw a path (line) on the MapView that will be rendered beneath any Marker or Callout views.

Parameters:

positions - (double[]...) array (or var-args) of 2-element double arrays. Each element or argument represents a position; each position represents a point.

Returns:

(View) the PathView instance that represents the line drawn. The PathView instance has methods that allow manipulation of the path width, color, shadow, and corner effect, but is not documented at this time.

drawPathAtZoom

public View drawPathAtZoom(int zoom,
                  java.util.List<double[]> positions)

Draw a path (line) on the MapView that will be rendered beneath any Marker or Callout views. This signature requires an additional parameter that represents the zoom level (int) that this path should be shown at. At any other zoom level, the path will not be displayed.

Parameters:

zoom - (int) the zoom level (index) that this view should be shown at

positions - (List) List of 2-element double arrays. Each element represents a position; each position represents a point.

Returns:

(View) the PathView instance that represents the line drawn. The PathView instance has methods that allow manipulation of the path width, color, shadow, and corner effect, but is not documented at this time.

drawPathAtZoom

public View drawPathAtZoom(int zoom,
                  double[]... positions)

Draw a path (line) on the MapView that will be rendered beneath any Marker or Callout views. This signature requires an additional parameter that represents the zoom level (int) that this path should be shown at. At any other zoom level, the path will not be displayed.

Parameters:

zoom - (int) the zoom level (index) that this view should be shown at

positions - (double[]...) array (or var-args) of 2-element double arrays. Each element or argument represents a position; each position represents a point.

Returns:

(View) the PathView instance that represents the line drawn. The PathView instance has methods that allow manipulation of the path width, color, shadow, and corner effect, but is not documented at this time.

removePath

public boolean removePath(View view)

Removes a path View from the MapView's view tree.

Parameters:

view - The path View to be removed.

Returns:

(boolean) true if the view was in the view tree and was removed, false if it was not in the view tree

clear

public void clear()

Clear bitmap tiles, appropriate for onPause. (Currently not clearing downsample - might be worthwhile)

destroy

public void destroy()

Clear bitmap tiles and remove all views, appropriate for onDestroy References to MapView should be set to null following invocations of this method.

addChild

public void addChild(View view)

Description copied from class: ZoomPanLayout

Adds a View to the intermediary ViewGroup that manages layout for the ZoomPanLayout. This View will be laid out at the width and height specified by at 0, 0

Overrides:

addChild in class ZoomPanLayout

Parameters:

view - (View) The View to be added to the ZoomPanLayout view tree

Throws:

java.lang.UnsupportedOperationException - MapView does not allow direct insertion of child views.