com.tomtom.pnd.maplib

Class ImageOverlayBuilder

java.lang.Object

com.tomtom.pnd.maplib.ImageOverlayBuilder

public class ImageOverlayBuilder
extends java.lang.Object

Builder class for ImageOverlay objects.

Since:

6 (16.1 Fermi)

Constructor Summary

Constructors

Constructor and Description
ImageOverlayBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
ImageOverlayBuilder	alpha(int alpha) Specifies the transparency of the overlay.
ImageOverlay	build() Combines all the properties that have been set and returns a new ImageOverlay object.
int	getAlpha()
GeoPoint	getNorthWest()
int	getResourceId()
GeoPoint	getSouthEast()
int	getZIndex()
ImageOverlayBuilder	image(android.content.Context context, int resourceId) Specifies the image to show in the overlay.
boolean	isSelectable()
boolean	isVisible()
ImageOverlayBuilder	nw(double latitude, double longitude) Sets the North-West anchor point of the overlay being built.
ImageOverlayBuilder	nw(GeoPoint nw) Sets the North-West anchor point of the overlay being built.
ImageOverlayBuilder	nw(GeoPoint nw, GeoPoint se) Adds both anchor points to the overlay being built.
ImageOverlayBuilder	nw(android.location.Location nw) Sets the North-West anchor point of the overlay being built.
ImageOverlayBuilder	nwse(double nwLatitude, double nwLongitude, double seLatitude, double seLongitude) Adds both anchor points to the overlay being built.
ImageOverlayBuilder	nwse(android.location.Location nw, android.location.Location se) Adds both anchor points to the overlay being built.
ImageOverlayBuilder	se(double latitude, double longitude) Sets the South-East anchor point of the overlay being built.
ImageOverlayBuilder	se(GeoPoint se) Sets the South-East anchor point of the overlay being built.
ImageOverlayBuilder	se(android.location.Location se) Sets the South-East anchor point of the overlay being built.
ImageOverlayBuilder	selectable(boolean isSelectable) Specifies the selectability for the overlay.
ImageOverlayBuilder	visibility(boolean isVisible) Specifies the visibility for the overlay.
ImageOverlayBuilder	zIndex(int zIndex) Specifies the zIndex of the overlay.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageOverlayBuilder

public ImageOverlayBuilder()

Method Detail

nw

public ImageOverlayBuilder nw(android.location.Location nw)

Sets the North-West anchor point of the overlay being built.

Parameters:

nw - The North-West anchor location.

Returns:

this ImageOverlayBuilder object with the given point at the end.

se

public ImageOverlayBuilder se(android.location.Location se)

Sets the South-East anchor point of the overlay being built.

Parameters:

se - The South-East anchor location.

Returns:

this ImageOverlayBuilder object with the given point at the end.

nwse

public ImageOverlayBuilder nwse(android.location.Location nw,
                       android.location.Location se)

Adds both anchor points to the overlay being built.

Parameters:

nw - The North-West anchor location.

se - The South-East anchor location.

Returns:

this ImageOverlayBuilder object with the given points at the end.

nw

public ImageOverlayBuilder nw(double latitude,
                     double longitude)

Sets the North-West anchor point of the overlay being built.

Parameters:

latitude - Latitude, in degrees.

longitude - Longitude, in degrees.

Returns:

this ImageOverlayBuilder object with the given point at the end.

se

public ImageOverlayBuilder se(double latitude,
                     double longitude)

Sets the South-East anchor point of the overlay being built.

Parameters:

latitude - Latitude, in degrees.

longitude - Longitude, in degrees.

Returns:

this ImageOverlayBuilder object with the given point at the end.

nwse

public ImageOverlayBuilder nwse(double nwLatitude,
                       double nwLongitude,
                       double seLatitude,
                       double seLongitude)

Adds both anchor points to the overlay being built.

Parameters:

nwLatitude - Latitude of the North-West anchor point, in degrees.

nwLongitude - Longitude of the North-West anchor point, in degrees.

seLatitude - Latitude of the South-East anchor point, in degrees.

seLongitude - Longitude of the South-East anchor point, in degrees.

Returns:

this ImageOverlayBuilder object with the given point at the end.

nw

public ImageOverlayBuilder nw(GeoPoint nw)

Sets the North-West anchor point of the overlay being built.

Parameters:

nw - The North-West anchor GeoPoint.

Returns:

this ImageOverlayBuilder object with the given point at the end.

se

public ImageOverlayBuilder se(GeoPoint se)

Sets the South-East anchor point of the overlay being built.

Parameters:

se - The South-East anchor GeoPoint.

Returns:

this ImageOverlayBuilder object with the given point at the end.

nw

public ImageOverlayBuilder nw(GeoPoint nw,
                     GeoPoint se)

Adds both anchor points to the overlay being built.

Parameters:

nw - The North-West anchor GeoPoint.

se - The South-East anchor GeoPoint.

Returns:

this ImageOverlayBuilder object with the given point at the end.

visibility

public ImageOverlayBuilder visibility(boolean isVisible)

Specifies the visibility for the overlay. It is visible by default.

Parameters:

isVisible - The visibility of overlay.

Returns:

this ImageOverlayBuilder object with the given visibility on the end.

selectable

public ImageOverlayBuilder selectable(boolean isSelectable)

Specifies the selectability for the overlay. It is visible by default.

Parameters:

isSelectable - The selectability of overlay.

Returns:

this ImageOverlayBuilder object with the given selectability on the end.

zIndex

public ImageOverlayBuilder zIndex(int zIndex)

Specifies the zIndex of the overlay. An overlay with higher zIndices are drawn above those with lower indices.

Parameters:

zIndex - the zIndex of the overlay.

Returns:

this ImageOverlayBuilder object with the given zIndex on the end.

image

public ImageOverlayBuilder image(android.content.Context context,
                        int resourceId)
                          throws java.lang.IllegalArgumentException

Specifies the image to show in the overlay.

Parameters:

context - a Context of the application.

resourceId - a Drawable's resource id.

Returns:

this ImageOverlayBuilder object with the given image on the end.

Throws:

java.lang.IllegalArgumentException - when context is null.

alpha

public ImageOverlayBuilder alpha(int alpha)

Specifies the transparency of the overlay.

Parameters:

alpha - The transparency value in the range [0, 255]. Values out of range will be clamped.

Returns:

this ImageOverlayBuilder object with the given alpha value on the end.

getNorthWest

public GeoPoint getNorthWest()

Returns:

the North-West anchor point of the overlay.

getSouthEast

public GeoPoint getSouthEast()

Returns:

the South-East anchor point of the overlay.

isVisible

public boolean isVisible()

Returns:

true if the overlay is to be visible; false if it is not.

isSelectable

public boolean isSelectable()

Returns:

true if the overlay is to be selectable; false if it is not.

getZIndex

public int getZIndex()

Returns:

the zIndex of the overlay.

getAlpha

public int getAlpha()

Returns:

the alpha value of the overlay.

build

public ImageOverlay build()

Combines all the properties that have been set and returns a new ImageOverlay object.

Returns:

a new ImageOverlay object.

getResourceId

public int getResourceId()

Returns:

the resource ID of the image.