com.google.appinventor.components.runtime

Class LocationSensor

java.lang.Object

com.google.appinventor.components.runtime.AndroidNonvisibleComponent

com.google.appinventor.components.runtime.LocationSensor

All Implemented Interfaces:

Component, Deleteable, OnResumeListener, OnStopListener

public class LocationSensor
extends AndroidNonvisibleComponent
implements Component, OnStopListener, OnResumeListener, Deleteable

Sensor that can provide information on longitude, latitude, and altitude.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNKNOWN_VALUE Constant returned by Longitude(), Latitude(), and Altitude() if no value could be obtained for them.

Fields inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

form

Fields inherited from interface com.google.appinventor.components.runtime.Component

ACCELEROMETER_SENSITIVITY_MODERATE, ACCELEROMETER_SENSITIVITY_STRONG, ACCELEROMETER_SENSITIVITY_WEAK, ALIGNMENT_CENTER, ALIGNMENT_NORMAL, ALIGNMENT_OPPOSITE, ASSET_DIRECTORY, BUTTON_SHAPE_DEFAULT, BUTTON_SHAPE_OVAL, BUTTON_SHAPE_RECT, BUTTON_SHAPE_ROUNDED, COLOR_BLACK, COLOR_BLUE, COLOR_CYAN, COLOR_DEFAULT, COLOR_DKGRAY, COLOR_GRAY, COLOR_GREEN, COLOR_LTGRAY, COLOR_MAGENTA, COLOR_NONE, COLOR_ORANGE, COLOR_PINK, COLOR_RED, COLOR_WHITE, COLOR_YELLOW, DEFAULT_VALUE_COLOR_BLACK, DEFAULT_VALUE_COLOR_BLUE, DEFAULT_VALUE_COLOR_CYAN, DEFAULT_VALUE_COLOR_DEFAULT, DEFAULT_VALUE_COLOR_DKGRAY, DEFAULT_VALUE_COLOR_GRAY, DEFAULT_VALUE_COLOR_GREEN, DEFAULT_VALUE_COLOR_LTGRAY, DEFAULT_VALUE_COLOR_MAGENTA, DEFAULT_VALUE_COLOR_NONE, DEFAULT_VALUE_COLOR_ORANGE, DEFAULT_VALUE_COLOR_PINK, DEFAULT_VALUE_COLOR_RED, DEFAULT_VALUE_COLOR_WHITE, DEFAULT_VALUE_COLOR_YELLOW, DIRECTION_EAST, DIRECTION_MAX, DIRECTION_MIN, DIRECTION_NONE, DIRECTION_NORTH, DIRECTION_NORTHEAST, DIRECTION_NORTHWEST, DIRECTION_SOUTH, DIRECTION_SOUTHEAST, DIRECTION_SOUTHWEST, DIRECTION_WEST, FONT_DEFAULT_SIZE, LAYOUT_ORIENTATION_HORIZONTAL, LAYOUT_ORIENTATION_VERTICAL, LENGTH_FILL_PARENT, LENGTH_PREFERRED, LENGTH_UNKNOWN, SLIDER_MAX_VALUE, SLIDER_MIN_VALUE, SLIDER_THUMB_VALUE, TOAST_LENGTH_LONG, TOAST_LENGTH_SHORT, TYPEFACE_DEFAULT, TYPEFACE_MONOSPACE, TYPEFACE_SANSSERIF, TYPEFACE_SERIF

Constructor Summary

Constructors

Constructor and Description
LocationSensor(ComponentContainer container) Creates a new LocationSensor component.

Method Summary

Methods

Modifier and Type	Method and Description
double	Accuracy() The most recent measure of accuracy, in meters.
double	Altitude() The most recently available altitude value, in meters.
java.util.List<java.lang.String>	AvailableProviders()
java.lang.String	CurrentAddress() Provides a textual representation of the current address or "No address available".
int	DistanceInterval()
void	DistanceInterval(int interval)
boolean	Enabled() Indicates whether the user has specified that the sensor should listen for location changes and raise the corresponding events.
void	Enabled(boolean enabled) Indicates whether the sensor should listen for location chagnes and raise the corresponding events.
boolean	HasAccuracy() Indicates whether information about location accuracy is available.
boolean	HasAltitude() Indicates whether altitude information is available.
boolean	HasLongitudeLatitude() Indicates whether longitude and latitude information is available.
double	Latitude() The most recently available latitude value.
double	LatitudeFromAddress(java.lang.String locationName) Derives Latitude from Address
void	LocationChanged(double latitude, double longitude, double altitude) Indicates that a new location has been detected.
double	Longitude() The most recent available longitude value.
double	LongitudeFromAddress(java.lang.String locationName) Derives Longitude from Address
void	onDelete()
void	onResume()
void	onStop()
boolean	ProviderLocked()
void	ProviderLocked(boolean lock) Indicates whether the sensor should allow the developer to manually change the provider (GPS, GSM, Wifi, etc.) from which location updates are received.
java.lang.String	ProviderName() Indicates the source of the location information.
void	ProviderName(java.lang.String providerName) Change the location provider.
void	RefreshProvider() Refresh provider attempts to choose and start the best provider unless someone has set and locked the provider.
void	StatusChanged(java.lang.String provider, java.lang.String status) Indicates that the status of the location provider service has changed, such as when a provider is lost or a new provider starts being used.
int	TimeInterval()
void	TimeInterval(int interval)

