org.geomajas.plugin.geocoder.client.event
Class SelectLocationEvent

java.lang.Object
  com.google.web.bindery.event.shared.Event<H>
      com.google.gwt.event.shared.GwtEvent<SelectLocationHandler>
          org.geomajas.plugin.geocoder.client.event.SelectLocationEvent

@Api
public class SelectLocationEvent
extends GwtEvent<SelectLocationHandler>

Event which is used when a location was selected, This can occur either because the geocoder returned a match or because one of the alternatives was selected by the user.

Since:

1.0.0

Author:

Joachim Van der Auwera, Pieter De Graef

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent

GwtEvent.Type<H>

Constructor Summary

SelectLocationEvent(org.geomajas.gwt.client.map.MapPresenter mapPresenter, GetLocationForStringAlternative alternative)

SelectLocationEvent(org.geomajas.gwt.client.map.MapPresenter mapPresenter, GetLocationForStringResponse alternative)

Method Summary

GwtEvent.Type<SelectLocationHandler>	getAssociatedType()
org.geomajas.geometry.Bbox	getBbox() Get bounding box for the located area.
String	getCanonicalLocation() Get string preferred description of matched location.
org.geomajas.geometry.Coordinate	getCenter() Get center of the located area.
String	getGeocoderName() Name of the geocoder service which produced this result.
org.geomajas.gwt.client.map.MapPresenter	getMapWidget() Get map widget the geocoder applies to.
org.geomajas.configuration.client.ClientUserDataInfo	getUserData() Get extra user data for the geocoder search result.

Methods inherited from class com.google.gwt.event.shared.GwtEvent

getSource

Methods inherited from class com.google.web.bindery.event.shared.Event

toDebugString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SelectLocationEvent

public SelectLocationEvent(org.geomajas.gwt.client.map.MapPresenter mapPresenter,
                           GetLocationForStringAlternative alternative)

SelectLocationEvent

public SelectLocationEvent(org.geomajas.gwt.client.map.MapPresenter mapPresenter,
                           GetLocationForStringResponse alternative)

Method Detail

getAssociatedType

public GwtEvent.Type<SelectLocationHandler> getAssociatedType()

Overrides:

getAssociatedType in class GwtEvent<SelectLocationHandler>

getMapWidget

@Api
public org.geomajas.gwt.client.map.MapPresenter getMapWidget()

Get map widget the geocoder applies to.

Returns:

map widget

getCanonicalLocation

@Api
public String getCanonicalLocation()

Get string preferred description of matched location.

Returns:

preferred string for searching this location

getCenter

@Api
public org.geomajas.geometry.Coordinate getCenter()

Get center of the located area.

Returns:

center of area

getBbox

@Api
public org.geomajas.geometry.Bbox getBbox()

Get bounding box for the located area.

Returns:

located area

getGeocoderName

@Api
public String getGeocoderName()

Name of the geocoder service which produced this result.

This is filled in automatically by the command.

Returns:

name of the geocoder service which produced this result

getUserData

@Api
public org.geomajas.configuration.client.ClientUserDataInfo getUserData()

Get extra user data for the geocoder search result. Only set when there was only one results from the list of geocoder services.

Returns:

user data