com.tomtom.navapp

Interface LocationManager

public interface LocationManager

NavApp LocationManager interface. For getting and displaying geographic locations.

Since:

1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LocationManager.DisplayLocationListener Listener to receive information about displaying a location.
static class	LocationManager.DisplayLocationResult Result codes for displaying locations on the map.

Method Summary

Modifier and Type	Method and Description
void	displayLocation(Routeable location, java.lang.String title, LocationManager.DisplayLocationListener listener) Display a geographic location on the map.
void	getCurrentLocation(Routeable.Listener listener) Get the current GPS location.
void	registerCurrentLocationListener(Routeable.Listener listener) Register a listener to receive updates of the current location.
void	unregisterCurrentLocationListener(Routeable.Listener listener) Unregister a listener to receive updates of the current location.

Method Detail

getCurrentLocation

void getCurrentLocation(Routeable.Listener listener)

Get the current GPS location. When there is no current known GPS location, the following fall-back is used:

• The current GPS location (if there is one and if it is on the active map).
• Last known GPS location (if present and on the active map).
• Home location (as set up by the user and if it is on the active map).
• Home country capital location (if present and on the active map.
• Center of the active map (Default map location).

The passed in listener is only active until the result of the call has been returned. Once a result has been returned the listener won't receive any more callbacks (but can be re-used).

Parameters:

listener - Routeable.Listener current location.

Throws:

java.lang.IllegalArgumentException - if the listener is null.

Since:

1

registerCurrentLocationListener

void registerCurrentLocationListener(Routeable.Listener listener)

Register a listener to receive updates of the current location. If the callback returns null it means that the current location could not be retrieved, otherwise the same fallback as in getCurrentLocation is used.

Parameters:

listener - Routeable.Listener to receive information about the current location.

Throws:

java.lang.IllegalArgumentException - if the listener is null.

Since:

1

unregisterCurrentLocationListener

void unregisterCurrentLocationListener(Routeable.Listener listener)

Unregister a listener to receive updates of the current location.

Parameters:

listener - The Routeable.Listener to unregister.

Throws:

java.lang.IllegalArgumentException - if the listener is null or previously not registered.

Since:

1

displayLocation

void displayLocation(Routeable location,
                     java.lang.String title,
                     LocationManager.DisplayLocationListener listener)

Display a geographic location on the map. The passed in listener is only active until the result of the call has been returned. Once a result has been returned the listener won't receive any more callbacks (but can be re-used).

Parameters:

location - The Routeable location to display.

title - Title to display on the display location screen.

listener - LocationManager.DisplayLocationListener to receive result of the calls.

Throws:

java.lang.IllegalArgumentException - if the listener is null.

Since:

1