Methods inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

getDispatchDelegate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.appinventor.components.runtime.Component

getDispatchDelegate

Field Detail

UNKNOWN_VALUE

public static final int UNKNOWN_VALUE

Constant returned by Longitude(), Latitude(), and Altitude() if no value could be obtained for them. The client can find this out directly by calling HasLongitudeLatitude() or HasAltitude().

See Also:

Constant Field Values

Constructor Detail

LocationSensor

public LocationSensor(ComponentContainer container)

Creates a new LocationSensor component.

Parameters:

container - ignored (because this is a non-visible component)

Method Detail

LocationChanged

public void LocationChanged(double latitude,
                   double longitude,
                   double altitude)

Indicates that a new location has been detected.

StatusChanged

public void StatusChanged(java.lang.String provider,
                 java.lang.String status)

Indicates that the status of the location provider service has changed, such as when a provider is lost or a new provider starts being used.

ProviderName

public java.lang.String ProviderName()

Indicates the source of the location information. If there is no provider, the string "NO PROVIDER" is returned. This is useful primarily for debugging.

ProviderName

public void ProviderName(java.lang.String providerName)

Change the location provider. If the blocks program changes the name, try to change the provider. Whatever happens now, the provider and the reported name may be switched to Android's preferred provider later. This is primarily for debugging.

ProviderLocked

public boolean ProviderLocked()

ProviderLocked

public void ProviderLocked(boolean lock)

Indicates whether the sensor should allow the developer to manually change the provider (GPS, GSM, Wifi, etc.) from which location updates are received.

TimeInterval

public void TimeInterval(int interval)

TimeInterval

public int TimeInterval()

DistanceInterval

public void DistanceInterval(int interval)

DistanceInterval

public int DistanceInterval()

HasLongitudeLatitude

public boolean HasLongitudeLatitude()

Indicates whether longitude and latitude information is available. (It is always the case that either both or neither are.)

HasAltitude

public boolean HasAltitude()

Indicates whether altitude information is available.

HasAccuracy

public boolean HasAccuracy()

Indicates whether information about location accuracy is available.

Longitude

public double Longitude()

The most recent available longitude value. If no value is available, 0 will be returned.

Latitude

public double Latitude()

The most recently available latitude value. If no value is available, 0 will be returned.

Altitude

public double Altitude()

The most recently available altitude value, in meters. If no value is available, 0 will be returned.

Accuracy

public double Accuracy()

The most recent measure of accuracy, in meters. If no value is available, 0 will be returned.

Enabled

public boolean Enabled()

Indicates whether the user has specified that the sensor should listen for location changes and raise the corresponding events.

Enabled

public void Enabled(boolean enabled)

Indicates whether the sensor should listen for location chagnes and raise the corresponding events.

CurrentAddress

public java.lang.String CurrentAddress()

Provides a textual representation of the current address or "No address available".

LatitudeFromAddress

public double LatitudeFromAddress(java.lang.String locationName)

Derives Latitude from Address

Parameters:

locationName - human-readable address

Returns:

latitude in degrees, 0 if not found.

LongitudeFromAddress

public double LongitudeFromAddress(java.lang.String locationName)

Derives Longitude from Address

Parameters:

locationName - human-readable address

Returns:

longitude in degrees, 0 if not found.

AvailableProviders

public java.util.List<java.lang.String> AvailableProviders()

RefreshProvider

public void RefreshProvider()

Refresh provider attempts to choose and start the best provider unless someone has set and locked the provider. Currently, blocks programmers cannot do that because the relevant methods are not declared as properties.

onResume

public void onResume()

Specified by:

onResume in interface OnResumeListener

onStop

public void onStop()

Specified by:

onStop in interface OnStopListener

onDelete

public void onDelete()

Specified by:

onDelete in interface Deleteable