com.visioglobe.VisioSample

Class VgMyLocationManager

java.lang.Object

com.visioglobe.VisioSample.VgMyLocationManager

All Implemented Interfaces:

VgMyLocationListener

public class VgMyLocationManager
extends java.lang.Object
implements VgMyLocationListener

This class provides access to the location services. These services allow applications to obtain periodic updates of the device's geographical location. You do not instantiate this class directly; instead, retrieve it via the VgMyLocationManager.getInstance() method.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VgMyLocationManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(java.lang.String pName, VgMyLocationListener pListener) Adds the listener to the location manager and associates it with the provider name.
void	addProvider(VgMyLocationProvider pProvider) Adds the provider to the location manager.
static VgMyLocationManager	getInstance() Use this method to retrieve the instance of the VgMyLocationManager class.
VgMyLocationProvider	getProvider(java.lang.String pName) Returns the information associated with the location provider of the given name, or null if no provider exists by that name.
java.util.Vector<java.lang.String>	getProviders(boolean pEnabledOnly) Returns a list of the names of all known location providers.
void	notifyAccuracyDidChange(java.lang.String pProvider, double pAccuracy) Called when the accuracy has changed.
void	notifyContextDidChange(java.lang.String pProvider, int pContext) Called when the context has changed
void	notifyFloorDidChange(java.lang.String pProvider, java.lang.String pFloor) Called when the floor has changed.
void	notifyHeadingDidChange(java.lang.String pProvider, double pHeading) Called when the heading has changed.
void	notifyLocationProviderDisabled(java.lang.String pProvider) Called when the provider is disabled
void	notifyLocationProviderEnabled(java.lang.String pProvider) Called when the provider is enabled
void	notifyPositionDidChange(java.lang.String pProvider, VgPosition pPosition) Called when the location has changed
void	removeListener(java.lang.String pName, VgMyLocationListener pListener) Removes the listener from the location manager
void	removeProvider(VgMyLocationProvider pProvider) Removes the provider from the location manager.

Methods inherited from class java.lang.Object

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

Constructor Detail

VgMyLocationManager

protected VgMyLocationManager()

Method Detail

getInstance

public static VgMyLocationManager getInstance()

Use this method to retrieve the instance of the VgMyLocationManager class. Do not try and create a new object via the constructor.

Returns:

The singleton instance of this class

getProvider

public VgMyLocationProvider getProvider(java.lang.String pName)

Returns the information associated with the location provider of the given name, or null if no provider exists by that name.

Parameters:

pName - The provider name

getProviders

public java.util.Vector<java.lang.String> getProviders(boolean pEnabledOnly)

Returns a list of the names of all known location providers.

Parameters:

pEnabledOnly - If true then only the providers which are currently enabled are returned. By default is false.

addProvider

public void addProvider(VgMyLocationProvider pProvider)

Adds the provider to the location manager. If there are already associated listeners for this provider, they will be notified of the providers current state via either notifyLocationProviderEnabled() or notifyLocationProviderDisabled().

Parameters:

pProvider - The provider

removeProvider

public void removeProvider(VgMyLocationProvider pProvider)

Removes the provider from the location manager. If the provider is enabled, then disable() will be called automatically. Listeners associated with the provider will remain registered.

Parameters:

pProvider - The provider

addListener

public void addListener(java.lang.String pName,
               VgMyLocationListener pListener)

Adds the listener to the location manager and associates it with the provider name. It's possible to associate a listener with a provider name that hasn't been added to the location manager.

Parameters:

pName - The name of the provider

pListener - The listener

removeListener

public void removeListener(java.lang.String pName,
                  VgMyLocationListener pListener)

Removes the listener from the location manager

Parameters:

pName - The name of the provider

pListener - The listener

notifyPositionDidChange

public void notifyPositionDidChange(java.lang.String pProvider,
                           VgPosition pPosition)

Description copied from interface: VgMyLocationListener

Called when the location has changed

Specified by:

notifyPositionDidChange in interface VgMyLocationListener

Parameters:

pProvider - The location provider responsible for sending the notification

pPosition - The new position

notifyFloorDidChange

public void notifyFloorDidChange(java.lang.String pProvider,
                        java.lang.String pFloor)

Description copied from interface: VgMyLocationListener

Called when the floor has changed.

Specified by:

notifyFloorDidChange in interface VgMyLocationListener

Parameters:

pProvider - The location provider responsible for sending the notification.

pFloor - The new floor

notifyAccuracyDidChange

public void notifyAccuracyDidChange(java.lang.String pProvider,
                           double pAccuracy)

Description copied from interface: VgMyLocationListener

Called when the accuracy has changed.

Specified by:

notifyAccuracyDidChange in interface VgMyLocationListener

Parameters:

pProvider - The location provider responsible for sending the notification.

pAccuracy - The new accuracy

notifyContextDidChange

public void notifyContextDidChange(java.lang.String pProvider,
                          int pContext)

Description copied from interface: VgMyLocationListener

Called when the context has changed

Specified by:

notifyContextDidChange in interface VgMyLocationListener

Parameters:

pProvider - The location provider responsible for sending the notification.

pContext - The new context

notifyHeadingDidChange

public void notifyHeadingDidChange(java.lang.String pProvider,
                          double pHeading)

Description copied from interface: VgMyLocationListener

Called when the heading has changed.

Specified by:

notifyHeadingDidChange in interface VgMyLocationListener

Parameters:

pProvider - The location provider responsible for sending the notification.

pHeading - The new heading

notifyLocationProviderEnabled

public void notifyLocationProviderEnabled(java.lang.String pProvider)

Description copied from interface: VgMyLocationListener

Called when the provider is enabled

Specified by:

notifyLocationProviderEnabled in interface VgMyLocationListener

Parameters:

pProvider - The location provider responsible for sending the notification.

notifyLocationProviderDisabled

public void notifyLocationProviderDisabled(java.lang.String pProvider)

Description copied from interface: VgMyLocationListener

Called when the provider is disabled

Specified by:

notifyLocationProviderDisabled in interface VgMyLocationListener

Parameters:

pProvider - The location provider responsible for sending the notification.