edu.ucdavis.cstars.client.virtualearth

Class VEGeocoder

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.virtualearth.VEGeocoder

public class VEGeocoder
extends com.google.gwt.core.client.JavaScriptObject

Bing Maps geocoder.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VEGeocoder.Options Options object for VEGeocoder

Method Summary

Methods

Modifier and Type	Method and Description
void	addAddressToLocationsHandler(VEAddressToLocationsHandler handler) Add event handler to listen to onAddressToLocationsComplete.
void	addErrorHandler(ErrorHandler handler) Add event handler to listen to onError.
Deferred	addressToLocations(java.lang.String query) Sends a geocode request to Bing Maps to find candidates for a single address specified in the query argument.
Deferred	addressToLocations(java.lang.String query, VEAddressToLocationsCallback callback) Sends a geocode request to Bing Maps to find candidates for a single address specified in the query argument.
static boolean	assertLoaded() Check that the esri.virtualearth.VEGeocoder package has been loaded
static VEGeocoder	create(VEGeocoder.Options options) Creates a new VEGeocoder object.
java.lang.String	getCulture() Specifies the culture in which to return results.
void	setCulture(java.lang.String culture) Sets the culture in which to return results.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static VEGeocoder create(VEGeocoder.Options options)

Creates a new VEGeocoder object.

Parameters:

options -

Returns:

VEGeocoder

assertLoaded

public static boolean assertLoaded()

Check that the esri.virtualearth.VEGeocoder package has been loaded

Returns:

boolean

getCulture

public final java.lang.String getCulture()

Specifies the culture in which to return results. The default value is "en-US". For a list of supported cultures, see http://msdn.microsoft.com/en-us/library/cc981048.aspx.

Returns:

String

addressToLocations

public final Deferred addressToLocations(java.lang.String query,
                          VEAddressToLocationsCallback callback)

Sends a geocode request to Bing Maps to find candidates for a single address specified in the query argument.

Parameters:

query - - The address to locate.

callback - - The function to call when the method has completed.

Returns:

Deferred

addressToLocations

public final Deferred addressToLocations(java.lang.String query)

Sends a geocode request to Bing Maps to find candidates for a single address specified in the query argument.

Parameters:

query - - The address to locate.

Returns:

Deferred

setCulture

public final void setCulture(java.lang.String culture)

Sets the culture in which to return results.

Parameters:

culture - - The culture value. The default value is "en-US". For a list of supported cultures, see http://msdn.microsoft.com/en-us/library/cc981048.aspx.

addAddressToLocationsHandler

public final void addAddressToLocationsHandler(VEAddressToLocationsHandler handler)

Add event handler to listen to onAddressToLocationsComplete.

Parameters:

handler - - Fires when VEGeocode.addressToLocation() has completed.

addErrorHandler

public final void addErrorHandler(ErrorHandler handler)

Add event handler to listen to onError.

Parameters:

handler - - Fires when an error occurs when executing the task.